BasketRowData
in package
Uses ElementTrait, EnumResolverTrait

This is the basket row data container class.

The basket row data information will be stored in that class and will remain immutable (only get methods are available)

Tags
see
BasketRowData::getProductId()
see
BasketRowData::getHash()
see
BasketRowData::getQuantity()
see
BasketRowData::getTotalWeight()
see
BasketRowData::getTotalPrice()
see
BasketRowData::getStockManagement()
see
BasketRowData::getOnRequest()
see
BasketRowData::getShipping()
see
BasketRowData::getShippingCalculation()
see
BasketRowData::getBackorder()
see
BasketRowData::getOnRequestDays()
see
BasketRowData::getMainCategory()
see
ElementTrait

Table of Contents

__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getBackorder() Sets if the basket row allow the reservation and how (reservation type).  : string
getHash() Returns the basket row hash.  : string
getMainCategory() Returns the basket row main category.  : int
getOnRequest() Returns the basket row on request.  : bool
getOnRequestDays() Returns the basket row on request days.  : int
getProductId() Returns the basket row product internal id.  : int
getQuantity() Returns the basket row quantity.  : int
getShipping() Returns the basket row shipping.  : bool
getShippingCalculation() Returns the basket row shipping calculation.  : string
getStockManagement() Returns the basket row stock management.  : bool
getTotalPrice() Returns the basket row total price.  : float
getTotalWeight() Returns the basket row total 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>

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 —

getBackorder()

Sets if the basket row allow the reservation and how (reservation type).

public getBackorder() : string
Return values
string —

getHash()

Returns the basket row hash.

public getHash() : string
Return values
string —

getMainCategory()

Returns the basket row main category.

public getMainCategory() : int
Return values
int —

getOnRequest()

Returns the basket row on request.

public getOnRequest() : bool
Return values
bool —

getOnRequestDays()

Returns the basket row on request days.

public getOnRequestDays() : int
Return values
int —

getProductId()

Returns the basket row product internal id.

public getProductId() : int
Return values
int —

getQuantity()

Returns the basket row quantity.

public getQuantity() : int
Return values
int —

getShipping()

Returns the basket row shipping.

public getShipping() : bool
Return values
bool —

getShippingCalculation()

Returns the basket row shipping calculation.

public getShippingCalculation() : string
Return values
string —

getStockManagement()

Returns the basket row stock management.

public getStockManagement() : bool
Return values
bool —

getTotalPrice()

Returns the basket row total price.

public getTotalPrice() : float
Return values
float —

getTotalWeight()

Returns the basket row total weight.

public getTotalWeight() : 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> —

Search results