README

___  ___          _      _ _____      _
|  \/  |         | |    | /  ___|    | |
| .  . | ___   __| | ___| \ `--.  ___| |__   ___ _ __ ___   __ _
| |\/| |/ _ \ / _` |/ _ \ |`--. \/ __| '_ \ / _ \ '_ ` _ \ / _` |
| |  | | (_) | (_| |  __/ /\__/ / (__| | | |  __/ | | | | | (_| |
\_|  |_/\___/ \__,_|\___|_\____/ \___|_| |_|\___|_| |_| |_|\__,_|

Combines the casts, fillable, and hidden properties into a single schema array property amongst other features.

Other features include:

Custom configuration entries against your model attributes.
Store your attribute rules against your model and store and validate your model data automatically.
Custom casting is now possible using this package! See Custom casts.

This package has been developed by H&H|Digital, an Australian botique developer. Visit us at hnh.digital.

Prerequisites

PHP >= 8.0.2
Laravel >= 9.0

Installation

Via composer:

$ composer require hnhdigital-os/laravel-model-schema ~3.0

Configuration

Enable the model

Enable the model on any given model.

use HnhDigital\ModelSchema\Model;

class SomeModel extends Model
{

}

We recommend implementing a shared base model that you extend.

Convert your current properties

The schema for a model is implemented using a protected property.

Here's an example:

    /**
     * Describe your model.
     *
     * @var array
     */
    protected static $schema = [
        'id' => [
            'cast'    => 'integer',
            'guarded' => true,
        ],
        'name' => [
            'cast'     => 'string',
            'rules'    => 'max:255',
            'fillable' => true,
        ],
        'created_at' => [
            'cast'    => 'datetime',
            'guarded' => true,
            'log'     => false,
            'hidden'  => true,
        ],
        'updated_at' => [
            'cast'    => 'datetime',
            'guarded' => true,
            'hidden'  => true,
        ],
        'deleted_at' => [
            'cast'    => 'datetime',
            'rules'  => 'nullable',
            'hidden'  => true,
        ],
    ];

Ensure the parent boot occurs after your triggers so that any attribute changes are done before this packages triggers the validation.

    /**
     * Boot triggers.
     *
     * @return void
     */
    public static function boot()
    {
        self::updating(function ($model) {
            // Doing something.
        });

        parent::boot();
    }

Models implementing this package will now throw a ValidationException exception if they do not pass validation. Be sure to catch these.

    try {
        $user = User::create(request()->all());
    } catch (HnhDigital\ModelSchema\Exceptions\ValidationException $exception) {
        // Do something about the validation.

        // You can add things to the validator.
        $exception->getValidator()->errors()->add('field', 'Something is wrong with this field!');

        // We've implemented a response.
        // This redirects the same as a validator with errors.
        return $exception->getResponse('user::add');
    }

Custom casts

This package allows the ability to add custom casts. Simply create a trait, and register the cast on boot.

trait ModelCastAsMoneyTrait
{
    /**
     * Cast value as Money.
     *
     * @param mixed $value
     *
     * @return Money
     */
    protected function castAsMoney($value, $currency = 'USD', $locale = 'en_US'): Money
    {
        return new Money($value, $currency, $locale);
    }

    /**
     * Convert the Money value back to a storable type.
     *
     * @return int
     */
    protected function castMoneyToInt($key, $value): int
    {
        if (is_object($value)) {
            return (int) $value->amount();
        }

        return (int) $value->amount();
    }

    /**
     * Register the casting definitions.
     */
    public static function bootModelCastAsMoneyTrait()
    {
        static::registerCastFromDatabase('money', 'castAsMoney');
        static::registerCastToDatabase('money', 'castMoneyToInt');
        static::registerCastValidator('money', 'int');
    }
}

Defining your attributes would look like this:

    ...

    'currency' => [
        'cast'     => 'string',
        'rules'    => 'min:3|max:3',
        'fillable' => true,
    ],
    'total_amount' => [
        'cast'        => 'money',
        'cast-params' => '$currency:en_US',
        'default'     => 0,
        'fillable'    => true,
    ],
    ...

Casting parameters would include a helper function, or a local model method.

eg $currency:user_locale(), or $currency():$locale()

Available custom casts

Cast the attribute to Money

Contributing

Please review the Contribution Guidelines.

Only PRs that meet all criterium will be accepted.

Reporting issues

When reporting issues, please fill out the included template as completely as possible. Incomplete issues may be ignored or closed if there is not enough information included to be actionable.

hnhdigital-os / laravel-model-schema

Maintainers

Details