Laravel json field cast

Cast json field to custom object. Compatible with Laravel 9, 10, and 11.

Requirements

• PHP: ^8.1|^8.2
• Laravel: ^9.0|^10.0|^11.0

Installation

Install the package via composer:

composer require think.studio/laravel-json-field-cast

Usage

Out of the box

Cast json column to single object

/**
 *  @property \JsonFieldCast\Json\SimpleJsonField $json_meta
 *  @property \JsonFieldCast\Json\SimpleJsonField $text_meta
 */
class MyModel extends Model
{
    // Laravel 9/10/11 approach with $casts property
    protected $casts = [
        //...
        'json_meta'              => \JsonFieldCast\Casts\SimpleJsonField::class,
        'text_meta'              => \JsonFieldCast\Casts\SimpleJsonField::class,
    ];
    
    // Alternative Laravel 11+ approach with casts() method
    protected function casts(): array
    {
        return [
            //...
            'json_meta'              => \JsonFieldCast\Casts\SimpleJsonField::class,
            'text_meta'              => \JsonFieldCast\Casts\SimpleJsonField::class,
        ];
    }
}


$myModel = MyModel::find(123);
$myModel->json_meta->getAttribute('example', 'default');
$myModel->json_meta->getAttribute('my_array.3',);
$myModel->json_meta->getAttribute('my_array.test');
$myModel->json_meta->setAttribute('position', 'developer');
$myModel->json_meta->removeAttribute('position');
$myModel->json_meta->hasAttribute('position');
$myModel->json_meta->getRawData(['position', 'my_array']);

$myModel->json_meta->setDate('my-date', \Carbon\Carbon::now());
$myModel->json_meta->setDate('my-date', \Carbon\Carbon::now(), 'd/m/y');
$myModel->json_meta->setNow('my-date', 'd/m/y');
$myModel->json_meta->getDateAttribute('my-date'); // Carbon::parse()
$myModel->json_meta->getDateTimeFromFormat('my-date', 'd/m/y');
$myModel->json_meta->getDateTimeFromFormats('my-date', ['d/m/y', 'd/m/Y', 'Y-m-d']);

$myModel->json_meta->inscremt('login_count');
$myModel->json_meta->decrement('allowed_attempts');

$myModel->json_meta->toMorph('user', $user);
$user = $myModel->json_meta->fromMorph('user');

Cast json column to array of objects

/**
 *  @property \JsonFieldCast\Json\ArrayOfJsonObjectsField $array_json_meta
 *  @property \JsonFieldCast\Json\ArrayOfJsonObjectsField $array_text_meta
 */
class MyModel extends Model
{
    // Laravel 9/10/11 approach with $casts property
    protected $casts = [
        //...
        'array_json_meta'        => \JsonFieldCast\Casts\ArrayOfJsonObjectsField::class,
        'array_text_meta'        => \JsonFieldCast\Casts\ArrayOfJsonObjectsField::class,
    ];
    
    // Alternative Laravel 11+ approach with casts() method
    protected function casts(): array
    {
        return [
            //...
            'array_json_meta'        => \JsonFieldCast\Casts\ArrayOfJsonObjectsField::class,
            'array_text_meta'        => \JsonFieldCast\Casts\ArrayOfJsonObjectsField::class,
        ];
    }
}


$myModel = MyModel::find(123);

isset($myModel->array_json_meta[2]);

/** @var \JsonFieldCast\Json\JsonObject $item */
foreach ($myModel->array_json_meta as $item) {
    $name = $item->getAttribute('name');
    $date = $item->getDateTimeFromFormat('my-date', 'd/m/y');
}

Custom castable objects

For your custom purposes you can use your own custom castable objects

namespace App\Casts;

use JsonFieldCast\Casts\AbstractMeta;

class FormMeta extends AbstractMeta
{
    protected function metaClass(): string
    {
        return \App\Casts\Json\FormMeta::class;
    }
}

namespace App\Casts\Json;

use JsonFieldCast\Json\AbstractMeta;

class FormMeta extends AbstractMeta
{
    public function myCustomMethod(): int {
        return ((int) $this->getAttribute('foo.bar', 0)) + 25;
    }
}

/**
 *  @property \App\Casts\Json\FormMeta $meta
 */
class Form extends Model
{
    // Laravel 9/10/11 approach with $casts property
    protected $casts = [
        'meta' => \App\Casts\FormMeta::class,
    ];
    
    // Alternative Laravel 11+ approach with casts() method
    protected function casts(): array
    {
        return [
            'meta' => \App\Casts\FormMeta::class,
        ];
    }
}


$form = Form::find(123);
$form->meta->getAttribute('foo.bar', 0);
$form->meta->myCustomMethod();

Dynamic castable objects

namespace App\Casts;

use JsonFieldCast\Casts\AbstractMeta;

class FormMeta extends AbstractMeta
{
    protected function metaClass(): string
    {
        return \App\Casts\Json\AbstractFormMeta::class;
    }
}

namespace App\Casts\Json;

use JsonFieldCast\Json\AbstractMeta;

abstract class AbstractFormMeta extends AbstractMeta
{
   public static function getCastableClassByModel(Model $model, array $data = []): ?string
    {
        return ($model->meta_type && class_exists($model->meta_type))
            ? $model->meta_type
            : null;;
    }
}

/**
 *  @property \App\Casts\Json\AbstractFormMeta $meta
 */
class Form extends Model
{
    // Laravel 9/10/11 approach with $casts property
    protected $casts = [
        'meta' => \App\Casts\FormMeta::class,
    ];
    
    // Alternative Laravel 11+ approach with casts() method
    protected function casts(): array
    {
        return [
            'meta' => \App\Casts\FormMeta::class,
        ];
    }
}


$formContactUs = Form::create([
    //...
    'meta_type' => ContactUsMeta::class
]);
$formJobRequest = Form::create([
    //...
    'meta_type' => JobRequestMeta::class
]);

$formContactUs->meta instanceof ContactUsMeta::class // true
$formJobRequest->meta instanceof JobRequestMeta::class // true

Credits