Documentation

ExchangeRate
in package
implements ArrayAccess, JsonSerializable, ModelInterface

ExchangeRate Class Doc Comment.

Tags
category

Class

author

OpenAPI Generator team

see
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ArrayAccess
JsonSerializable
ModelInterface
Interface abstracting model access.

Table of Contents

DISCRIMINATOR  = null
$attributeMap  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name.
$container  : array<string|int, mixed>
Associative array for storing property values.
$getters  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests).
$openAPIFormats  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization.
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string|int, mixed>
Array of nullable properties. Used for (de)serialization.
$openAPINullablesSetToNull  : array<string|int, mixed>
If a nullable field gets set to null, insert it here.
$openAPITypes  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization.
$setters  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses).
__construct()  : mixed
Constructor.
__toString()  : string
Gets the string presentation of the object.
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name.
getCountryFlagPath()  : null|string
Gets countryFlagPath.
getCurrencyFrom()  : string
Gets currencyFrom.
getCurrencyTo()  : string
Gets currencyTo.
getExchangeRateBuy()  : float
Gets exchangeRateBuy.
getExchangeRateBuyCash()  : float
Gets exchangeRateBuyCash.
getExchangeRateCenter()  : float
Gets exchangeRateCenter.
getExchangeRateCenterChange()  : float
Gets exchangeRateCenterChange.
getExchangeRateEcbRate()  : null|float
Gets exchangeRateEcbRate.
getExchangeRateEcbVariation()  : null|float
Gets exchangeRateEcbVariation.
getExchangeRateSell()  : float
Gets exchangeRateSell.
getExchangeRateSellCash()  : float
Gets exchangeRateSellCash.
getExchangeRateSellCenter()  : float
Gets exchangeRateSellCenter.
getExchangeRateSellCenterPrevious()  : float
Gets exchangeRateSellCenterPrevious.
getFixedCountryCode()  : null|string
Gets fixedCountryCode.
getFixedCountryName()  : null|string
Gets fixedCountryName.
getModelName()  : string
The original name of the model.
getQuotationType()  : string
Gets quotationType.
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests).
getUnitsFrom()  : int
Gets unitsFrom.
getVariableCountryCode()  : null|string
Gets variableCountryCode.
getVariableCountryName()  : null|string
Gets variableCountryName.
isNullable()  : bool
Checks if a property is nullable.
isNullableSetToNull()  : bool
Checks if a nullable property is set to null.
jsonSerialize()  : mixed
Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : null|mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
openAPIFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization.
openAPITypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization.
setCountryFlagPath()  : self
Sets countryFlagPath.
setCurrencyFrom()  : self
Sets currencyFrom.
setCurrencyTo()  : self
Sets currencyTo.
setExchangeRateBuy()  : self
Sets exchangeRateBuy.
setExchangeRateBuyCash()  : self
Sets exchangeRateBuyCash.
setExchangeRateCenter()  : self
Sets exchangeRateCenter.
setExchangeRateCenterChange()  : self
Sets exchangeRateCenterChange.
setExchangeRateEcbRate()  : self
Sets exchangeRateEcbRate.
setExchangeRateEcbVariation()  : self
Sets exchangeRateEcbVariation.
setExchangeRateSell()  : self
Sets exchangeRateSell.
setExchangeRateSellCash()  : self
Sets exchangeRateSellCash.
setExchangeRateSellCenter()  : self
Sets exchangeRateSellCenter.
setExchangeRateSellCenterPrevious()  : self
Sets exchangeRateSellCenterPrevious.
setFixedCountryCode()  : self
Sets fixedCountryCode.
setFixedCountryName()  : self
Sets fixedCountryName.
setQuotationType()  : self
Sets quotationType.
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses).
setUnitsFrom()  : self
Sets unitsFrom.
setVariableCountryCode()  : self
Sets variableCountryCode.
setVariableCountryName()  : self
Sets variableCountryName.
toHeaderValue()  : string
Gets a header-safe presentation of the object.
valid()  : bool
Validate all the properties in the model return true if all passed.
openAPINullables()  : array<string|int, mixed>
Array of nullable properties.
getOpenAPINullablesSetToNull()  : array<string|int, bool>
Array of nullable field names deliberately set to null.
setIfExists()  : void
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array.
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null.

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name.

