DocumentRowOption
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, ElementNameTrait, EnumResolverTrait
This is the document row option class.
The document row options 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 |
| $name | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getCombinable() | Returns if the document row option was combinable. | : bool |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getName() | Returns the element name on the website current language. | : string |
| getOptionId() | Returns the document row option internal identifier. | : int |
| getOptionPId() | Returns the document row option public identifier. | : string |
| getPreviousPrice() | Returns the document row option previous price. | : float |
| getPrice() | Returns the document row option price. | : float |
| getPrompt() | Returns the document row option prompt. | : string |
| getSku() | Returns the document row option sku. | : string |
| getUniquePrice() | Returns the document row option unique price. | : bool |
| getValue() | Returns the document row option value. | : string |
| getValues() | Returns the document row option values. | : array<string|int, DocumentRowOptionValue> |
| getValueType() | Returns the document row option value type. | : string |
| getWeight() | Returns the document row option 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.
$name
protected
string
$name
= ''
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 —getCombinable()
Returns if the document row option was combinable.
public
getCombinable() : bool
Return values
bool —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 —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getOptionId()
Returns the document row option internal identifier.
public
getOptionId() : int
Return values
int —getOptionPId()
Returns the document row option public identifier.
public
getOptionPId() : string
Return values
string —getPreviousPrice()
Returns the document row option previous price.
public
getPreviousPrice() : float
Return values
float —getPrice()
Returns the document row option price.
public
getPrice() : float
Return values
float —getPrompt()
Returns the document row option prompt.
public
getPrompt() : string
Return values
string —getSku()
Returns the document row option sku.
public
getSku() : string
Return values
string —getUniquePrice()
Returns the document row option unique price.
public
getUniquePrice() : bool
Return values
bool —getValue()
Returns the document row option value.
public
getValue() : string
Return values
string —getValues()
Returns the document row option values.
public
getValues() : array<string|int, DocumentRowOptionValue>
Return values
array<string|int, DocumentRowOptionValue> —getValueType()
Returns the document row option value type.
public
getValueType() : string
Return values
string —getWeight()
Returns the document row option 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