BundleCombinationData
extends CombinationData
in package
Uses
ElementTrait, EnumResolverTrait
This is the BundleCombinationData class.
The bundle current data will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $prices | : Prices|null | |
| $pricesWithTaxes | : Prices|null | |
| __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 |
| getItems() | Returns the items of the option in the filter. | : array<string|int, BundleCombinationDataItem> |
| getPrices() | Returns the item prices object. | : Prices|null |
| getPricesWithTaxes() | Returns the item pricesWithTaxes object. | : Prices|null |
| getStatus() | Returns the status value. | : 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 | |
| setPricesWithTaxes() | : void |
Properties
$error
protected
Error|null
$error
= null
$prices
protected
Prices|null
$prices
= null
$pricesWithTaxes
protected
Prices|null
$pricesWithTaxes
= null
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 —getItems()
Returns the items of the option in the filter.
public
getItems() : array<string|int, BundleCombinationDataItem>
Return values
array<string|int, BundleCombinationDataItem> —getPrices()
Returns the item prices object.
public
getPrices() : Prices|null
Tags
Return values
Prices|null —getPricesWithTaxes()
Returns the item pricesWithTaxes object.
public
getPricesWithTaxes() : Prices|null
Tags
Return values
Prices|null —getStatus()
Returns the status value.
public
getStatus() : 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 —setPricesWithTaxes()
protected
setPricesWithTaxes(array<string|int, mixed> $pricesWithTaxes) : void
Parameters
- $pricesWithTaxes : array<string|int, mixed>