BasketCustomTagValue
extends CustomTagValue
in package
Uses
ElementTrait, CustomTagsDataTrait
This is the Custom Tag Value class.
The custom tags values information of API elements will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $customTagId | : int | |
|---|---|---|
| $customTagPId | : string | |
| $name | : string | |
| $position | : int | |
| $value | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getControlType() | Returns the custom tag control type. | : string |
| getCustomTagId() | Returns the custom tag internal identifier. | : int |
| getCustomTagPId() | Returns the custom tag public identifier. | : string |
| getInOrders() | Returns if the custom tag is printable on the orders documents. | : bool |
| getName() | Returns the element name on the website current language. | : string |
| getPosition() | Returns the custom tag position. | : int |
| getValue() | Returns the value of the custom tag value. | : string |
| getValuePId() | Returns the public identifier of the custom tag value. | : string |
| 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> |
Properties
$customTagId
protected
int
$customTagId
= 0
$customTagPId
protected
string
$customTagPId
= ''
$name
protected
string
$name
= ''
$position
protected
int
$position
= 0
$value
protected
string
$value
= ''
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 —getControlType()
Returns the custom tag control type.
public
getControlType() : string
Return values
string —getCustomTagId()
Returns the custom tag internal identifier.
public
getCustomTagId() : int
Return values
int —getCustomTagPId()
Returns the custom tag public identifier.
public
getCustomTagPId() : string
Return values
string —getInOrders()
Returns if the custom tag is printable on the orders documents.
public
getInOrders() : bool
Return values
bool —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPosition()
Returns the custom tag position.
public
getPosition() : int
Return values
int —getValue()
Returns the value of the custom tag value.
public
getValue() : string
Return values
string —getValuePId()
Returns the public identifier of the custom tag value.
public
getValuePId() : string
Return values
string —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