EntityCollection extends CollectionBase
AbstractYes
Class EntityCollection
Table of Contents
Methods
- clearCollection() : mixed
- clearStartField() : bool
- count() : int
- Count elements of an object
- current() : mixed
- Return the current element
- doFinalAction() : Result
- getIndexById() : bool|int|null
- getItemById() : CollectableEntity|null
- getItemByIndex() : CollectableEntity|null
- getIterator() : ArrayIterator
- getRegistryType() : string
- hasMeaningfulField() : bool
- isAnyItemAdded() : bool
- isAnyItemDeleted() : bool
- isChanged() : bool
- isClone() : bool
- isEmpty() : bool
- Checks if collection is empty.
- isMathActionOnly() : bool
- isStartField() : bool
- key() : mixed
- Return the key of the current element
- next() : mixed
- Move forward to next element
- offsetExists() : bool
- Whether a offset exists
- offsetGet() : mixed
- Offset to retrieve
- offsetSet() : void
- Offset to set
- offsetUnset() : void
- Offset to unset
- rewind() : mixed
- Rewind the Iterator to the first element
- setMathActionOnly() : bool
- toArray() : mixed
- valid() : mixed
- Checks if current position is valid
- verify() : Result
Methods
clearCollection()
public
clearCollection() : mixed
Tags
clearStartField()
public
clearStartField() : bool
Return values
boolcount()
Count elements of an object
public
count() : int
Return values
intcurrent()
Return the current element
public
current() : mixed
doFinalAction()
public
doFinalAction([bool $hasMeaningfulField = false ]) : Result
Parameters
- $hasMeaningfulField : bool = false
Return values
ResultgetIndexById()
public
getIndexById(mixed $id) : bool|int|null
Parameters
- $id : mixed
Tags
Return values
bool|int|nullgetItemById()
public
getItemById(mixed $id) : CollectableEntity|null
Parameters
- $id : mixed
Tags
Return values
CollectableEntity|nullgetItemByIndex()
public
getItemByIndex(mixed $index) : CollectableEntity|null
Parameters
- $index : mixed
Tags
Return values
CollectableEntity|nullgetIterator()
public
getIterator() : ArrayIterator
Return values
ArrayIteratorgetRegistryType()
public
static getRegistryType() : string
Tags
Return values
stringhasMeaningfulField()
public
hasMeaningfulField() : bool
Return values
boolisAnyItemAdded()
public
isAnyItemAdded() : bool
Return values
boolisAnyItemDeleted()
public
isAnyItemDeleted() : bool
Return values
boolisChanged()
public
isChanged() : bool
Return values
boolisClone()
public
isClone() : bool
Return values
boolisEmpty()
Checks if collection is empty.
public
isEmpty() : bool
Return values
boolisMathActionOnly()
public
isMathActionOnly() : bool
Return values
boolisStartField()
public
isStartField([bool $isMeaningfulField = false ]) : bool
Parameters
- $isMeaningfulField : bool = false
Return values
boolkey()
Return the key of the current element
public
key() : mixed
next()
Move forward to next element
public
next() : mixed
offsetExists()
Whether a offset exists
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
Offset to retrieve
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
Attributes
- #[ReturnTypeWillChange]
offsetSet()
Offset to set
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
Offset to unset
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
rewind()
Rewind the Iterator to the first element
public
rewind() : mixed
setMathActionOnly()
public
setMathActionOnly([bool|false $value = false ]) : bool
Parameters
- $value : bool|false = false
Return values
booltoArray()
public
toArray() : mixed
valid()
Checks if current position is valid
public
valid() : mixed
verify()
public
verify() : Result