DocumentRowOptionValue
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait
This is the document row option value class.
The document row option values will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $id | Autonumeric element id. | : int |
| __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 |
| getId() | Returns the element id. | : int |
| getNoReturn() | Returns the document row option value no return. | : bool |
| getOptionValueId() | Returns the document row option value internal identifier. | : int |
| getOptionValuePId() | Returns the document row option value public identifier. | : string |
| getPreviousPrice() | Returns the document row option value previous price. | : float |
| getPrice() | Returns the document row option value price. | : float |
| getValue() | Returns the value of the document row option value. | : string |
| getWeight() | Returns the document row option value weight. | : 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 |
Properties
$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.
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 —getId()
Returns the element id.
public
getId() : int
Return values
int —getNoReturn()
Returns the document row option value no return.
public
getNoReturn() : bool
Return values
bool —getOptionValueId()
Returns the document row option value internal identifier.
public
getOptionValueId() : int
Return values
int —getOptionValuePId()
Returns the document row option value public identifier.
public
getOptionValuePId() : string
Return values
string —getPreviousPrice()
Returns the document row option value previous price.
public
getPreviousPrice() : float
Return values
float —getPrice()
Returns the document row option value price.
public
getPrice() : float
Return values
float —getValue()
Returns the value of the document row option value.
public
getValue() : string
Return values
string —getWeight()
Returns the document row option value weight.
public
getWeight() : 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