Codes
in package
Uses
ElementTrait
This is the Codes class.
The Codes information of API elements will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
$ean | : string | |
---|---|---|
$isbn | : string | |
$jan | : string | |
$sku | : string | |
$upc | : string | |
__construct() | Elements constructor. | : mixed |
__toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
getEan() | Returns the element EAN. | : string |
getIsbn() | Returns the element ISBN. | : string |
getJan() | Returns the element JAN. | : string |
getSku() | Returns the element SKU. | : string |
getUpc() | Returns the element UPC. | : 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> |
Properties
$ean
protected
string
$ean
= ''
$isbn
protected
string
$isbn
= ''
$jan
protected
string
$jan
= ''
$sku
protected
string
$sku
= ''
$upc
protected
string
$upc
= ''
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 —getEan()
Returns the element EAN.
public
getEan() : string
Return values
string —getIsbn()
Returns the element ISBN.
public
getIsbn() : string
Return values
string —getJan()
Returns the element JAN.
public
getJan() : string
Return values
string —getSku()
Returns the element SKU.
public
getSku() : string
Return values
string —getUpc()
Returns the element UPC.
public
getUpc() : 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