ItemPrices
in package
Uses
ElementTrait
This is the Item Prices class.
The prices of API items will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| __construct() | Elements constructor. | : mixed |
|---|---|---|
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getBasePrice() | Returns the item base price. | : float |
| getPriceByQuantity() | Returns the item prices object for the given quantity. | : Prices |
| getPrices() | Returns the item prices object. | : Prices|null |
| getPricesByQuantity() | Returns the collection of prices by quantity for this item. | : array<string|int, PricesByQuantity> |
| getRetailPrice() | Returns the item retail 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> |
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 —getBasePrice()
Returns the item base price.
public
getBasePrice() : float
Return values
float —getPriceByQuantity()
Returns the item prices object for the given quantity.
public
getPriceByQuantity([int $quantity = -1 ]) : Prices
Parameters
- $quantity : int = -1
-
The quantity for which we want the prices.
Tags
Return values
Prices —getPrices()
Returns the item prices object.
public
getPrices() : Prices|null
Tags
Return values
Prices|null —getPricesByQuantity()
Returns the collection of prices by quantity for this item.
public
getPricesByQuantity() : array<string|int, PricesByQuantity>
Tags
Return values
array<string|int, PricesByQuantity> —getRetailPrice()
Returns the item retail price.
public
getRetailPrice() : 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