CustomTag
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, IntegrableElementTrait, CustomTagsDataTrait
This is the Custom Tag class.
The custom tags information of API elements 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 |
| getComparable() | Returns if the custom tag has to be comparable or not. | : bool |
| getControlType() | Returns the custom tag control type. | : string |
| getDefaultValue() | Returns the custom tag default value. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getFilterable() | Returns if the custom tag has to be filterable or not. | : bool |
| getId() | Returns the element id. | : int |
| getLanguage() | Returns the custom tag language object. | : CustomTagLanguage|null |
| getMaxValue() | Returns the custom tag maximum allowed value. | : string |
| getMinValue() | Returns the custom tag minimum allowed value. | : string |
| getNameOnFeed() | Returns if the custom tag name on feed. | : string |
| getPId() | Returns the element public id (pId). | : string |
| getPosition() | Returns the custom tag position. | : int |
| getPriority() | Returns the custom tag priority. | : int |
| getRequired() | Returns if the custom tag has to be required or not. | : bool |
| getSearchable() | Returns if the custom tag has to be searchable or not. | : bool |
| getSelectableValues() | Returns the custom tag selectable values. | : array<string|int, CustomTagSelectableValue> |
| 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 —getComparable()
Returns if the custom tag has to be comparable or not.
public
getComparable() : bool
Return values
bool —getControlType()
Returns the custom tag control type.
public
getControlType() : string
Return values
string —getDefaultValue()
Returns the custom tag default value.
public
getDefaultValue() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getFilterable()
Returns if the custom tag has to be filterable or not.
public
getFilterable() : bool
Return values
bool —getId()
Returns the element id.
public
getId() : int
Return values
int —getLanguage()
Returns the custom tag language object.
public
getLanguage() : CustomTagLanguage|null
Tags
Return values
CustomTagLanguage|null —getMaxValue()
Returns the custom tag maximum allowed value.
public
getMaxValue() : string
Return values
string —getMinValue()
Returns the custom tag minimum allowed value.
public
getMinValue() : string
Return values
string —getNameOnFeed()
Returns if the custom tag name on feed.
public
getNameOnFeed() : string
Return values
string —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getPosition()
Returns the custom tag position.
public
getPosition() : int
Return values
int —getPriority()
Returns the custom tag priority.
public
getPriority() : int
Return values
int —getRequired()
Returns if the custom tag has to be required or not.
public
getRequired() : bool
Return values
bool —getSearchable()
Returns if the custom tag has to be searchable or not.
public
getSearchable() : bool
Return values
bool —getSelectableValues()
Returns the custom tag selectable values.
public
getSelectableValues() : array<string|int, CustomTagSelectableValue>
Return values
array<string|int, CustomTagSelectableValue> —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