Product
extends BasketRow
in package
Uses
ElementTrait
This is the basket product class.
The basket products information will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $appliedDiscounts | : array<string|int, mixed> | |
|---|---|---|
| $appliedTaxes | : array<string|int, mixed> | |
| $basketWarnings | : array<string|int, mixed> | |
| $brandName | : string | |
| $codes | : ProductCodes|null | |
| $combination | : Combination|null | |
| $customTagValues | : array<string|int, mixed> | |
| $error | : Error|null | |
| $hash | : string | |
| $id | Autonumeric element id. | : int |
| $images | : Media|null | |
| $name | : string | |
| $options | : array<string|int, mixed> | |
| $prices | : BasketRowPrices|null | |
| $pricesWithTaxes | : BasketRowPrices|null | |
| $quantity | : int | |
| $subtotal | : float | |
| $total | : float | |
| $type | : string | |
| $urlSeo | : string | |
| $weight | : float | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAppliedDiscounts() | Returns the basket item applied discounts. | : array<string|int, AppliedDiscount> |
| getAppliedTaxes() | Returns the basket item applied taxes. | : array<string|int, AppliedTax> |
| getBasketWarnings() | Returns the basket item warnings. | : array<string|int, BasketWarning> |
| getBrandName() | Returns the basket item brand name for the website current language. | : string |
| getCodes() | Returns the product codes. | : ProductCodes |
| getCombination() | Returns the product combination. | : Combination |
| getCustomTagValues() | Returns the element custom tag values. | : array<string|int, BasketCustomTagValue> |
| 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 |
| getImages() | Returns the basket item images. | : Media|null |
| getName() | Returns the element name on the website current language. | : string |
| getOptions() | Returns the product options. | : array<string|int, Option> |
| 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 |
| getUrlSeo() | Returns the basket item SEO URL for the website current language. | : string |
| getWeight() | Returns the basket item 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 | |
| setAppliedDiscounts() | : void | |
| setAppliedTaxes() | : void | |
| setArrayField() | Convert an API array of objects to a PHP array of objects. | : array<string|int, mixed> |
| setBasketWarnings() | : void | |
| setCodes() | : void | |
| setCombination() | : void | |
| setCustomTagValues() | : void | |
| setError() | : void | |
| setImages() | : void | |
| setOptions() | : void | |
| setPrices() | : void | |
| setPricesWithTaxes() | : void |
Properties
$appliedDiscounts
protected
array<string|int, mixed>
$appliedDiscounts
= []
$appliedTaxes
protected
array<string|int, mixed>
$appliedTaxes
= []
$basketWarnings
protected
array<string|int, mixed>
$basketWarnings
= []
$brandName
protected
string
$brandName
= ''
$codes
protected
ProductCodes|null
$codes
= null
$combination
protected
Combination|null
$combination
= null
$customTagValues
protected
array<string|int, mixed>
$customTagValues
= []
$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.
$images
protected
Media|null
$images
= null
$name
protected
string
$name
= ''
$options
protected
array<string|int, mixed>
$options
= []
$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
= ''
$urlSeo
protected
string
$urlSeo
= ''
$weight
protected
float
$weight
= 0.0
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 —getAppliedDiscounts()
Returns the basket item applied discounts.
public
getAppliedDiscounts() : array<string|int, AppliedDiscount>
Return values
array<string|int, AppliedDiscount> —getAppliedTaxes()
Returns the basket item applied taxes.
public
getAppliedTaxes() : array<string|int, AppliedTax>
Return values
array<string|int, AppliedTax> —getBasketWarnings()
Returns the basket item warnings.
public
getBasketWarnings() : array<string|int, BasketWarning>
Return values
array<string|int, BasketWarning> —getBrandName()
Returns the basket item brand name for the website current language.
public
getBrandName() : string
Return values
string —getCodes()
Returns the product codes.
public
getCodes() : ProductCodes
Return values
ProductCodes —getCombination()
Returns the product combination.
public
getCombination() : Combination
Return values
Combination —getCustomTagValues()
Returns the element custom tag values.
public
getCustomTagValues() : array<string|int, BasketCustomTagValue>
Return values
array<string|int, BasketCustomTagValue> —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 —getImages()
Returns the basket item images.
public
getImages() : Media|null
Return values
Media|null —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getOptions()
Returns the product options.
public
getOptions() : array<string|int, Option>
Return values
array<string|int, Option> —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 —getUrlSeo()
Returns the basket item SEO URL for the website current language.
public
getUrlSeo() : string
Return values
string —getWeight()
Returns the basket item 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 —setAppliedDiscounts()
protected
setAppliedDiscounts(array<string|int, mixed> $appliedDiscounts) : void
Parameters
- $appliedDiscounts : array<string|int, mixed>
Return values
void —setAppliedTaxes()
protected
setAppliedTaxes(array<string|int, mixed> $appliedTaxes) : void
Parameters
- $appliedTaxes : array<string|int, mixed>
Return values
void —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> —setBasketWarnings()
protected
setBasketWarnings(array<string|int, mixed> $basketWarnings) : void
Parameters
- $basketWarnings : array<string|int, mixed>
Return values
void —setCodes()
protected
setCodes(array<string|int, mixed> $codes) : void
Parameters
- $codes : array<string|int, mixed>
Return values
void —setCombination()
protected
setCombination(array<string|int, mixed> $combination) : void
Parameters
- $combination : array<string|int, mixed>
Return values
void —setCustomTagValues()
protected
setCustomTagValues(array<string|int, mixed> $customTagValues) : void
Parameters
- $customTagValues : array<string|int, mixed>
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setImages()
protected
setImages(array<string|int, mixed> $images) : void
Parameters
- $images : array<string|int, mixed>
Return values
void —setOptions()
protected
setOptions(array<string|int, mixed> $options) : void
Parameters
- $options : 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>