FieldsCollection
in package
implements
FieldModuleCollection
Interfaces, Classes, Traits and Enums
Table of Contents
- $_fields : array<string|int, mixed>
- $_fieldsByModule : array<string|int, mixed>
- addField() : mixed
- containsFieldByModule() : bool
- getAllFields() : array<string|int, Field>
- getAllFieldsKeyedUnsafe() : array<string|int, mixed>
- getFieldByKeyUnsafe() : Field
- getFieldByModuleAndName() : Field
- getFieldsByModule() : array<string|int, mixed>
- merge() : mixed
- removeFieldByModuleAndName() : Field
Properties
$_fields
private
array<string|int, mixed>
$_fields
= []
$_fieldsByModule
private
array<string|int, mixed>
$_fieldsByModule
= []
Methods
addField()
public
addField(Field $pField) : mixed
Parameters
- $pField : Field
Return values
mixed —containsFieldByModule()
public
containsFieldByModule(string $module, string $name) : bool
Parameters
- $module : string
- $name : string
Return values
bool —getAllFields()
public
getAllFields() : array<string|int, Field>
Return values
array<string|int, Field> —getAllFieldsKeyedUnsafe()
public
getAllFieldsKeyedUnsafe() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFieldByKeyUnsafe()
public
getFieldByKeyUnsafe(string $fieldName) : Field
Parameters
- $fieldName : string
Tags
Return values
Field —getFieldByModuleAndName()
public
getFieldByModuleAndName(string $module, string $name) : Field
Parameters
- $module : string
- $name : string
Tags
Return values
Field —getFieldsByModule()
public
getFieldsByModule(string $module) : array<string|int, mixed>
Parameters
- $module : string
Return values
array<string|int, mixed> —merge()
public
merge(FieldModuleCollection $pFieldsCollection[, string $fallbackCategoryName = '' ]) : mixed
Parameters
- $pFieldsCollection : FieldModuleCollection
- $fallbackCategoryName : string = ''
Return values
mixed —removeFieldByModuleAndName()
public
removeFieldByModuleAndName(string $module, string $name) : Field
Parameters
- $module : string
- $name : string
Tags
Return values
Field —the removed Field