Laravel Castable Data Transfer Object

Published on by

Laravel Castable Data Transfer Object image

Laravel Castable Data Transfer Object is a package by Jess Archer for casting JSON columns in the database to a value object. This package expands on Spatie’s data-transfer-object package with the CastableDataTransferObject class, which implements Laravel’s “castable” interface using custom Eloquent cast types (added in Laravel 7).

Here’s an example of what an address object from a JSON column might look like as a castable object:

namespace App\Values;
 
use JessArcher\CastableDataTransferObject\CastableDataTransferObject;
 
class Address extends CastableDataTransferObject
{
public string $street;
public string $suburb;
public string $state;
}

When combined with a model’s casts, you can configure it like so:

namespace App\Models;
 
use App\Values\Address;
use Illuminate\Database\Eloquent\Model;
 
class User extends Model
{
protected $casts = [
'address' => Address::class,
];
}

According to the project’s readme, the above is all you need to start transferring data in and out of the JSON column:

You can now pass either an instance of your Address class or even just an array with a compatible structure. It will automatically be cast between your class and JSON for storage, and the data will be validated on the way in and out.

One benefit of using a Value object is that you can define custom methods around the cast, meaning you can do cool things like implementing the __toString() method or a custom helper:

// Custom helper method
$user->address->getCoordinates();
 
// Convert to a string
echo (string) $user->address;

Learn More

You can learn more about this package, get full installation instructions, and view the source code on GitHub. Jess goes into further detail on her blog about the ideas behind this package with more information about how it works under the hood.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Filed in:
Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project.

Visit No Compromises
Laravel Forge logo

Laravel Forge

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

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
LoadForge logo

LoadForge

Easy, affordable load testing and stress tests for websites, APIs and databases.

LoadForge
Paragraph logo

Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Paragraph
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
Bacancy - Staff Augmentation logo

Bacancy - Staff Augmentation

Leave your web app development hustles to the leading IT Staff Augmentation Service Providers. Choose from an extensive pool of 1050+ developers and give yourself the sigh of success you deserve with Bacancy. Get In Touch Today!

Bacancy - Staff Augmentation
DocuWriter.ai logo

DocuWriter.ai

Save hours of manually writing Code Documentation, Comments & DocBlocks, Test suites and Refactoring.

DocuWriter.ai
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
October CMS v3.6 Ships Today, Full of New Features image

October CMS v3.6 Ships Today, Full of New Features

Read article
Laracon EU Videos are now out image

Laracon EU Videos are now out

Read article
Use Google's Gemini AI in Laravel image

Use Google's Gemini AI in Laravel

Read article
PhpStorm is getting a brand new terminal image

PhpStorm is getting a brand new terminal

Read article
Six Essential Plugins for Visual Studio Code image

Six Essential Plugins for Visual Studio Code

Read article
Modularize Your Laravel Application With the Modular Package image

Modularize Your Laravel Application With the Modular Package

Read article