Category extends Category
in package
Uses ElementTrait, CatalogCustomTagValueTrait, DateAddedTrait

This is the Category class.

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

Tags
see
Category::getParentId()
see
Category::getProductsFirst()
see
Category::getAreaId()
see
Category::getIncludeSubcategories()
see
Category::getFeatured()
see
Category::getOffer()
see
Category::getPriority()
see
Category::getLanguage()
see
Category
see
ElementTrait
see
CatalogCustomTagValueTrait
see
DateAddedTrait

Table of Contents

$error  : Error|null
$featured  : bool
$id Autonumeric element id.  : int
$offer  : bool
$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
getAreaId() Returns the area id where this category belongs.  : int
getCustomTagValue() Returns the element custom tag filtered by the given id.  : CatalogCustomTagValue|null
getCustomTagValues() Returns the element custom tags.  : array<string|int, CatalogCustomTagValue>
getDateAdded() Returns the date when the element was added.  : Date|null
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
getIncludeSubcategories() Sets if the subcategories must be printed or not when printing this category content.  : bool
getLanguage() Returns the category language object.  : CategoryLanguage|null
getOffer() Returns if this category is a offers one.  : bool
getParentId() Returns the category parent identifier.  : int
getPId() Returns the element public id (pId).  : string
getPriority() Returns the category priority.  : int
getProdFirst() Sets if when printing this category content the products will be printed before the subcategories.  : bool
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

$featured

protected bool $featured = false

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

getAreaId()

Returns the area id where this category belongs.

public getAreaId() : int
Return values
int —

getDateAdded()

Returns the date when the element was added.

public getDateAdded() : Date|null
Return values
Date|null —

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 —

getIncludeSubcategories()

Sets if the subcategories must be printed or not when printing this category content.

public getIncludeSubcategories() : bool
Return values
bool —

getOffer()

Returns if this category is a offers one.

public getOffer() : bool
Return values
bool —

getParentId()

Returns the category parent identifier.

public getParentId() : int
Return values
int —

getPriority()

Returns the category priority.

public getPriority() : int
Return values
int —

getProdFirst()

Sets if when printing this category content the products will be printed before the subcategories.

public getProdFirst() : bool
Return values
bool —

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 —

Search results