DocumentRowStock
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, EnumResolverTrait
This is the document row stock class.
The document row stocks will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $id | Autonumeric element id. | : int |
| __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 document row stock hash. | : string |
| getId() | Returns the element id. | : int |
| getIncomingDate() | Returns the document row stock incoming date. | : Date|null |
| getMissingStockQuantity() | Returns the document row stock missingStockQuantity. | : int |
| getOffsetDays() | Returns the document row stock offset days. | : int |
| getPrevisionType() | Returns the document row stock prevision type. | : string |
| getPriority() | Returns the document row stock priority. | : int |
| getQuantity() | Returns the document row stock quantity. | : int |
| getWarehouseGroupId() | Returns the document row stock warehouse group internal identifier. | : int |
| getWarehouseId() | Returns the document row stock warehouse internal identifier. | : int |
| 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
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
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 document row stock hash.
public
getHash() : string
Return values
string —getId()
Returns the element id.
public
getId() : int
Return values
int —getIncomingDate()
Returns the document row stock incoming date.
public
getIncomingDate() : Date|null
Return values
Date|null —getMissingStockQuantity()
Returns the document row stock missingStockQuantity.
public
getMissingStockQuantity() : int
Return values
int —getOffsetDays()
Returns the document row stock offset days.
public
getOffsetDays() : int
Return values
int —getPrevisionType()
Returns the document row stock prevision type.
public
getPrevisionType() : string
Return values
string —getPriority()
Returns the document row stock priority.
public
getPriority() : int
Return values
int —getQuantity()
Returns the document row stock quantity.
public
getQuantity() : int
Return values
int —getWarehouseGroupId()
Returns the document row stock warehouse group internal identifier.
public
getWarehouseGroupId() : int
Return values
int —getWarehouseId()
Returns the document row stock warehouse internal identifier.
public
getWarehouseId() : int
Return values
int —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