Linked
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the Linked class.
The Linked information of API elements 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 |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getImage() | Returns the image path of the linked items section. | : string |
| getName() | Returns the name of the linked items section. | : string |
| getPercentVariation() | Returns the price variation of the linked items section. | : float |
| getPosition() | Returns the position of the linked items section. | : int |
| getProducts() | Returns the information about products linked to this product. | : array<string|int, Product> |
| getSectionId() | Returns the internal identifier of the linked items section. | : string |
| getType() | Returns the Type of relationship system. | : string |
| getUnitsLimitation() | Returns the units limitation of the linked items section. | : 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
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 —getImage()
Returns the image path of the linked items section.
public
getImage() : string
Return values
string —getName()
Returns the name of the linked items section.
public
getName() : string
Return values
string —getPercentVariation()
Returns the price variation of the linked items section.
public
getPercentVariation() : float
Return values
float —getPosition()
Returns the position of the linked items section.
public
getPosition() : int
Return values
int —getProducts()
Returns the information about products linked to this product.
public
getProducts() : array<string|int, Product>
Return values
array<string|int, Product> —getSectionId()
Returns the internal identifier of the linked items section.
public
getSectionId() : string
Return values
string —getType()
Returns the Type of relationship system.
public
getType() : string
Return values
string —getUnitsLimitation()
Returns the units limitation of the linked items section.
public
getUnitsLimitation() : 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