CSCurrencyApiCurrency
in package
The CSCurrencyApiCurrency is the Object API to manage currencies
Tags
Table of Contents
- __construct() : mixed
- CSCurrencyApiCurrency constructor
- getLabel() : string
- Returns the label value
- getLanguageIds() : array<string|int, mixed>
- Returns the language ids, associated to the currency
- getName() : string
- Returns the name value. This field is the unique identifier of a record (for internal use)
- getPosition() : string
- Returns the position that the symbol should occupy while formatting the currency value
- getSymbol() : string
- Returns the symbol of the currency, meaning, the sign that identifies each currency
- setLabel() : void
- Sets the label value
- setLanguageIds() : void
- Sets the language ids
- setName() : void
- Sets the name value
- setPosition() : void
- Sets the symbol position (check constants defined in top of the class)
- setSymbol() : void
- Sets the symbol value
Methods
__construct()
CSCurrencyApiCurrency constructor
public
__construct(mixed $iCurrencyId[, string $sName = '' ][, string $sSymbol = '' ]) : mixed
Parameters
- $iCurrencyId : mixed
- $sName : string = ''
- $sSymbol : string = ''
Tags
Return values
mixed —getLabel()
Returns the label value
public
getLabel() : string
Tags
Return values
string —getLanguageIds()
Returns the language ids, associated to the currency
public
getLanguageIds() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getName()
Returns the name value. This field is the unique identifier of a record (for internal use)
public
getName() : string
Tags
Return values
string —getPosition()
Returns the position that the symbol should occupy while formatting the currency value
public
getPosition() : string
Tags
Return values
string —getSymbol()
Returns the symbol of the currency, meaning, the sign that identifies each currency
public
getSymbol() : string
Tags
Return values
string —setLabel()
Sets the label value
public
setLabel(mixed $sLabel) : void
Parameters
- $sLabel : mixed
Tags
Return values
void —setLanguageIds()
Sets the language ids
public
setLanguageIds(mixed $aLanguageIds) : void
Parameters
- $aLanguageIds : mixed
-
array The language ids to be set
Tags
Return values
void —setName()
Sets the name value
public
setName(mixed $sName) : void
Parameters
- $sName : mixed
-
string The name to be set
Tags
Return values
void —setPosition()
Sets the symbol position (check constants defined in top of the class)
public
setPosition(mixed $iPosition) : void
Parameters
- $iPosition : mixed
-
int The position to be set
Tags
Return values
void —setSymbol()
Sets the symbol value
public
setSymbol(mixed $sSymbol) : void
Parameters
- $sSymbol : mixed
-
string The symbol to be set