RichDocumentItemStock
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the rich document item stock class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $hash | : string | |
| $incomingDate | : string | |
| $missingStockQuantity | : int | |
| $offsetDays | : int | |
| $previsionType | : string | |
| $priority | : int | |
| $quantity | : int | |
| $warehouseGroupName | : string | |
| $warehouseName | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getHash() | Returns the rich document item stock hash. | : string |
| getIncomingDate() | Returns the rich document item stock incomingDate. | : string |
| getMissingStockQuantity() | Returns the document row stock missingStockQuantity. | : int |
| getOffsetDays() | Returns the rich document item stock offsetDays. | : int |
| getPrevisionType() | Returns the rich document item stock previsionType. | : string |
| getPriority() | Returns the rich document item stock priority. | : int |
| getQuantity() | Returns the rich document item stock quantity. | : int |
| getWarehouseGroupName() | Returns the rich document item stock warehouseGroupName. | : string |
| getWarehouseName() | Returns the rich document item stock warehouseName. | : string |
| 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
$hash
protected
string
$hash
= ''
$incomingDate
protected
string
$incomingDate
= ''
$missingStockQuantity
protected
int
$missingStockQuantity
= 0
$offsetDays
protected
int
$offsetDays
= 0
$previsionType
protected
string
$previsionType
= ''
$priority
protected
int
$priority
= 0
$quantity
protected
int
$quantity
= 0
$warehouseGroupName
protected
string
$warehouseGroupName
= ''
$warehouseName
protected
string
$warehouseName
= ''
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 —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getHash()
Returns the rich document item stock hash.
public
getHash() : string
Return values
string —getIncomingDate()
Returns the rich document item stock incomingDate.
public
getIncomingDate() : string
Return values
string —getMissingStockQuantity()
Returns the document row stock missingStockQuantity.
public
getMissingStockQuantity() : int
Return values
int —getOffsetDays()
Returns the rich document item stock offsetDays.
public
getOffsetDays() : int
Return values
int —getPrevisionType()
Returns the rich document item stock previsionType.
public
getPrevisionType() : string
Return values
string —getPriority()
Returns the rich document item stock priority.
public
getPriority() : int
Return values
int —getQuantity()
Returns the rich document item stock quantity.
public
getQuantity() : int
Return values
int —getWarehouseGroupName()
Returns the rich document item stock warehouseGroupName.
public
getWarehouseGroupName() : string
Return values
string —getWarehouseName()
Returns the rich document item stock warehouseName.
public
getWarehouseName() : string
Return values
string —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