Bundle
extends BasketRow
in package
Uses
ElementTrait
This is the basket item class.
The basket items information 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 |
| $items | : array<string|int, mixed> | |
| $name | : string | |
| $prices | : BasketRowPrices|null | |
| $pricesWithTaxes | : BasketRowPrices|null | |
| $quantity | : int | |
| $subtotal | : float | |
| $total | : float | |
| $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 basket item hash. | : string |
| getId() | Returns the element id. | : int |
| getItems() | Returns the basket items. | : array<string|int, BasketRow> |
| getName() | Returns the element name on the website current language. | : string |
| getPrices() | Returns the basket item prices. | : BasketRowPrices|null |
| getPricesWithTaxes() | Returns the basket item prices with taxes included. | : BasketRowPrices|null |
| getQuantity() | Returns the basket item quantity. | : int |
| getSubtotal() | Returns the basket item subtotal (total price without taxes). | : float |
| getTotal() | Returns the basket item total (total price with taxes). | : float |
| getType() | Returns the basket item 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 | |
| setItems() | : void | |
| setPrices() | : void | |
| setPricesWithTaxes() | : 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.
$items
protected
array<string|int, mixed>
$items
= []
$name
protected
string
$name
= ''
$prices
protected
BasketRowPrices|null
$prices
= null
$pricesWithTaxes
protected
BasketRowPrices|null
$pricesWithTaxes
= null
$quantity
protected
int
$quantity
= 0
$subtotal
protected
float
$subtotal
= 0.0
$total
protected
float
$total
= 0.0
$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 basket item hash.
public
getHash() : string
Return values
string —getId()
Returns the element id.
public
getId() : int
Return values
int —getItems()
Returns the basket items.
public
getItems() : array<string|int, BasketRow>
Return values
array<string|int, BasketRow> —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPrices()
Returns the basket item prices.
public
getPrices() : BasketRowPrices|null
Return values
BasketRowPrices|null —getPricesWithTaxes()
Returns the basket item prices with taxes included.
public
getPricesWithTaxes() : BasketRowPrices|null
Return values
BasketRowPrices|null —getQuantity()
Returns the basket item quantity.
public
getQuantity() : int
Return values
int —getSubtotal()
Returns the basket item subtotal (total price without taxes).
public
getSubtotal() : float
Return values
float —getTotal()
Returns the basket item total (total price with taxes).
public
getTotal() : float
Return values
float —getType()
Returns the basket item 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 —setItems()
protected
setItems(array<string|int, mixed> $items) : void
Parameters
- $items : array<string|int, 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>