anourvalar/eloquent-validation

Validation feature for eloquent model (Laravel)

3.15.24 2024-11-28 16:32 UTC

Requires

• php: ^8.3
• laravel/framework: ^8.0|^9.0|^10.0|^11.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.26
• phpstan/phpstan: ^1.10
• psalm/plugin-laravel: ^2.8
• squizlabs/php_codesniffer: ^3.7

MIT

• validator
• validation
• model
• laravel
• validate
• eloquent
• anourvalar

README

Installation

composer require anourvalar/eloquent-validation

Usage

Creating with validation

\App\UserPhone
    ::fields('user_id', 'phone_number') // fillable columns (mass assignment)
    ->fill(\Request::input())
    ->validate() // will throw exception if it fails
    ->save();
}

Updating with validation

\App\UserPhone
    ::findOrFail(\Request::input('id'))
    ->fields(['user_id', 'phone_number']) // also might be an array
    ->fill(\Request::input())
    ->validate()
    ->save();
}

Generate model

php artisan make:model-validation UserPhone

Model configuration

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class UserPhone extends Model
{
    use \AnourValar\EloquentValidation\ModelTrait;

    /**
     * Trim columns
     * 
     * @var array
     */
    protected $trim = [
        'phone_number', // trim mutator
    ];

    /**
     * '',[] => null convertation
     * 
     * @var array
     */
    protected $nullable = [
        // empty string to null (convertation) mutator
    ];

    /**
     * Calculated columns
     *
     * @var array
     */
    protected $computed = [
        // columns which could be changed only in listeners (observers)
    ];

    /**
     * Immutable columns
     *
     * @var array
     */
    protected $unchangeable = [
        'user_id', // unchangeable columns after creation
    ];

    /**
     * Unique columns sets
     *
     * @var array
     */
    protected $unique = [
        // unique sets of columns
    ];

    /**
     * Get the validation rules
     *
     * @return array
     */
    public function saveRules()
    {
        return [
            'user_id' => ['required', 'integer'],
            'phone_number' => ['required', 'string', 'min:8', 'max:13', 'unique'],
        ];
    }

    /**
     * "Save" after-validation
     *
     * @param \Illuminate\Validation\Validator $validator
     * @return void
     */
    public function saveAfterValidation(\Illuminate\Validation\Validator $validator): void
    {
        if ($this->isDirty('user_id') && !\App\User::find($this->user_id)) {
            $validator->errors()->add('user_id', trans('models/user_phone.user_id_not_exists'));
        }
    }

    /**
     * "Delete" after-validation
     *
     * @param \Illuminate\Validation\Validator $validator
     * @return void
     */
    public function deleteAfterValidation(\Illuminate\Validation\Validator $validator): void
    {
        //
    }
}