RichDocumentElementTax
extends Element
in package
Uses
ElementTrait
This is the rich document element tax class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $applyRE | : bool | |
|---|---|---|
| $applyTax | : bool | |
| $base | : string | |
| $error | : Error|null | |
| $tax | : DocumentItemTax|null | |
| $taxValue | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getApplyRE() | Returns the rich document element tax applyRE. | : bool |
| getApplyTax() | Returns the rich document element tax applyTax. | : bool |
| getBase() | Returns the rich document element tax base. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getTax() | Returns the rich document element tax tax. | : DocumentItemTax|null |
| getTaxValue() | Returns the rich document element tax taxValue. | : 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 | |
| setTax() | : void |
Properties
$applyRE
protected
bool
$applyRE
= false
$applyTax
protected
bool
$applyTax
= false
$base
protected
string
$base
= ''
$error
protected
Error|null
$error
= null
$tax
protected
DocumentItemTax|null
$tax
= null
$taxValue
protected
string
$taxValue
= ''
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 —getApplyRE()
Returns the rich document element tax applyRE.
public
getApplyRE() : bool
Return values
bool —getApplyTax()
Returns the rich document element tax applyTax.
public
getApplyTax() : bool
Return values
bool —getBase()
Returns the rich document element tax base.
public
getBase() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getTax()
Returns the rich document element tax tax.
public
getTax() : DocumentItemTax|null
Return values
DocumentItemTax|null —getTaxValue()
Returns the rich document element tax taxValue.
public
getTaxValue() : 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 —setTax()
protected
setTax(array<string|int, mixed> $tax) : void
Parameters
- $tax : array<string|int, mixed>