Collection implements Iterator, ArrayAccess, Countable
Table of Contents
Interfaces
- Iterator
- ArrayAccess
- Countable
Methods
- __construct() : mixed
- count() : int
- current() : Field|null
- getField() : Field|null
- getFieldNameList() : array<string|int, mixed>
- getFieldsByType() : self
- Returns a new collection, that contains all fields of this collection with specific type
- getHiddenFieldNames() : array<string|int, string>
- Return array of field names that has attribute Hidden
- hasField() : bool
- key() : string
- next() : void
- offsetExists() : bool
- offsetGet() : Field|null
- offsetSet() : void
- offsetUnset() : void
- removeHiddenValues() : array<string|int, mixed>
- Remove keys from $data that among hidden fields of this collection.
- removeHiddenValuesByFieldNames() : array<string|int, mixed>
- Remove keys from $data that present in $hiddenFieldNames.
- rewind() : void
- toArray() : array<string|int, mixed>
- valid() : bool
Methods
__construct()
public
__construct(array<string|int, Field> $fields) : mixed
Parameters
- $fields : array<string|int, Field>
count()
public
count() : int
Return values
intcurrent()
public
current() : Field|null
Return values
Field|nullgetField()
public
getField(string $fieldName) : Field|null
Parameters
- $fieldName : string
Return values
Field|nullgetFieldNameList()
public
getFieldNameList() : array<string|int, mixed>
Return values
array<string|int, mixed>getFieldsByType()
Returns a new collection, that contains all fields of this collection with specific type
public
final getFieldsByType(string $fieldType) : self
Parameters
- $fieldType : string
Return values
selfgetHiddenFieldNames()
Return array of field names that has attribute Hidden
public
getHiddenFieldNames() : array<string|int, string>
Return values
array<string|int, string>hasField()
public
hasField(string $fieldName) : bool
Parameters
- $fieldName : string
Return values
boolkey()
public
key() : string
Return values
stringnext()
public
next() : void
offsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : Field|null
Parameters
- $offset : mixed
Return values
Field|nulloffsetSet()
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
removeHiddenValues()
Remove keys from $data that among hidden fields of this collection.
public
removeHiddenValues(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
Return values
array<string|int, mixed>removeHiddenValuesByFieldNames()
Remove keys from $data that present in $hiddenFieldNames.
public
static removeHiddenValuesByFieldNames(array<string|int, mixed> $data, array<string|int, string> $hiddenFieldNames) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
- $hiddenFieldNames : array<string|int, string>
Return values
array<string|int, mixed>rewind()
public
rewind() : void
toArray()
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>valid()
public
valid() : bool