protected static array<string|int, mixed> $attributeMap = ['countryFlagPath' => 'countryFlagPath', 'currencyFrom' => 'currencyFrom', 'currencyTo' => 'currencyTo', 'exchangeRateBuy' => 'exchangeRateBuy', 'exchangeRateBuyCash' => 'exchangeRateBuyCash', 'exchangeRateCenter' => 'exchangeRateCenter', 'exchangeRateCenterChange' => 'exchangeRateCenterChange', 'exchangeRateSell' => 'exchangeRateSell', 'exchangeRateSellCash' => 'exchangeRateSellCash', 'exchangeRateSellCenter' => 'exchangeRateSellCenter', 'exchangeRateSellCenterPrevious' => 'exchangeRateSellCenterPrevious', 'exchangeRateEcbRate' => 'exchangeRateEcbRate', 'exchangeRateEcbVariation' => 'exchangeRateEcbVariation', 'fixedCountryCode' => 'fixedCountryCode', 'fixedCountryName' => 'fixedCountryName', 'quotationType' => 'quotationType', 'unitsFrom' => 'unitsFrom', 'variableCountryCode' => 'variableCountryCode', 'variableCountryName' => 'variableCountryName']

$container

Associative array for storing property values.

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests).

protected static array<string|int, mixed> $getters = ['countryFlagPath' => 'getCountryFlagPath', 'currencyFrom' => 'getCurrencyFrom', 'currencyTo' => 'getCurrencyTo', 'exchangeRateBuy' => 'getExchangeRateBuy', 'exchangeRateBuyCash' => 'getExchangeRateBuyCash', 'exchangeRateCenter' => 'getExchangeRateCenter', 'exchangeRateCenterChange' => 'getExchangeRateCenterChange', 'exchangeRateSell' => 'getExchangeRateSell', 'exchangeRateSellCash' => 'getExchangeRateSellCash', 'exchangeRateSellCenter' => 'getExchangeRateSellCenter', 'exchangeRateSellCenterPrevious' => 'getExchangeRateSellCenterPrevious', 'exchangeRateEcbRate' => 'getExchangeRateEcbRate', 'exchangeRateEcbVariation' => 'getExchangeRateEcbVariation', 'fixedCountryCode' => 'getFixedCountryCode', 'fixedCountryName' => 'getFixedCountryName', 'quotationType' => 'getQuotationType', 'unitsFrom' => 'getUnitsFrom', 'variableCountryCode' => 'getVariableCountryCode', 'variableCountryName' => 'getVariableCountryName']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization.

protected static array<string|int, mixed> $openAPIFormats = ['countryFlagPath' => null, 'currencyFrom' => null, 'currencyTo' => null, 'exchangeRateBuy' => 'double', 'exchangeRateBuyCash' => 'double', 'exchangeRateCenter' => 'double', 'exchangeRateCenterChange' => 'double', 'exchangeRateSell' => 'double', 'exchangeRateSellCash' => 'double', 'exchangeRateSellCenter' => 'double', 'exchangeRateSellCenterPrevious' => 'double', 'exchangeRateEcbRate' => 'double', 'exchangeRateEcbVariation' => 'double', 'fixedCountryCode' => null, 'fixedCountryName' => null, 'quotationType' => null, 'unitsFrom' => 'int32', 'variableCountryCode' => null, 'variableCountryName' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'ExchangeRate'

$openAPINullables

Array of nullable properties. Used for (de)serialization.

protected static array<string|int, mixed> $openAPINullables = ['countryFlagPath' => false, 'currencyFrom' => false, 'currencyTo' => false, 'exchangeRateBuy' => false, 'exchangeRateBuyCash' => false, 'exchangeRateCenter' => false, 'exchangeRateCenterChange' => false, 'exchangeRateSell' => false, 'exchangeRateSellCash' => false, 'exchangeRateSellCenter' => false, 'exchangeRateSellCenterPrevious' => false, 'exchangeRateEcbRate' => false, 'exchangeRateEcbVariation' => false, 'fixedCountryCode' => false, 'fixedCountryName' => false, 'quotationType' => false, 'unitsFrom' => false, 'variableCountryCode' => false, 'variableCountryName' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here.

protected array<string|int, mixed> $openAPINullablesSetToNull = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization.

protected static array<string|int, mixed> $openAPITypes = ['countryFlagPath' => 'string', 'currencyFrom' => 'string', 'currencyTo' => 'string', 'exchangeRateBuy' => 'float', 'exchangeRateBuyCash' => 'float', 'exchangeRateCenter' => 'float', 'exchangeRateCenterChange' => 'float', 'exchangeRateSell' => 'float', 'exchangeRateSellCash' => 'float', 'exchangeRateSellCenter' => 'float', 'exchangeRateSellCenterPrevious' => 'float', 'exchangeRateEcbRate' => 'float', 'exchangeRateEcbVariation' => 'float', 'fixedCountryCode' => 'string', 'fixedCountryName' => 'string', 'quotationType' => 'string', 'unitsFrom' => 'int', 'variableCountryCode' => 'string', 'variableCountryName' => 'string']

$setters

Array of attributes to setter functions (for deserialization of responses).

protected static array<string|int, mixed> $setters = ['countryFlagPath' => 'setCountryFlagPath', 'currencyFrom' => 'setCurrencyFrom', 'currencyTo' => 'setCurrencyTo', 'exchangeRateBuy' => 'setExchangeRateBuy', 'exchangeRateBuyCash' => 'setExchangeRateBuyCash', 'exchangeRateCenter' => 'setExchangeRateCenter', 'exchangeRateCenterChange' => 'setExchangeRateCenterChange', 'exchangeRateSell' => 'setExchangeRateSell', 'exchangeRateSellCash' => 'setExchangeRateSellCash', 'exchangeRateSellCenter' => 'setExchangeRateSellCenter', 'exchangeRateSellCenterPrevious' => 'setExchangeRateSellCenterPrevious', 'exchangeRateEcbRate' => 'setExchangeRateEcbRate', 'exchangeRateEcbVariation' => 'setExchangeRateEcbVariation', 'fixedCountryCode' => 'setFixedCountryCode', 'fixedCountryName' => 'setFixedCountryName', 'quotationType' => 'setQuotationType', 'unitsFrom' => 'setUnitsFrom', 'variableCountryCode' => 'setVariableCountryCode', 'variableCountryName' => 'setVariableCountryName']

Methods

__construct()

Constructor.

public __construct([null|array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : null|array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed

__toString()

Gets the string presentation of the object.

public __toString() : string
Return values
string

attributeMap()

Array of attributes where the key is the local name, and the value is the original name.

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCountryFlagPath()

Gets countryFlagPath.

public getCountryFlagPath() : null|string
Return values
null|string

getCurrencyFrom()

Gets currencyFrom.

public getCurrencyFrom() : string
Return values
string

getCurrencyTo()

Gets currencyTo.

public getCurrencyTo() : string
Return values
string

getExchangeRateBuy()

Gets exchangeRateBuy.

public getExchangeRateBuy() : float
Return values
float

getExchangeRateBuyCash()

Gets exchangeRateBuyCash.

public getExchangeRateBuyCash() : float
Return values
float

getExchangeRateCenter()

Gets exchangeRateCenter.

public getExchangeRateCenter() : float
Return values
float

getExchangeRateCenterChange()

Gets exchangeRateCenterChange.

public getExchangeRateCenterChange() : float
Return values
float

getExchangeRateEcbRate()

Gets exchangeRateEcbRate.

public getExchangeRateEcbRate() : null|float
Return values
null|float

getExchangeRateEcbVariation()

Gets exchangeRateEcbVariation.

public getExchangeRateEcbVariation() : null|float
Return values
null|float

getExchangeRateSell()

Gets exchangeRateSell.

public getExchangeRateSell() : float
Return values
float

getExchangeRateSellCash()

Gets exchangeRateSellCash.

public getExchangeRateSellCash() : float
Return values
float

getExchangeRateSellCenter()

Gets exchangeRateSellCenter.

public getExchangeRateSellCenter() : float
Return values
float

getExchangeRateSellCenterPrevious()

Gets exchangeRateSellCenterPrevious.

public getExchangeRateSellCenterPrevious() : float
Return values
float

getFixedCountryCode()

Gets fixedCountryCode.

public getFixedCountryCode() : null|string
Return values
null|string

getFixedCountryName()

Gets fixedCountryName.

public getFixedCountryName() : null|string
Return values
null|string

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getQuotationType()

Gets quotationType.

public getQuotationType() : string
Return values
string

getters()

Array of attributes to getter functions (for serialization of requests).

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUnitsFrom()

Gets unitsFrom.

public getUnitsFrom() : int
Return values
int

getVariableCountryCode()

Gets variableCountryCode.

public getVariableCountryCode() : null|string
Return values
null|string

getVariableCountryName()

Gets variableCountryName.

public getVariableCountryName() : null|string
Return values
null|string

isNullable()

Checks if a property is nullable.

public static isNullable(string $property) : bool
Parameters
$property : string
Return values
bool

isNullableSetToNull()

Checks if a nullable property is set to null.

public isNullableSetToNull(string $property) : bool
Parameters
$property : string
Return values
bool

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int $offset) : null|mixed
Parameters
$offset : int

Offset

Return values
null|mixed

offsetSet()

Sets value based on offset.

public offsetSet(null|int $offset, mixed $value) : void
Parameters
$offset : null|int

Offset

$value : mixed

Value to be set

Return values
void

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void

openAPIFormats()

Array of property to format mappings. Used for (de)serialization.

public static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

openAPITypes()

Array of property to type mappings. Used for (de)serialization.

public static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

setCountryFlagPath()

Sets countryFlagPath.

public setCountryFlagPath(null|string $countryFlagPath) : self
Parameters
$countryFlagPath : null|string

countryFlagPath

Return values
self

setCurrencyFrom()

Sets currencyFrom.

public setCurrencyFrom(string $currencyFrom) : self
Parameters
$currencyFrom : string

currencyFrom

Return values
self

setCurrencyTo()

Sets currencyTo.

public setCurrencyTo(string $currencyTo) : self
Parameters
$currencyTo : string

currencyTo

Return values
self

setExchangeRateBuy()

Sets exchangeRateBuy.

public setExchangeRateBuy(float $exchangeRateBuy) : self
Parameters
$exchangeRateBuy : float

exchangeRateBuy

Return values
self

setExchangeRateBuyCash()

Sets exchangeRateBuyCash.

public setExchangeRateBuyCash(float $exchangeRateBuyCash) : self
Parameters
$exchangeRateBuyCash : float

exchangeRateBuyCash

Return values
self

setExchangeRateCenter()

Sets exchangeRateCenter.

public setExchangeRateCenter(float $exchangeRateCenter) : self
Parameters
$exchangeRateCenter : float

exchangeRateCenter

Return values
self

setExchangeRateCenterChange()

Sets exchangeRateCenterChange.

public setExchangeRateCenterChange(float $exchangeRateCenterChange) : self
Parameters
$exchangeRateCenterChange : float

exchangeRateCenterChange

Return values
self

setExchangeRateEcbRate()

Sets exchangeRateEcbRate.

public setExchangeRateEcbRate(null|float $exchangeRateEcbRate) : self
Parameters
$exchangeRateEcbRate : null|float

exchangeRateEcbRate

Return values
self

setExchangeRateEcbVariation()

Sets exchangeRateEcbVariation.

public setExchangeRateEcbVariation(null|float $exchangeRateEcbVariation) : self
Parameters
$exchangeRateEcbVariation : null|float

exchangeRateEcbVariation

Return values
self

setExchangeRateSell()

Sets exchangeRateSell.

public setExchangeRateSell(float $exchangeRateSell) : self
Parameters
$exchangeRateSell : float

exchangeRateSell

Return values
self

setExchangeRateSellCash()

Sets exchangeRateSellCash.

public setExchangeRateSellCash(float $exchangeRateSellCash) : self
Parameters
$exchangeRateSellCash : float

exchangeRateSellCash

Return values
self

setExchangeRateSellCenter()

Sets exchangeRateSellCenter.

public setExchangeRateSellCenter(float $exchangeRateSellCenter) : self
Parameters
$exchangeRateSellCenter : float

exchangeRateSellCenter

Return values
self

setExchangeRateSellCenterPrevious()

Sets exchangeRateSellCenterPrevious.

public setExchangeRateSellCenterPrevious(float $exchangeRateSellCenterPrevious) : self
Parameters
$exchangeRateSellCenterPrevious : float

exchangeRateSellCenterPrevious

Return values
self

setFixedCountryCode()

Sets fixedCountryCode.

public setFixedCountryCode(null|string $fixedCountryCode) : self
Parameters
$fixedCountryCode : null|string

fixedCountryCode

Return values
self

setFixedCountryName()

Sets fixedCountryName.

public setFixedCountryName(null|string $fixedCountryName) : self
Parameters
$fixedCountryName : null|string

fixedCountryName

Return values
self

setQuotationType()

Sets quotationType.

public setQuotationType(string $quotationType) : self
Parameters
$quotationType : string

quotationType

Return values
self

setters()

Array of attributes to setter functions (for deserialization of responses).

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>

setUnitsFrom()

Sets unitsFrom.

public setUnitsFrom(int $unitsFrom) : self
Parameters
$unitsFrom : int

unitsFrom

Return values
self

setVariableCountryCode()

Sets variableCountryCode.

public setVariableCountryCode(null|string $variableCountryCode) : self
Parameters
$variableCountryCode : null|string

variableCountryCode

Return values
self

setVariableCountryName()

Sets variableCountryName.

public setVariableCountryName(null|string $variableCountryName) : self
Parameters
$variableCountryName : null|string

variableCountryName

Return values
self

toHeaderValue()

Gets a header-safe presentation of the object.

public toHeaderValue() : string
Return values
string

valid()

Validate all the properties in the model return true if all passed.

public valid() : bool
Return values
bool

True if all properties are valid

openAPINullables()

Array of nullable properties.

protected static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null.

private getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool>

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array.

private setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed
Return values
void

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null.

private setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string|int, bool>
Return values
void

Search results