README

Observer for validating Eloquent Model

An observer that validates an Eloquent model instance before it is persisted to the database, by raising a ValidationException.

Install

Use Composer to install the package.

composer require spoorsny/laravel-model-validating-observer

Usage

Add the \Illuminate\Database\Eloquent\Attributes\ObservedBy attribute to your model, with \Spoorsny\Laravel\Observers\ValidateModel::class as its argument.

Implement the \Spoornsy\Laravel\Contracts\SelfValidatingModel interface within your model by adding a public, static method to your model, named validationRules() that returns an associative array with the validation rules and custom messages for your model's attributes.

use Illuminate\Database\Eloquent\Attributes\ObservedBy;
use Illuminate\Database\Eloquent\Model;

use Spoorsny\Laravel\Contracts\SelfValidatingModel;
use Spoorsny\Laravel\Observers\ValidateModel;

#[ObservedBy(ValidateModel::class)]
class Car extends Model implements SelfValidatingModel
{
    public static function validationRules(): array
    {
        return [
            'rules' => [
                'make' => 'required|string',
                'model' => 'required|string',
            ],
            'messages' => [
                'make.required' => 'We need to know the make of the car.',
            ],
        ];
    }
}

The observer will check each instance of your model against the validation rules during the saving event triggered by Eloquent. If validation fails, an \Illuminate\Validation\ValidationException will be thrown, preventing the persistence of the invalid model instance.

Contributing

To contribute to the package, see the Contributing Guide.

License

This file is part of package spoorsny/laravel-model-validating-observer.

Package spoorsny/laravel-model-validating-observer is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Package spoorsny/laravel-model-validating-observer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with package spoorsny/laravel-model-validating-observer. If not, see https://www.gnu.org/licenses/.

For a copy of the license, see the LICENSE file in this repository.

spoorsny / laravel-model-validating-observer

Maintainers

Details