Collection

Push a foundry\model object onto the stack

Remove and return the last object in the stack

Return the last model on the stack, but don't remove it

Allows the collection to behave somewhat like a query operation.

Mostly allows you to call first() on a findby operation:

$section = M::init('section')->findBySlug('foo')->first()

Push a foundry\model object into the front of the stack

Remove and return the first item from the stack

Return, but don't remove, the first item on the stack

Return the number of objects in the stack. Can also be accessed as a property

> echo $collection->length(); // 3
> echo $collection->length; // 3

Alias for length, implementation for Countable interface

Sort a collection by an item property

Merges two collections together. If you pass a second argument it attempts to sort it via that property (both models must have that property).

    > $coll->merge($other, 'foo', \foundry\collection\SORT_REVERSE);

Flattens the collection into a single property array This is useful for returning elements for an auto complete search system implemented via AJAX

$authors = _M( 'authors' )->find( ... );
return $authors->splat( 'name' );
// returns array( 'Author One', 'Author Two' );

return $authors->splat('name', 'uid');
// array( '1234' => 'Author One', '5678' => 'Author Two');

Grab all the models whose property matches the passed value

$authors = $allAuthors->grab('status', 1);
// grabs all the objects with a status of '1'