DocumentAdditionalItemTax
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait
This is the document additional information class.
The document additional item will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $applyRE | : bool | |
|---|---|---|
| $applyTax | : bool | |
| $base | : float | |
| $error | : Error|null | |
| $id | Autonumeric element id. | : int |
| $tax | : DocumentItemTax|null | |
| $taxValue | : float | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getApplyRE() | Returns the document additional item tax apply RE. | : bool |
| getApplyTax() | Returns the document additional item tax apply. | : bool |
| getBase() | Returns the document additional item tax base. | : float |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getTax() | Returns the document additional item tax documentItemTax. | : DocumentItemTax|null |
| getTaxValue() | Returns the document additional item tax value. | : 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 | |
| setTax() | : void |
Properties
$applyRE
protected
bool
$applyRE
= false
$applyTax
protected
bool
$applyTax
= false
$base
protected
float
$base
= 0.0
$error
protected
Error|null
$error
= null
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$tax
protected
DocumentItemTax|null
$tax
= null
$taxValue
protected
float
$taxValue
= 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 —getApplyRE()
Returns the document additional item tax apply RE.
public
getApplyRE() : bool
Return values
bool —getApplyTax()
Returns the document additional item tax apply.
public
getApplyTax() : bool
Return values
bool —getBase()
Returns the document additional item tax base.
public
getBase() : float
Return values
float —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getId()
Returns the element id.
public
getId() : int
Return values
int —getTax()
Returns the document additional item tax documentItemTax.
public
getTax() : DocumentItemTax|null
Return values
DocumentItemTax|null —getTaxValue()
Returns the document additional item tax value.
public
getTaxValue() : 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
Return values
void —setTax()
protected
setTax(array<string|int, mixed> $tax) : void
Parameters
- $tax : array<string|int, mixed>