Custom Validation Rules in Laravel

Custom Validation Rules in Laravel

In this post, we will look at how we can create custom validation rules for Laravel Form Requests. In our previous post, Laravel Form Request Demystified we looked at how we can extract the validation from controller to custom request class, today we will create custom rules to use in the request class.

Laravel provides an easy way to create custom validation rules. You can create custom rules based around your own business needs and use them anywhere in your application.

This post is the continutiy of Laravel Form Request Demystified post, so you should read this first.

Creating Rule Class

In the previous post, we created form request for a Customer model for name and email attributes. In this post, we will add a custom rule for name propert. For the sake of this post, I assume that we want users to enter a upper case customer name in the name field.

Note

I am just assuming this requirement for the purpose of this post.

You can create a custom Rule class in Laravel, using below command:

php artisan make:rule UpperCase

After running this command Laravel, create a new folder called Rules in app folder with a UpperCase class file with below content.

namespace App\Rules;

use Illuminate\Contracts\Validation\Rule;

class UpperCase implements Rule
{
    /**
     * Create a new rule instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Determine if the validation rule passes.
     *
     * @param  string  $attribute
     * @param  mixed  $value
     * @return bool
     */
    public function passes($attribute, $value)
    {
        //
    }

    /**
     * Get the validation error message.
     *
     * @return string
     */
    public function message()
    {
        return 'The validation error message.';
    }
}

We have to add our custom logic in the passes() function and custom message for this rule in message() function.

Adding Validation Logic

Now, we will update our passes() function with below.

/**
     * Determine if the validation rule passes.
     *
     * @param  string  $attribute
     * @param  mixed  $value
     * @return bool
     */
    public function passes($attribute, $value)
    {
        return strtoupper($value) === $value;
    }

We are just checking that, if the value passed for validation is in upper case if it is, then this function will return a boolen value true otherwise false.

Next we will update the message() method with below:

/**
     * Get the validation error message.
     *
     * @return string
     */
    public function message()
    {
        return 'The :attribute must be uppercase.';
    }

This message will return a message if the validation fails.

Using the Validation Rule in Form Request Class

All set, now it’s time to add this rule to our form request class. Import the validation rule class in your request class using the use statement.

use App\Rules\UpperCase

Update your StoreCustomerRequest‘s rules() function with below.

/**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'name'      =>  ['required','max:255', new UpperCase],
            'email'     =>  'required|email|unique:customers',
        ];
    }

Note that we are adding the class itself to the name validation rules. Whenever form request run the validation rules, it will instantiate UpperCase class and validate the rule for this class.

Now, if you enter a lower case name in the Customer’s name field, you will get a custom message like:

The name must be uppercase.

Using the Validation Rule in Controller

You can also use the custom validation rule in your controller as well. Import the custom rule class UpperCase into the controller using use statement.

use App\Rules\UpperCase

Then implement the validation in controller like below:

$request->validate([
            'name'      =>  ['required','max:255', new UpperCase],
            'email'     =>  'required|email|unique:customers',
]);

Conclusion

That’s it for now. In this post, we have learned how we can create custom rules for validation and use them in form request class and in controllers. You can read more about custom validation rules on Laravel’s Offical documentation.

Leave a Reply

Your email address will not be published. Required fields are marked *

*When sharing a code snippet please wrap you code with pre tag and add a class code-block to it like below.
<pre class="code-block">you code here</pre>

*
*

This site uses Akismet to reduce spam. Learn how your comment data is processed.