Laravel Custom Casts Package

Packages

August 23rd, 2019

The Laravel Custom Casts package by Vladimir Ković enables you to make your own custom cast types in Eloquent models:

Laravel custom casts works similarly to Laravel attribute casting, but with our custom defined logic (in separated class). Beside casting to our complex types, this package gives us the ability to listen and react to underlying model events.

Here’s an example model utilizing a custom cast class:

namespace App;

use App\CustomCasts\NameCast;
use Illuminate\Database\Eloquent\Model;
use Vkovic\LaravelCustomCasts\HasCustomCasts;

class User extends Model
{
    use HasCustomCasts;

    protected $casts = [
        'is_admin' => boolean // <-- Laravel default cast type
        'name' => NameCast::class // <-- Our custom cast class (follow section below)
    ];
}

With the above model in mind, here’s an example of the custom cast class:

namespace App\CustomCasts;

use Vkovic\LaravelCustomCasts\CustomCastBase;

class NameCast extends CustomCastBase
{
    public function setAttribute($value)
    {
        return ucwords($value);
    }

    public function castAttribute($value)
    {
        return $this->getTitle() . ' ' . $value;
    }

    protected function getTitle()
    {
        return ['Mr.', 'Mrs.', 'Ms.', 'Miss'][rand(0, 3)];
    }
}

The $value in the setAttribute() method is the raw database value we want to store. This package also enables you to handle model events and react to those events.

You can learn more about this package, get full installation instructions, and view the source code on GitHub at vkovic/laravel-custom-casts.

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.