README

This package converts the level one json column keys to the attributes of the model whenever the data is retrieved from the database using eloquent. It works only on retrieval.

Installation

You can install the package via composer:

composer require pratikkuikel/wasabi

Usage

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Pratikkuikel\Wasabi\Traits\Wasabi;

class State extends Model
{
    use HasFactory;
    use Wasabi;

    protected $guarded = [];

    protected $casts = [
        'data' => 'array'
    ];

    // OR
    // protected $casts = [
    //     'custom_field' => 'array'
    // ];

    // you don't need to define the constructor to use the default `data` field
    public function __construct(array $attributes = [])
    {
    // set wasabi's status false based on some condtions
        if($condition)
        {
         static::setWasabiStatus(true);
        }

    // Override the default dataField with any other preferred name
         static::setDataField('custom_field');

    // construct parent after setting data and status
         parent::__construct($attributes);
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

pratikkuikel / wasabi

Maintainers

Details