Laravel Tutorials

Transform JSON into Typed Collections with Laravel's AsCollection::of()

Published
Transform JSON into Typed Collections with Laravel's AsCollection::of() image

Laravel enhances data handling capabilities with the AsCollection::of() method, enabling developers to transform JSON columns into strongly-typed collections of value objects automatically. This feature brings structure and maintainability to complex data storage scenarios.

Working with complex data structures in Laravel often requires storing information in JSON columns, but dealing with raw arrays can create messy, difficult-to-maintain code. The AsCollection::of() method addresses this challenge by casting JSON data into properly typed collections:

use App\ValueObjects\Setting;
use Illuminate\Database\Eloquent\Casts\AsCollection;
 
protected function casts(): array
{
return [
'settings' => AsCollection::of(Setting::class)
];
}

This casting automatically transforms your JSON column into a collection of your specified class instances, equivalent to:

Collection::make($this->attributes['settings'])->mapInto(Setting::class);

The transformation occurs automatically when Laravel hydrates your model from the database, providing type safety and encapsulation without additional effort.

Consider building a content management system where articles have multiple configuration settings. Each setting contains a key, value, and visibility flag:

namespace App\ValueObjects;
 
use Illuminate\Contracts\Support\Arrayable;
use JsonSerializable;
 
class ArticleSetting implements Arrayable, JsonSerializable
{
public function __construct(
public readonly string $key,
public readonly string $value,
public readonly bool $isPublic = false
) {}
 
public function toArray()
{
return [
'key' => $this->key,
'value' => $this->value,
'is_public' => $this->isPublic,
];
}
 
public function jsonSerialize(): mixed
{
return $this->toArray();
}
 
public function isVisibleToGuests(): bool
{
return $this->isPublic && !empty($this->value);
}
}

In your Article model, apply the AsCollection::of() cast:

namespace App\Models;
 
use App\ValueObjects\ArticleSetting;
use Illuminate\Database\Eloquent\Casts\AsCollection;
use Illuminate\Database\Eloquent\Model;
 
class Article extends Model
{
protected function casts(): array
{
return [
'settings' => AsCollection::of(ArticleSetting::class)
];
}
 
public function getPublicSettingsAttribute()
{
return $this->settings->filter(fn ($setting) => $setting->isPublic);
}
}

Now you can work with article settings as first-class objects:

$article = Article::find(1);
 
// Get all settings as ArticleSetting objects
$allSettings = $article->settings;
 
// Filter using methods on your value object
$visibleSettings = $article->settings->filter(fn ($setting) => $setting->isVisibleToGuests());
 
// Add a new setting (automatically serialized back to JSON)
$article->settings->push(new ArticleSetting('author_display', 'John Doe', true));
$article->save();

This approach excels in scenarios like user preferences, application configurations, survey responses, feature toggles with metadata, or any situation requiring structured data with consistent patterns.

Harris Raftopoulos photo

Senior Software Engineer • Staff & Educator @ Laravel News • Co-organizer @ Laravel Greece Meetup

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
Building EasyReply: How We Used Laravel to Unify Customer Support image

Building EasyReply: How We Used Laravel to Unify Customer Support

Read article
PostgreSQL Monitoring and Schema Linting for Laravel with Vacuum image

PostgreSQL Monitoring and Schema Linting for Laravel with Vacuum

Read article
PayZephyr: One Payment API for Stripe, Paystack, and PayPal image

PayZephyr: One Payment API for Stripe, Paystack, and PayPal

Read article
Bifrost Turns One With AI Builds and New Workflows image

Bifrost Turns One With AI Builds and New Workflows

Read article
Preview Blade Templates in macOS Finder with Quick Blade image

Preview Blade Templates in macOS Finder with Quick Blade

Read article
Artisan Debugging Commands in Laravel Telescope 5.24.0 image

Artisan Debugging Commands in Laravel Telescope 5.24.0

Read article