RichDocumentTax
extends Element
in package
Uses
ElementTrait
This is the rich document tax class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $base | : string | |
|---|---|---|
| $baseWithDiscounts | : string | |
| $discount | : string | |
| $error | : Error|null | |
| $modality | : string | |
| $name | : string | |
| $rePrice | : string | |
| $reRate | : float | |
| $taxPrice | : string | |
| $taxRate | : float | |
| $totalPrice | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getBase() | Returns the rich document tax base. | : string |
| getBaseWithDiscounts() | Returns the rich document tax baseWithDiscounts. | : string |
| getDiscount() | Returns the rich document tax discount. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getModality() | Returns the rich document tax modality. | : string |
| getName() | Returns the rich document tax name. | : string |
| getRePrice() | Returns the rich document tax rePrice. | : string |
| getReRate() | Returns the rich document tax reRate. | : float |
| getTaxPrice() | Returns the rich document tax taxPrice. | : string |
| getTaxRate() | Returns the rich document tax taxRate. | : float |
| getTotalPrice() | Returns the rich document tax totalPrice. | : 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 |
Properties
$base
protected
string
$base
= ''
$baseWithDiscounts
protected
string
$baseWithDiscounts
= ''
$discount
protected
string
$discount
= ''
$error
protected
Error|null
$error
= null
$modality
protected
string
$modality
= ''
$name
protected
string
$name
= ''
$rePrice
protected
string
$rePrice
= ''
$reRate
protected
float
$reRate
= 0.0
$taxPrice
protected
string
$taxPrice
= ''
$taxRate
protected
float
$taxRate
= 0.0
$totalPrice
protected
string
$totalPrice
= ''
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 —getBase()
Returns the rich document tax base.
public
getBase() : string
Return values
string —getBaseWithDiscounts()
Returns the rich document tax baseWithDiscounts.
public
getBaseWithDiscounts() : string
Return values
string —getDiscount()
Returns the rich document tax discount.
public
getDiscount() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getModality()
Returns the rich document tax modality.
public
getModality() : string
Return values
string —getName()
Returns the rich document tax name.
public
getName() : string
Return values
string —getRePrice()
Returns the rich document tax rePrice.
public
getRePrice() : string
Return values
string —getReRate()
Returns the rich document tax reRate.
public
getReRate() : float
Return values
float —getTaxPrice()
Returns the rich document tax taxPrice.
public
getTaxPrice() : string
Return values
string —getTaxRate()
Returns the rich document tax taxRate.
public
getTaxRate() : float
Return values
float —getTotalPrice()
Returns the rich document tax totalPrice.
public
getTotalPrice() : 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