RichDocumentAdditionalItem
extends Element
in package
Uses
ElementTrait
This is the rich document additional item class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
$amount | : string | |
---|---|---|
$error | : Error|null | |
$name | : string | |
$taxes | : array<string|int, mixed> | |
$type | : string | |
__construct() | Elements constructor. | : mixed |
__toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
getAmount() | Returns the rich document additional item amount. | : string |
getError() | Returns the current element error (if there is error). | : Error|null |
getName() | Returns the rich document additional item name. | : string |
getTaxes() | Returns the rich document additional item taxes. | : array<string|int, RichDocumentElementTax> |
getType() | Returns the rich document additional item type. | : string |
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 | |
setTaxes() | : void |
Properties
$amount
protected
string
$amount
= ''
$error
protected
Error|null
$error
= null
$name
protected
string
$name
= ''
$taxes
protected
array<string|int, mixed>
$taxes
= []
$type
protected
string
$type
= ''
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 —getAmount()
Returns the rich document additional item amount.
public
getAmount() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getName()
Returns the rich document additional item name.
public
getName() : string
Return values
string —getTaxes()
Returns the rich document additional item taxes.
public
getTaxes() : array<string|int, RichDocumentElementTax>
Return values
array<string|int, RichDocumentElementTax> —getType()
Returns the rich document additional item type.
public
getType() : string
Return values
string —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
Return values
void —setTaxes()
protected
setTaxes(array<string|int, mixed> $taxes) : void
Parameters
- $taxes : array<string|int, mixed>