Category
extends Element
in package
Uses
IdentifiableElementTrait, IntegrableElementTrait
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
Table of Contents
$error | : Error|null | |
---|---|---|
$featured | : bool | |
$id | Autonumeric element id. | : int |
$offer | : bool | |
$pId | Public and readable element id. | : string |
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 |
getOffer() | Returns if this category is a offers one. | : bool |
getPId() | Returns the element public id (pId). | : string |
setError() | : 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.
Methods
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 —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 —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed