DocumentRow
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, ElementNameTrait, EnumResolverTrait
This is the document row class.
The document rows will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $hash | : string | |
| $id | Autonumeric element id. | : int |
| $itemId | : int | |
| $name | : string | |
| $onRequestAffected | : bool | |
| $prices | : DocumentRowPrices|null | |
| $quantity | : int | |
| $reserve | : bool | |
| $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 |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getHash() | Returns the document row hash. | : string |
| getId() | Returns the element id. | : int |
| getItemId() | Returns the document row product internal identifier. | : int |
| getName() | Returns the element name on the website current language. | : string |
| getOnRequestAffected() | Returns the document row on request affected. | : bool |
| getPrices() | Returns the document row prices. | : DocumentRowPrices|null |
| getQuantity() | Returns the document row quantity. | : int |
| getReserve() | Returns the document row reserve. | : bool |
| getTaxes() | Returns the document row taxes. | : array<string|int, DocumentRowTax> |
| getType() | Returns the document row 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 | |
| setPrices() | : void | |
| setTaxes() | : void |
Properties
$error
protected
Error|null
$error
= null
$hash
protected
string
$hash
= ''
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$itemId
protected
int
$itemId
= 0
$name
protected
string
$name
= ''
$onRequestAffected
protected
bool
$onRequestAffected
= false
$prices
protected
DocumentRowPrices|null
$prices
= null
$quantity
protected
int
$quantity
= 0
$reserve
protected
bool
$reserve
= false
$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 —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getHash()
Returns the document row hash.
public
getHash() : string
Return values
string —getId()
Returns the element id.
public
getId() : int
Return values
int —getItemId()
Returns the document row product internal identifier.
public
getItemId() : int
Return values
int —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getOnRequestAffected()
Returns the document row on request affected.
public
getOnRequestAffected() : bool
Return values
bool —getPrices()
Returns the document row prices.
public
getPrices() : DocumentRowPrices|null
Return values
DocumentRowPrices|null —getQuantity()
Returns the document row quantity.
public
getQuantity() : int
Return values
int —getReserve()
Returns the document row reserve.
public
getReserve() : bool
Return values
bool —getTaxes()
Returns the document row taxes.
public
getTaxes() : array<string|int, DocumentRowTax>
Return values
array<string|int, DocumentRowTax> —getType()
Returns the document row 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 —setPrices()
protected
setPrices(array<string|int, mixed> $prices) : void
Parameters
- $prices : array<string|int, mixed>
Return values
void —setTaxes()
protected
setTaxes(array<string|int, mixed> $taxes) : void
Parameters
- $taxes : array<string|int, mixed>