README

A Laravel package to add validation rules and messages at the model level.

After install this package, you don't need to write the validation rules inside controller or form request, you can add them inside model and directly use methods to validate.

Adding validation rules inside model itself makes model readable for developers.

Installation

Install the package via composer:

composer require sandaffo/laravel-model-validator

Usage

Adding Validation to a Model

To add validation to a model, define the rules and messages properties in your model:

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    // define rules array
    public static $rules = [
        'title' => 'required|string|max:255',
        'slug' => 'required|string|max:255|unique:posts',
        'description' => 'required|string|min:8',
    ];

    // messages are optional, only provide when want customize message
    public static $messages = [
        'title.required' => 'The title field is required.',
        'slug.required' => 'The slug field is required.',
        'description.required' => 'The description field is required.',
    ];
}

Example

Below is an example demonstrating the usage of the package:

$p = new Post();
$p->title = "Test Post One";
$p->slug = "test-post-one";
$p->description = "Test post one description";

if ($p->isValid()) { // $p->isValid() returns true or false
    echo "Post is valid";
    $p->save();
} else {
    echo "Post is not valid";
    print_r($p->errors());
}

Tinker Example

$ php artisan tinker

$p = new Post();
$p->title = "Test Post One";
$p->slug = "test-post-one";
$p->description = "Test post one description";

$p->isValid(); // true or false
$p->errors(); // []

$p->errorMessages(); // [] single dimensional array of all error messages

$p->getRules(); // to get the defined rules if you need somewhere
// [
//     "title" => "required|string|max:255",
//     "slug" => "required|string|max:255|unique:posts",
//     "description" => "required|string|min:8",
// ]

$p->getMessages(); // [] of defined custom error messages

$p->getValidator(); // return Validator object if you need
// Illuminate\Validation\Validator { ... }

$p->getValidator()->errors();
// Illuminate\Support\MessageBag { ... }

$p->save(); // true

$p;
// App\Models\Post {
//     title: "Test Post One",
//     slug: "test-post-one",
//     description: "Test post one description",
//     updated_at: "2024-07-24 08:45:45",
//     created_at: "2024-07-24 08:45:45",
//     id: 1,
// }

Methods

isValid(): Checks if the model is valid according to the defined rules.
errors(): Returns an array of validation errors.
errorMessages(): Returns an array of error messages.
getRules(): Returns the validation rules.
getMessages(): Returns the validation messages.
getValidator(): Returns the validator instance.

License

This package is open-sourced software licensed under the MIT license.

sandaffo / laravel-model-validator

Maintainers

Details