DocumentCollection implements ItemCollection, Iterator, Countable
Table of Contents
Interfaces
- ItemCollection
- Iterator
- Countable
Methods
- __construct() : mixed
- add() : DocumentCollection
- all() : bool
- any() : bool
- clear() : DocumentCollection
- count() : int
- current() : Document|null
- filter() : DocumentCollection
- findByTemplateId() : Document|null
- getArrayByIds() : array<int, Document>
- Get array with keys - values of id field
- getByEntityId() : Document|null
- getById() : Document|null
- getFirst() : Document|null
- isEmpty() : bool
- key() : int
- listIdsWithoutNull() : array<int, int>
- next() : void
- rewind() : void
- sortByTemplateIdsDesc() : static
- toArray() : array<string|int, T>
- valid() : bool
Methods
__construct()
public
__construct(Document ...$items) : mixed
Parameters
- $items : Document
add()
public
add(Document $item) : DocumentCollection
Parameters
- $item : Document
Return values
DocumentCollectionall()
public
all(Closure $rule) : bool
Parameters
- $rule : Closure
Return values
boolany()
public
any(Closure $rule) : bool
Parameters
- $rule : Closure
Return values
boolclear()
public
clear() : DocumentCollection
Return values
DocumentCollectioncount()
public
count() : int
Return values
intcurrent()
public
current() : Document|null
Return values
Document|nullfilter()
public
filter(Closure $rule) : DocumentCollection
Parameters
- $rule : Closure
Return values
DocumentCollectionfindByTemplateId()
public
findByTemplateId(int|null $id) : Document|null
Parameters
- $id : int|null
Return values
Document|nullgetArrayByIds()
Get array with keys - values of id field
public
getArrayByIds() : array<int, Document>
Return values
array<int, Document>getByEntityId()
public
getByEntityId(int $entityId) : Document|null
Parameters
- $entityId : int
Return values
Document|nullgetById()
public
getById(int $id) : Document|null
Parameters
- $id : int
Return values
Document|nullgetFirst()
public
getFirst() : Document|null
Return values
Document|nullisEmpty()
public
isEmpty() : bool
Return values
boolkey()
public
key() : int
Return values
intlistIdsWithoutNull()
public
listIdsWithoutNull() : array<int, int>
Return values
array<int, int>next()
public
next() : void
rewind()
public
rewind() : void
sortByTemplateIdsDesc()
public
sortByTemplateIdsDesc() : static
Return values
statictoArray()
public
toArray() : array<string|int, T>
Return values
array<string|int, T>valid()
public
valid() : bool