An interface for organizing items into collections. More...
Public Member Functions | |
| all () | |
| Returns all collection items by reference. More... | |
| count () | |
| Count collection items. More... | |
| add ($item) | |
| Add a new item to collection. More... | |
| get ($id) | |
| Get an item by its ID. More... | |
| has ($id) | |
| Check if collection has an item with a given ID. More... | |
| remove ($id) | |
| Remove item from collection by its ID. More... | |
| fill ($items) | |
| Replace collection items. More... | |
| merge ($items) | |
| Add new items to collection, replacing items with matching IDs. More... | |
| filter (?callable $callback=null) | |
| Filter collection items using a custom filter Returns a new collection instance. More... | |
| sort (?callable $callback=null) | |
| Sort fields using custom callable If not provided, will sort items by priority. More... | |
| walk (callable $callback) | |
| Walk through members of the collection and apply a callback. More... | |
| map (callable $callback) | |
| Walk through all items in the collection and apply a callback. More... | |
Detailed Description
An interface for organizing items into collections.
Definition at line 8 of file CollectionInterface.php.
Member Function Documentation
◆ add()
| Elgg\Collections\CollectionInterface::add | ( | $item | ) |
Add a new item to collection.
- Parameters
-
CollectionItemInterface $item Item
- Returns
- static
Implemented in Elgg\Collections\Collection.
◆ all()
| Elgg\Collections\CollectionInterface::all | ( | ) |
Returns all collection items by reference.
- Returns
- CollectionItemInterface[]
Implemented in Elgg\Collections\Collection.
◆ count()
| Elgg\Collections\CollectionInterface::count | ( | ) |
◆ fill()
| Elgg\Collections\CollectionInterface::fill | ( | $items | ) |
Replace collection items.
- Parameters
-
CollectionItemInterface[] | Collection $items Items
- Returns
- static
Implemented in Elgg\Collections\Collection.
◆ filter()
| Elgg\Collections\CollectionInterface::filter | ( | ?callable | $callback = null | ) |
Filter collection items using a custom filter Returns a new collection instance.
- Parameters
-
null | callable $callback Filter
- Returns
- static
Implemented in Elgg\Collections\Collection.
◆ get()
| Elgg\Collections\CollectionInterface::get | ( | $id | ) |
Get an item by its ID.
- Parameters
-
string | int $id ID
- Returns
- CollectionItemInterface|null
Implemented in Elgg\Collections\Collection.
◆ has()
| Elgg\Collections\CollectionInterface::has | ( | $id | ) |
Check if collection has an item with a given ID.
- Parameters
-
string | int $id ID
- Returns
- bool
Implemented in Elgg\Collections\Collection.
◆ map()
| Elgg\Collections\CollectionInterface::map | ( | callable | $callback | ) |
Walk through all items in the collection and apply a callback.
- Parameters
-
callable $callback Mapper
- Returns
- mixed
Implemented in Elgg\Collections\Collection.
◆ merge()
| Elgg\Collections\CollectionInterface::merge | ( | $items | ) |
Add new items to collection, replacing items with matching IDs.
- Parameters
-
CollectionItemInterface[] | Collection $items Items
- Returns
- static
Implemented in Elgg\Collections\Collection.
◆ remove()
| Elgg\Collections\CollectionInterface::remove | ( | $id | ) |
Remove item from collection by its ID.
- Parameters
-
string | int $id ID
- Returns
- static
Implemented in Elgg\Collections\Collection.
◆ sort()
| Elgg\Collections\CollectionInterface::sort | ( | ?callable | $callback = null | ) |
Sort fields using custom callable If not provided, will sort items by priority.
- Parameters
-
null | callable $callback Sorter
- Returns
- static
Implemented in Elgg\Collections\Collection.
◆ walk()
| Elgg\Collections\CollectionInterface::walk | ( | callable | $callback | ) |
Walk through members of the collection and apply a callback.
Unlike CollectionInterface::map(), this method does not return the result of mapping, rather returns the exact same instance of the collection after walking through its members by reference
- See also
- CollectionInterface::map()
- Parameters
-
callable $callback Callback function
- Returns
- static
Implemented in Elgg\Collections\Collection.
The documentation for this interface was generated from the following file:
- engine/classes/Elgg/Collections/CollectionInterface.php
