BasketRow
extends Element
in package
Uses
IdentifiableElementTrait, ElementNameTrait, EnumResolverTrait
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 |
| $name | : string | |
| $prices | : BasketRowPrices|null | |
| $pricesWithTaxes | : BasketRowPrices|null | |
| $quantity | : int | |
| $subtotal | : float | |
| $total | : float | |
| $type | : 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 |
| 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 |
| setError() | : 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.
$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
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 —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 —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>