DocumentUserCustomTag
extends AbstractDocumentCustomTag
in package
This is the document user custom tag class.
The document custom tags will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $controlType | : string | |
|---|---|---|
| $customTagId | : int | |
| $error | : Error|null | |
| $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 document custom tag internal identifier. | : int |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getName() | Returns the element name on the website current language. | : string |
| getPosition() | Returns the rich document position value. | : int |
| getValue() | Returns the document 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> |
| setError() | : void |
Properties
$controlType
protected
string
$controlType
= ''
$customTagId
protected
int
$customTagId
= 0
$error
protected
Error|null
$error
= null
$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 document custom tag internal identifier.
public
getCustomTagId() : int
Return values
int —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPosition()
Returns the rich document position value.
public
getPosition() : int
Return values
int —getValue()
Returns the document custom tag value.
public
getValue() : 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
Return values
array<string|int, mixed> —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed