Stock
in package
Uses ElementTrait

This is the Stock class.

The stock of API products will be stored in that class and will remain immutable (only get methods are available)

Tags
see
Stock::getUnits()
see
Stock::getWarehouseId()
see
Stock::getWarehouseGroupId()
see
Stock::getPriority()
see
Stock::getOffsetDays()
see
Stock::getPrevisionList()
see
ElementTrait

Table of Contents

__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getOffsetDays() Returns the total number of days a stock could take to be served.  : int
getPrevisions() Returns a collection of previsions on this stock object.  : array<string|int, Prevision>
getPriority() Returns the stock consumption priority.  : int
getUnits() Returns the total units on this stock object.  : int
getWarehouseGroupId() Returns the group identifier where the warehouse of this stock belongs.  : int
getWarehouseId() Returns the warehouse id where this stock belongs.  : 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>

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 —

getOffsetDays()

Returns the total number of days a stock could take to be served.

public getOffsetDays() : int
Return values
int —

getPrevisions()

Returns a collection of previsions on this stock object.

public getPrevisions() : array<string|int, Prevision>
Tags
see
Prevision
Return values
array<string|int, Prevision> —

getPriority()

Returns the stock consumption priority.

public getPriority() : int
Return values
int —

getUnits()

Returns the total units on this stock object.

public getUnits() : int
Return values
int —

getWarehouseGroupId()

Returns the group identifier where the warehouse of this stock belongs.

public getWarehouseGroupId() : int
Return values
int —

getWarehouseId()

Returns the warehouse id where this stock belongs.

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> —

Search results