RichDocumentCurrency
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the rich document currency class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $code | : string | |
|---|---|---|
| $codeNumber | : string | |
| $error | : Error|null | |
| $mode | : string | |
| $name | : string | |
| $symbol | : string | |
| $usdValue | : float | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getCode() | Returns the rich document currency code. | : string |
| getCodeNumber() | Returns the rich document currency codeNumber. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getMode() | Returns the rich document currency mode. | : string |
| getName() | Returns the rich document currency name. | : string |
| getSymbol() | Returns the rich document currency symbol. | : string |
| getUsdValue() | Returns the rich document currency usdValue. | : float |
| jsonSerialize() | Allow elements to be serialized. | : array<string|int, mixed> |
| toArray() | Used to allow elements to be serialized. | : array<string|int, mixed> |
| getFieldItem() | : object|null | |
| getFormattedData() | : mixed | |
| setArrayField() | Convert an API array of objects to a PHP array of objects. | : array<string|int, mixed> |
| setError() | : void |
Properties
$code
protected
string
$code
= ''
$codeNumber
protected
string
$codeNumber
= ''
$error
protected
Error|null
$error
= null
$mode
protected
string
$mode
= ''
$name
protected
string
$name
= ''
$symbol
protected
string
$symbol
= ''
$usdValue
protected
float
$usdValue
= 0.0
Methods
__construct()
Elements constructor.
public
__construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string|int, mixed> = []
-
Array that contains all the values to the object to initialize
Return values
mixed —__toString()
Uses "json_encode" function to return the JSON format of the element.
public
__toString() : string
Auto-invoked using echo or concatenations.
Return values
string —getCode()
Returns the rich document currency code.
public
getCode() : string
Return values
string —getCodeNumber()
Returns the rich document currency codeNumber.
public
getCodeNumber() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getMode()
Returns the rich document currency mode.
public
getMode() : string
Return values
string —getName()
Returns the rich document currency name.
public
getName() : string
Return values
string —getSymbol()
Returns the rich document currency symbol.
public
getSymbol() : string
Return values
string —getUsdValue()
Returns the rich document currency usdValue.
public
getUsdValue() : float
Return values
float —jsonSerialize()
Allow elements to be serialized.
public
jsonSerialize() : array<string|int, mixed>
Auto-invoked using "json_encode" function.
Return values
array<string|int, mixed> —toArray()
Used to allow elements to be serialized.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFieldItem()
protected
getFieldItem(array<string|int, mixed> $item, string $class) : object|null
Parameters
- $item : array<string|int, mixed>
- $class : string
Return values
object|null —getFormattedData()
protected
getFormattedData(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —setArrayField()
Convert an API array of objects to a PHP array of objects.
protected
setArrayField(array<string|int, mixed> $data, string $class) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
Array that contains all the values to the objects to initialize
- $class : string
-
The PHP class we want the objects to be
Return values
array<string|int, mixed> —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed