Brand
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, DateAddedTrait, IntegrableElementTrait
This is the Brand class.
The information of API Brands 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 |
| $pId | Public and readable element id. | : string |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getActive() | Sets if the brand is active or not. | : bool |
| getDateAdded() | Returns the date when the element was added. | : Date|null |
| getDeleted() | Sets if the brand is a deleted or not. | : bool |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getFeatured() | Sets if the brand is a featured or not. | : bool |
| getId() | Returns the element id. | : int |
| getLanguage() | Returns the brand language object. | : BrandLanguage|null |
| getOffer() | Sets if the brand is a offer or not. | : bool |
| getPId() | Returns the element public id (pId). | : string |
| getPriority() | Returns the brand priority. | : 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.
$pId
Public and readable element id.
protected
string
$pId
= ''
Setted by the user on LogiCommerce. All the integrable elements by the LogiCommerce API will send it. Useful for integrations and other 3rd party softwares that need to connect to LogiCommerce software.
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 —getActive()
Sets if the brand is active or not.
public
getActive() : bool
Return values
bool —getDateAdded()
Returns the date when the element was added.
public
getDateAdded() : Date|null
Return values
Date|null —getDeleted()
Sets if the brand is a deleted or not.
public
getDeleted() : bool
Return values
bool —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getFeatured()
Sets if the brand is a featured or not.
public
getFeatured() : bool
Return values
bool —getId()
Returns the element id.
public
getId() : int
Return values
int —getLanguage()
Returns the brand language object.
public
getLanguage() : BrandLanguage|null
Tags
Return values
BrandLanguage|null —getOffer()
Sets if the brand is a offer or not.
public
getOffer() : bool
Return values
bool —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getPriority()
Returns the brand priority.
public
getPriority() : 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