gregoriohc/laravel-castable

Laravel package that adds custom casts for models attributes

Laravel Castable

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Laravel package that adds custom casts for models attributes., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require gregoriohc/laravel-castable, <sub>(*4)</sub>

In Laravel 5.5 the package will autoregister the service provider. In Laravel 5.4 and before you must install this service provider.

``` php
// config/app.php
'providers' => [
    ...
    Gregoriohc\Castable\ServiceProvider::class,
    ...
];

Usage

With Castable base model

The fastest way is using \Gregoriohc\Castable\CustomCastableModel as your base model., <sub>(*5)</sub>

Without Castable base model

Add HasCustomCasts trait to your the model you want to add custom attribute casting (if you want to use it in all your models, I suggest adding it to your own base model)., <sub>(*6)</sub>

Override castAttribute model method:, <sub>(*7)</sub>

``` php protected function castAttribute($key, $value) { return $this->customCastAttribute($key, parent::castAttribute($key, $value)); }, <sub>(*8)</sub>

Override `setAttribute` model method:

``` php
public function setAttribute($key, $value)
{
    return parent::setAttribute($key, $value)->customSetAttribute($key, $value);
}

Override toArray model method:, <sub>(*9)</sub>

``` php public function toArray() { return $this->customToArray(parent::toArray()); }, <sub>(*10)</sub>

Add custom casted attributes to the model casts array:

``` php
protected $casts = [
    'location' => 'point',
    'bounding_box' => 'multipoint',
];

A full model example would look like this:, <sub>(*11)</sub>

``` php namespace App\Models;, <sub>(*12)</sub>

use Gregoriohc\Castable\HasCustomCasts;, <sub>(*13)</sub>

class Place extends \Illuminate\Database\Eloquent\Model { use HasCustomCasts;, <sub>(*14)</sub>

protected $casts = [
    'location' => 'point',
    'bounding_box' => 'multipoint',
];

protected function castAttribute($key, $value)
{
    return $this->customCastAttribute($key, parent::castAttribute($key, $value));
}

public function setAttribute($key, $value)
{
    return parent::setAttribute($key, $value)->customSetAttribute($key, $value);
}

public function toArray()
{
    return $this->customToArray(parent::toArray());
}

}, <sub>(*15)</sub>

### Attribute migration, setting and getting

Depending on the custom caster, the attribute will accept and return different values when setting/getting. Also, the required database migration type will differ. For the included casters, you can see the doc in the caster class file.

For example, for the point caster requires a `Point` database migration type, and to set its value you can do the following:

``` php
$place->location = [12.345, 67.890];

Configuration

You can optionally publish the config file with:, <sub>(*16)</sub>

``` bash $ php artisan vendor:publish --provider="Gregoriohc\Castable\ServiceProvider" --tag="config", <sub>(*17)</sub>

### Creating a custom caster

You can create a custom caster extending the `\Gregoriohc\Castable\Casters\Caster` class and implementing `as` and `from` methods. For example:

``` php
namespace \App\Casters;

class SerializableObject extends \Gregoriohc\Castable\Casters\Caster
{
    public function as($value)
    {
        return unserialize($value);
    }

    public function from($value)
    {
        return serialize($value);
    }
}

The as method must transform the raw attribute value (from the database or internal) to the usable model attribute, and the from method must do the opposite thing., <sub>(*18)</sub>

After that, add the custom caster to the config file:, <sub>(*19)</sub>

``` php // config/castable.php 'casters' => [ ... 'serializable' => \App\Casters\SerializableObject::class, ... ];, <sub>(*20)</sub>

## Testing

``` bash
$ composer test

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*21)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*22)</sub>

Security

If you discover any security related issues, please email gregoriohc@gmail.com instead of using the issue tracker., <sub>(*23)</sub>

Socialware

You're free to use this package, but if it makes it to your production environment I highly appreciate you sharing it on any social network., <sub>(*24)</sub>

Credits

• Gregorio Hernández Caso
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*25)</sub>