Collections

Simple Example

The collection class is a list-style container for composite datatypes that adds more utility than storing them in a simple PHP array. It can store both arrays and objects:

use ExpressionEngine\Library\Data\Collection;

$collection = new Collection(array(
  array('name' => 'Anne', 'age' => 47),
  array('name' => 'Bob', 'age' => 32),
  array('name' => 'Julie', 'age' => 14),
  array('name' => 'Jack', 'age' => 86)
));

$collection->count(); // 4
$collection->first(); // Anne's array

$sorted = $collection->sortBy('age');
$sorted->first(); // Julie's array

For basic interactions a collection can be treated as a regular array:

foreach ($collection as $person)
{
  echo $person['age']; // or $person->age if your collection contains objects
}

$collection[] = array('name' => 'Savannah', 27);

Note: Indices are always uninterrupted numeric sequences starting at 0. Do not use string keys.

Method Reference

class ExpressionEngine\Library\Data\Collection

asArray()

Turn the collection into an array

first()

Get the first element in the collection

last()

Get the last element in the collection

pluck($key)

Extract a value from all elements of the collection

collect($collector)

Extract a value from all elements of the collection using a keyname or callback.

sortBy($column, $flags = SORT_REGULAR)

Sort a collection by a certain element key. Returns a new collection.

reverse()

Reverse the elements in the collection. Returns a new collection.

indexBy($extractor)

Return an associative array of all items indexed by a given element.

It is up to you to ensure that the index keys are unique. If $extractor is a closure it will be passed each element in the collection and should return the value to use.

getDictionary($key, $value)

Return a key-value array composed of two items in each collection element.

It is up to you to ensure that the index keys are unique.

map($callback)

Applies the given callback to the collection and returns an array of the results.

filter($callback)

Filter elements of a collection using a callback function. If the callback returns TRUE the current value from the collection is returned in the result Collection.

each($callback)

Iterates over all the elements in the Collection and passes them to them to the Callback one at a time.

removeElement($model)

Removes an element from the Collection and returns the reduced Collection.

Note: This is a handy way to correct for an issue with the EE Model search method which performs %search_term% searches rather than literal searches, so you get back all the records that contain the search term in the nominated field rather than those that match the search term. For example, if $collection is a Collection object, this code removes any elements that fail to meet a conditional test - so if it had 100 elements to begin with and 5 fail the test, after the code $collection->count() will return 95:

foreach($collection as $element) {
    if($element->field != 'reference_value') {
        $collection->removeElement($element);
    }
}

count()

Count the elements in the Collection

---

ExpressionEngine 6 Docs
©2002–2024 Packet Tide,LLC. Edit this page