[12.x] Extends `AsCollection` to map items into objects or other values #55383

DarkGhostHunter · 2025-04-13T00:01:55Z

What?

Rework of #55377. This extends AsCollection and AsEncryptedCollection to accept a class to map each item into, or a callable as [class, method] or class@method notation, without or without a custom collection class.

For example, I expect the most common to be using the map() static method to set a Class to map each item into, using the base Collection class.

use Illuminate\Database\Eloquent\Casts\AsCollection;
use Illuminate\Support\Fluent;

public function casts()
{
    return [
        'colors' => AsCollection::map(Fluent::class)
    ];
}

// Same as
Collection::make($this->attributes['colors'])->mapInto(Fluent::class);

If the developer sets an array callable, it gets normalized into class@method notation.

use Illuminate\Database\Eloquent\Casts\AsCollection;
use App\ValueObject\Color;

public function casts()
{
    return [
        'colors' => AsCollection::map([Color::class, 'make']),
    ];
}

// Same as
Collection::make($this->attributes['colors'])->map([Color::class, 'make']);

If the developer wants to use a custom Collection class, the using() can be used with a second parameter and either a class or array callable / class@method.

return [
    'colors' => AsCollection::using(CustomCollection::class, [Color::class, 'make']),
];

// Same as
CustomCollection::make($this->attributes['colors'])->map([Color::class, 'make']);

Caution

Because the nature of the casts declaration, there is no support to using a Closure. The developer can use castUsing() directly with a Closure if desired.

This logic is also extended to the AsEncryptedCollection class, which works in the same way.

use Illuminate\Database\Eloquent\Casts\AsEncryptedCollection;
use App\ValueObject\Color;

public function casts()
{
    return [
        'colors' => AsEncryptedCollection::map([Color::class, 'make']), 
    ];
}

As part of [#55383](laravel/framework#55383).

DarkGhostHunter · 2025-04-14T18:43:15Z

Does make more sense lexically to use of() rather than map()?

AsCollection::of(Option::class);

AsCollection::of([Option::class, 'make']);

shaedrich · 2025-04-15T07:01:10Z

Does make more sense lexically to use of() rather than map()?

While I think, map() might imply something being mapped on the spot rather than just being assigned and mapped later, of() reads like the first parameter is the actual raw iterable/arrayable being passed to the constructor 🤔

But you raise a good point here. Maybe, it could be something along the lines of mapUsing() or withMapping()/withMapper()

DarkGhostHunter · 2025-04-15T07:03:32Z

Does make more sense lexically to use of() rather than map()?

While I think, map() might imply something being mapped on the spot rather than just being assigned and mapped later, of() reads like the first parameter is the actual raw iterable/arrayable being passed to the constructor 🤔

But you raise a good point here. Maybe, it could be something along the lines of mapUsing() or withMapping()/withMapper()

What about ofItems() (for classes) and ofMap() (for callables)?

shaedrich · 2025-04-15T07:08:59Z

Does make more sense lexically to use of() rather than map()?

While I think, map() might imply something being mapped on the spot rather than just being assigned and mapped later, of() reads like the first parameter is the actual raw iterable/arrayable being passed to the constructor 🤔
But you raise a good point here. Maybe, it could be something along the lines of mapUsing() or withMapping()/withMapper()

What about ofItems() (for classes) and ofMap() (for callables)?

To me, ofItems() would have pretty much the same implication as of, however, ofMap() might work 👍🏻

mathieutu · 2025-04-20T10:19:25Z

This is brilliant, thanks @DarkGhostHunter! I need that right now, and was making a small research before working on to for a PR.

* Adds `AsColection::map()` section As part of [#55383](laravel/framework#55383). * Added more clarification * More clarification * Update eloquent-mutators.md Co-authored-by: Sebastian Hädrich <11225821+shaedrich@users.noreply.github.com> * Adds openinh PHP on full class * Better, almost final, clarification. * Minor change to the Option example so it makes sense * Better clarification about serialization * formatting --------- Co-authored-by: Sebastian Hädrich <11225821+shaedrich@users.noreply.github.com> Co-authored-by: Taylor Otwell <taylor@laravel.com>

DarkGhostHunter mentioned this pull request Apr 13, 2025

[12.x] Adds Cast to Collect into classes or callback #55377

Closed

[12.x] Extends AsCollection for map

4d31559

DarkGhostHunter force-pushed the feat/12.x/as-collection-map branch from fd91472 to 4d31559 Compare April 13, 2025 00:06

DarkGhostHunter added a commit to DarkGhostHunter/laravel-docs that referenced this pull request Apr 13, 2025

Adds AsColection::map() section

34f6140

As part of [#55383](laravel/framework#55383).

DarkGhostHunter mentioned this pull request Apr 13, 2025

Adds AsColection::map() section laravel/docs#10327

Merged

DarkGhostHunter changed the title ~~[12.x] Extends AsCollection for map~~ [12.x] Extends AsCollection to map items into objects or other values Apr 14, 2025

taylorotwell added 2 commits April 18, 2025 12:09

formatting

41d5dbe

fix signature

2c15ae3

taylorotwell merged commit 60125ea into laravel:12.x Apr 18, 2025
58 checks passed

Diegslapasteque mentioned this pull request Apr 30, 2025

[12.x] Extends AsCollection to map through a closure #55611

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[12.x] Extends `AsCollection` to map items into objects or other values #55383

[12.x] Extends `AsCollection` to map items into objects or other values #55383

DarkGhostHunter commented Apr 13, 2025 •

edited

Loading

DarkGhostHunter commented Apr 14, 2025

shaedrich commented Apr 15, 2025

DarkGhostHunter commented Apr 15, 2025

shaedrich commented Apr 15, 2025

mathieutu commented Apr 20, 2025

[12.x] Extends AsCollection to map items into objects or other values #55383

[12.x] Extends AsCollection to map items into objects or other values #55383

Conversation

DarkGhostHunter commented Apr 13, 2025 • edited Loading

What?

DarkGhostHunter commented Apr 14, 2025

shaedrich commented Apr 15, 2025

DarkGhostHunter commented Apr 15, 2025

shaedrich commented Apr 15, 2025

mathieutu commented Apr 20, 2025

[12.x] Extends `AsCollection` to map items into objects or other values #55383

[12.x] Extends `AsCollection` to map items into objects or other values #55383

DarkGhostHunter commented Apr 13, 2025 •

edited

Loading