FormField
in package
Uses ElementTrait, ElementNameTrait

This is the Form Field class.

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

Tags
see
FormField::getType()
see
FormField::getRequired()
see
FormField::getRegularExpression()
see
ElementTrait
see
ElementNameTrait

Table of Contents

$name  : string
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getName() Returns the element name on the website current language.  : string
getRegularExpression() Returns the regular expression that the form field has to match to validate.  : string
getRequired() Returns if the form field is required or not.  : bool
getType() Returns the form field type.  : string
getValueList() Returns the valid list of values if exists. Otherwise return an empty array.  : 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

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 —

getName()

Returns the element name on the website current language.

public getName() : string
Return values
string —

getRegularExpression()

Returns the regular expression that the form field has to match to validate.

public getRegularExpression() : string
Return values
string —

getRequired()

Returns if the form field is required or not.

public getRequired() : bool
Return values
bool —

getType()

Returns the form field type.

public getType() : string
Return values
string —

getValueList()

Returns the valid list of values if exists. Otherwise return an empty array.

public getValueList() : 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> —

Search results