class Currency extends DataModel

Currency model properties.

Properties

protected array $fields from DataModel
protected boolean $isEncrypted from DataModel
protected Identity $id
protected string $delimiterCent
protected string $delimiterThousand
protected double $factor
protected boolean $hasCurrencySignBeforeValue
protected boolean $isDefault
protected string $iso
protected string $name
protected string $nameHtml

Methods

__construct()

Constructor

multitype:
getProperties()

Get the Model Properties

from Model
setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

from DataModel
stdClass
getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

from DataModel
toJson()

No description

from Model
mixed:string
getFields()

Fields Getter

from DataModel
validate()

Object Validation

from DataModel
mixed:string|NULL
getField(boolean $toWawi = false, string $key)

Get a Model Member Name

from DataModel
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

from DataModel
getModelType()

No description

from DataModel
boolean
isEncrypted()

Encrypted Status

from DataModel
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

No description

from DataModel
setProperty($name, $value, $type)

No description

from DataModel
validateType($value, $type)

No description

from DataModel
setId(Identity $id)

No description

getId()

No description

setDelimiterCent(string $delimiterCent)

No description

string
getDelimiterCent()

No description

setDelimiterThousand(string $delimiterThousand)

No description

string
getDelimiterThousand()

No description

setFactor(double $factor)

No description

double
getFactor()

No description

setHasCurrencySignBeforeValue(boolean $hasCurrencySignBeforeValue)

No description

boolean
setIsDefault(boolean $isDefault)

No description

boolean
getIsDefault()

No description

setIso(string $iso)

No description

string
getIso()

No description

setName(string $name)

No description

string
getName()

No description

setNameHtml(string $nameHtml)

No description

string
getNameHtml()

No description

Details

at line 99
__construct()

Constructor

in Model at line 33
multitype: getProperties()

Get the Model Properties

Return Value

multitype: string

in DataModel at line 172
Model setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

Parameters

stdClass $object
array $options

Return Value

Model

in DataModel at line 70
stdClass getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

Parameters

array $publics

Return Value

stdClass $object

in Model at line 115
toJson()

in DataModel at line 35
mixed:string getFields()

Fields Getter

Return Value

mixed:string

in DataModel at line 45
validate()

Object Validation

Exceptions

SchemaException

in DataModel at line 59
mixed:string|NULL getField(boolean $toWawi = false, string $key)

Get a Model Member Name

Parameters

boolean $toWawi
string $key

Return Value

mixed:string|NULL

in DataModel at line 81
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

Parameters

boolean $toWawi
stdClass $obj Object to map

in DataModel at line 42
DataType getModelType()

Return Value

DataType

in DataModel at line 59
boolean isEncrypted()

Encrypted Status

Return Value

boolean

in DataModel at line 123
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

Parameters

string $propertyName
string|null $endpoint
int|null $host

in DataModel at line 179
protected setProperty($name, $value, $type)

Parameters

$name
$value
$type

in DataModel at line 190
protected validateType($value, $type)

Parameters

$value
$type

at line 109
Currency setId(Identity $id)

Parameters

Identity $id Unique currency id

Return Value

Currency

Exceptions

InvalidArgumentException if the provided argument is not of type 'Identity'.

at line 117
Identity getId()

Return Value

Identity Unique currency id

at line 126
Currency setDelimiterCent(string $delimiterCent)

Parameters

string $delimiterCent Optional delimiter char for cent, default=",". Ignore this flag if you have the correct user locale preference.

Return Value

Currency

at line 134
string getDelimiterCent()

Return Value

string Optional delimiter char for cent, default=",". Ignore this flag if you have the correct user locale preference.

at line 143
Currency setDelimiterThousand(string $delimiterThousand)

Parameters

string $delimiterThousand Optional delimiter char for thousand. Default=".". Ignore this flag if you have the correct user locale preference.

Return Value

Currency

at line 151
string getDelimiterThousand()

Return Value

string Optional delimiter char for thousand. Default=".". Ignore this flag if you have the correct user locale preference.

at line 160
Currency setFactor(double $factor)

Parameters

double $factor Optional conversion factor to default currency. Default is 1 (equals default currency)

Return Value

Currency

at line 168
double getFactor()

Return Value

double Optional conversion factor to default currency. Default is 1 (equals default currency)

at line 177
Currency setHasCurrencySignBeforeValue(boolean $hasCurrencySignBeforeValue)

Parameters

boolean $hasCurrencySignBeforeValue Optional: Display currency before or after value. Ignore this flag if you have the correct user locale preference.

Return Value

Currency

at line 185
boolean getHasCurrencySignBeforeValue()

Return Value

boolean Optional: Display currency before or after value. Ignore this flag if you have the correct user locale preference.

at line 194
Currency setIsDefault(boolean $isDefault)

Parameters

boolean $isDefault Optional: Flag default currency. True, if this is the default currency. Exact one currency must be marked as default.

Return Value

Currency

at line 202
boolean getIsDefault()

Return Value

boolean Optional: Flag default currency. True, if this is the default currency. Exact one currency must be marked as default.

at line 211
Currency setIso(string $iso)

Parameters

string $iso

Return Value

Currency

at line 219
string getIso()

Return Value

string

at line 228
Currency setName(string $name)

Parameters

string $name Currency name

Return Value

Currency

at line 236
string getName()

Return Value

string Currency name

at line 245
Currency setNameHtml(string $nameHtml)

Parameters

string $nameHtml Optional HTML name e.g. "€"

Return Value

Currency

at line 253
string getNameHtml()

Return Value

string Optional HTML name e.g. "€"