CategoryTree
extends Category
in package
Uses
ElementTrait, CatalogCustomTagValueTrait
This is the Category Tree class.
The information of API Category Trees will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $featured | : bool | |
| $id | Autonumeric element id. | : int |
| $offer | : bool | |
| $pId | Public and readable element id. | : string |
| $subcategories | : array<string|int, mixed> | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getCustomTagValue() | Returns the element custom tag filtered by the given id. | : CatalogCustomTagValue|null |
| getCustomTagValues() | Returns the element custom tags. | : array<string|int, CatalogCustomTagValue> |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getFeatured() | Returns if this category is a featured one. | : bool |
| getId() | Returns the element id. | : int |
| getLanguage() | Returns the category tree language object. | : CategoryTreeLanguage|null |
| getOffer() | Returns if this category is a offers one. | : bool |
| getPId() | Returns the element public id (pId). | : string |
| getSubcategories() | Returns the category subcategories. | : array<string|int, static> |
| 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 | |
| setSubcategories() | : void |
Properties
$error
protected
Error|null
$error
= null
$featured
protected
bool
$featured
= false
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$offer
protected
bool
$offer
= false
$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.
$subcategories
protected
array<string|int, mixed>
$subcategories
= []
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 —getCustomTagValue()
Returns the element custom tag filtered by the given id.
public
getCustomTagValue(string $customTagPId) : CatalogCustomTagValue|null
Parameters
- $customTagPId : string
-
Public identifier of the custom tag you want to get.
Tags
Return values
CatalogCustomTagValue|null —getCustomTagValues()
Returns the element custom tags.
public
getCustomTagValues() : array<string|int, CatalogCustomTagValue>
Tags
Return values
array<string|int, CatalogCustomTagValue> —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getFeatured()
Returns if this category is a featured one.
public
getFeatured() : bool
Return values
bool —getId()
Returns the element id.
public
getId() : int
Return values
int —getLanguage()
Returns the category tree language object.
public
getLanguage() : CategoryTreeLanguage|null
Tags
Return values
CategoryTreeLanguage|null —getOffer()
Returns if this category is a offers one.
public
getOffer() : bool
Return values
bool —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getSubcategories()
Returns the category subcategories.
public
getSubcategories() : array<string|int, static>
Return values
array<string|int, static> —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
Return values
void —setSubcategories()
protected
setSubcategories(array<string|int, mixed> $subcategories) : void
Parameters
- $subcategories : array<string|int, mixed>