BasketRowPrices
extends Price
in package
Uses
ElementTrait
This is the basket product prices class.
The basket products prices information will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $unitPreviousPrice | : float | |
|---|---|---|
| $unitPrice | : float | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getPreviousPrice() | Returns the previous price. | : float |
| getPrice() | Returns the base price. | : float |
| getTotalDiscounts() | Returns the total discounts. | : float |
| getUnitPreviousPrice() | Returns the unit previous price. | : float |
| getUnitPrice() | Returns unit price. | : 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> |
Properties
$unitPreviousPrice
protected
float
$unitPreviousPrice
= 0.0
$unitPrice
protected
float
$unitPrice
= 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 —getPreviousPrice()
Returns the previous price.
public
getPreviousPrice() : float
Return values
float —getPrice()
Returns the base price.
public
getPrice() : float
Return values
float —getTotalDiscounts()
Returns the total discounts.
public
getTotalDiscounts() : float
Return values
float —getUnitPreviousPrice()
Returns the unit previous price.
public
getUnitPreviousPrice() : float
Return values
float —getUnitPrice()
Returns unit price.
public
getUnitPrice() : 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