StockSettings
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the stock settings class.
The stock settings will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAllowMultiexpedition() | Returns if the website allows multiexpedition or not. | : bool |
| getAllowReservations() | Returns if the website allows reservations or not. | : bool |
| getCatalogStockPolicy() | Returns the stock settings catalogs tock policy. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getOnlyInStock() | Returns the stock settings onlyInStock. | : bool |
| getShipmentsByDate() | Returns the shipments by date setting. | : string |
| getStockManagement() | Returns if the stock management is enabled or not. | : bool |
| getStockSystem() | Returns the stock system. | : string |
| getUseStockPrevisionOnReservePrevision() | Returns the stock settings useStockPrevisionOnReservePrevision. | : bool |
| 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> |
| setError() | : void |
Properties
$error
protected
Error|null
$error
= null
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 —getAllowMultiexpedition()
Returns if the website allows multiexpedition or not.
public
getAllowMultiexpedition() : bool
Return values
bool —getAllowReservations()
Returns if the website allows reservations or not.
public
getAllowReservations() : bool
Return values
bool —getCatalogStockPolicy()
Returns the stock settings catalogs tock policy.
public
getCatalogStockPolicy() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getOnlyInStock()
Returns the stock settings onlyInStock.
public
getOnlyInStock() : bool
Return values
bool —getShipmentsByDate()
Returns the shipments by date setting.
public
getShipmentsByDate() : string
Return values
string —getStockManagement()
Returns if the stock management is enabled or not.
public
getStockManagement() : bool
Return values
bool —getStockSystem()
Returns the stock system.
public
getStockSystem() : string
Return values
string —getUseStockPrevisionOnReservePrevision()
Returns the stock settings useStockPrevisionOnReservePrevision.
public
getUseStockPrevisionOnReservePrevision() : bool
Return values
bool —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> —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed