Add Collection ids macro

[Anubarak]

Really simple:
similar to

https://github.com/craftcms/cms/blob/develop/src/base/ApplicationTrait.php#L1443

Collection::macro('one', function() {
    /** @var Collection $this */
    return $this->first(...func_get_args());
});

it would be awesome to have a ids macro as well...
for example with the ArrayHelper to ensure compatibility with non Elements

Collection::macro('ids', function() {
    /** @var Collection $this */
    return ArrayHelper::getColumn($this->all(), 'id');
});

The less if $object instanceof Collection checks wee need, the better

[brandonkelly]

Made this possible for Craft 4.3 via #12140.

Little more complicated than adding a new macro since we can’t assume every collection is going to contain items that have an id key/property.

Instead I added a new craft\elements\ElementCollection class, which ElementQuery::collect() and Element::getEagerLoadedElements() return instead of Collection.

Also went ahead and gave ElementCollection a with() method as well, so it’s now possible to eager-load nested elements after the fact, rather than having to specify everything before the element query is executed.

[brandonkelly]

Craft 4.3 was released earlier this week with those changes!

[gglnx]

@brandonkelly I think one() is missing too?

Slightly related (because I'm working with phpstan): the Assets field generates a wrong valueType() signature: In \craft\elements\db\AssetQuery|\craft\elements\ElementCollection<craft\elements\Asset> it's missing a leading backlash for the ElementCollection generic (resolving to: craft\elements\db\AssetQuery|(craft\elements\ElementCollection&iterable<craft\behaviors\craft\elements\Asset>) in phpstan). Should I open an issue for that?

[brandonkelly]

All collections have a one() macro that calls first() internally:

cms/src/base/ApplicationTrait.php

Lines 1459 to 1463 in bb51407

	// Register Collection::one() as an alias of first(), for consistency with yii\db\Query.
	Collection::macro('one', function() {
	/** @var Collection $this */
	return $this->first(...func_get_args());
	});

That property type bug has been fixed for the next release (3f8a5d6). Please post any additional things you come across as new issues – thanks!

[gglnx]

@brandonkelly Maybe move it to ElementCollection (without the macro magic) or add an @method to ElementCollection so phpstan catches it? That would be great.

[brandonkelly]

Done (17fdc2a).