FieldsSet
in package
Set of typed fields
Table of Contents
- $fields : mixed
- List of fields
- __construct() : mixed
- Constructor
- getFields() : array<string|int, mixed>
- Getting fields
- getFieldsNames() : array<string|int, string>
- Method returns array of fields names
- getFieldType() : string
- Method returns true if the field exists
- hasCustomFields() : bool
- Method returns true if the entity has custom fields False otherwise
- hasField() : bool
- Method returns true if the field exists
- removeField() : void
- Method removes field
- validateFieldExistance() : void
- Method validates if the field exists
Properties
$fields
List of fields
private
mixed
$fields
= []
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $fields = [] ]) : mixed
Parameters
- $fields : array<string|int, mixed> = []
Return values
mixed —getFields()
Getting fields
public
getFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFieldsNames()
Method returns array of fields names
public
getFieldsNames() : array<string|int, string>
Return values
array<string|int, string> —getFieldType()
Method returns true if the field exists
public
getFieldType(string $fieldName) : string
Parameters
- $fieldName : string
-
field name
Return values
string —field type
hasCustomFields()
Method returns true if the entity has custom fields False otherwise
public
hasCustomFields() : bool
Return values
bool —true if the entity has custom fields
hasField()
Method returns true if the field exists
public
hasField(string $fieldName) : bool
Parameters
- $fieldName : string
-
field name
Return values
bool —removeField()
Method removes field
public
removeField(string $fieldName) : void
Parameters
- $fieldName : string
-
field name
Return values
void —validateFieldExistance()
Method validates if the field exists
public
validateFieldExistance(string $fieldName) : void
Parameters
- $fieldName : string
-
field name