Collections

[brandonkelly]

Description

• Adds the Illuminate Collections package
• Adds craft\db\Query::collect(), which returns the query results as a Collection
• Modifies Element::getEagerLoadedElements() to return eager-loaded elements as a Collection

As a result, templates now have a consistent way of interacting with elements, whether they were eager-loaded or queried directly: templates can just call collect() rather than all(). collect() will either end up referring to Illuminate\Support\Collection::collect() (if eager-loaded) or craft\db\Query::collect() (if not).

(Templates which are already looping over eager-loaded element arrays won’t break, because Illuminate\Support\Collection objects are traversable.)

Related issues & discussions

• Consider using Laravel Collections #8475
• [Feature Request] Eager-loaded collections should use the same API as non-eager-loaded ones #8513

[linear]

DEV-65 Integrate Collections library

https://laravel.com/docs/8.x/collections

https://packagist.org/packages/illuminate/collections

[michaelrog]

Curiously... why not have all() return a Collection? (except when asArray() is used)

[brandonkelly]

Because I don’t want to deviate from the yii\db\Query::all() return type.

[michaelrog]

Curiously... why not have all() return a Collection? (except when asArray() is used)

In retrospect, this was a silly question, since all() is also a Collection method that returns the underlying array... So yeah, good call.

query.all().all() would get awkward.