CombinationDataStock
in package
Uses
ElementTrait
This is the Current Data Stock class.
The API Current Data Stock data will be stored in that class and will remain immutable (only get methods are prevision)
Tags
Table of Contents
| __construct() | Elements constructor. | : mixed |
|---|---|---|
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAvailabilityId() | Returns the internal identifier of the product assigned availability. | : int |
| getCombinationId() | Returns the combinationId. | : int |
| getOffsetDays() | Returns the offsetDays. | : int |
| getPrevisionDate() | Returns the projected date of arrival of the product. | : Date|null |
| getUnits() | Returns the units. | : int |
| getWarehouseIds() | Returns the warehouseIds. | : array<string|int, mixed> |
| 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 —getAvailabilityId()
Returns the internal identifier of the product assigned availability.
public
getAvailabilityId() : int
Return values
int —getCombinationId()
Returns the combinationId.
public
getCombinationId() : int
Return values
int —getOffsetDays()
Returns the offsetDays.
public
getOffsetDays() : int
Return values
int —getPrevisionDate()
Returns the projected date of arrival of the product.
public
getPrevisionDate() : Date|null
Return values
Date|null —getUnits()
Returns the units.
public
getUnits() : int
Return values
int —getWarehouseIds()
Returns the warehouseIds.
public
getWarehouseIds() : array<string|int, mixed>
Return values
array<string|int, mixed> —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