Methods to create custom validation rules in Yii include: using custom validation methods in the model, creating reusable validator classes, using inline anonymous functions (Yii2 only), and noting common errors. First, define a verification method in the model, such as validateUsername, and reference it in rules(); second, create a reusable UsernameValidator class by inheriting yii\validators\Validator; third, write simple logic directly in rules() using anonymous functions; finally, make sure the method is public, call addError() correctly, check the namespace, and handle client verification. These methods can be selected according to requirements to achieve flexible and efficient data verification.

In Yii, creating custom validation rules is a straightforward process that gives you more control over how data is validated before being saved or processed. Whether you're working with models in Yii 1.x or using the more modern Yii2 framework, the concept remains similar: you define rules that check if the input meets your specific requirements.

Here are a few practical ways to implement custom validation rules depending on your needs and version of Yii.

Use a Custom Validator Method in Your Model

One of the most common approaches is defining a method inside your model that performs the validation logic. This works well for both simple and moderately complex validations.

For example, in Yii2 , you can do this:

 public function rules()
{
    Return [
        ['username', 'validateUsername'],
    ];
}

public function validateUsername($attribute, $params)
{
    if ($this->$attribute === 'admin') {
        $this->addError($attribute, 'Username cannot be "admin"');
    }
}

• The rule references validateUsername , which is a method you define.
• The method receives the attribute name and any parameters (if needed).
• You use addError() to trigger an error message when the condition fails.

This method is flexible and keeps everything within your model, making it easy to maintain.

Create a Reusable Validator Class

If you find yourself needing the same validation across multiple models, it's worth creating a reusable validator class.

In Yii2 , you can extend yii\validators\Validator :

 namespace app\validators;

use yii\validators\Validator;

class UsernameValidator extends Validator
{
    public function validateAttribute($model, $attribute)
    {
        if ($model->$attribute === 'admin') {
            $this->addError($model, $attribute, 'Username cannot be "admin"');
        }
    }
}

Then in your model:

 public function rules()
{
    Return [
        ['username', \app\validators\UsernameValidator::class],
    ];
}

This approach helps reduce duplication and makes your code cleaner when dealing with shared business rules.

Use Inline Anonymous Functions (Yii2 Only)

If you prefer keeping things concise and don't need reuse, you can also write inline anonymous functions directly in the rules array.

 public function rules()
{
    Return [
        ['username', function ($attribute, $params) {
            if ($this->$attribute === 'admin') {
                $this->addError($attribute, 'This username is not allowed.');
            }
        }],
    ];
}

• This avoids creating extra methods or classes.
• It's good for quick checks but may get messy if the logic becomes too involved.

Use this style when the validation is simple and only apply to one place.

Watch Out for These Common Pitfalls

Sometimes things might not work as expected due to small mistakes:

• Make sure the validator method is public.
• Always call addError() with the correct attribute name.
• If using a custom validator class, double-check the namespace.
• In some cases, especially with file uploads or AJAX validation, you may need to handle scenarios differently.

Also, remember that client-side validation won't run unless you explicitly enable it or use built-in validators that support it.

Basically that's it. Custom validation in Yii is powerful once you understand how to structure your rules and where to place your logic. Depending on whether you want something quick, reusable, or tightly scoped, you've got options — and none of them are overly complicated.

The above is the detailed content of How do I create custom validation rules in Yii?. For more information, please follow other related articles on the PHP Chinese website!