Yii2. Свой валидатор

В посте про валидацию в Yii2 я коснулась основ валидации и дала краткое описание встроенных валидаторов. Но что, если ни один из них нам не подходит. В этом случае мы можем написать свой.

Есть три способа реализации своего валидатора:

1. написать inline-функцию для валидации;
2. реализовать метод в модели с именем вашего валидатора;
3. реализовать класс, унаследованный от Validator.

Во всех примерах ниже будет реализована валидация одного примера. Предположим, у нас есть некий справочник запчастей. У каждой запчасти есть тип. Необходимо, чтобы в рамках одного типа серийные номера запчастей были уникальны.
В такой постановке нам не подходят валидаторы exist и unique, потому что первый проверяет только на существование (и даже параметр filter нам не поможет), а второй на уникальность в рамках всего справочника.

Inline-функция

public function rules()
{
    return [
        ['serial_number', function ($attribute, $params) {
                if ($this->type_id) {
                    $existModel = Type::find()->byType($this->type_id)->bySerialNumber($this->$attribute)->one();
                    if ($existModel) {
                        $this->addError($attribute, 'Serial number must be unique for type.');
                    }
                }
            }
        ],
    ];
}

Метод модели

public function rules()
{
    return [
        ['serial_number', 'uniqueByType']
    ];
}

public function uniqueByType($attribute, $params) {
    if ($this->type_id) {
        $existModel = Type::find()->byType($this->type_id)->bySerialNumber($this->$attribute)->one();
        if ($existModel) {
            $this->addError($attribute, 'Serial number must be unique for type.');
        }
    }
}

Класс Validator

В этом примере есть одно отличие – я добавила параметр compare, в котором можно задать наименование атрибута типа запчасти. Обратите внимание, что в этом примере я опустила необходимые проверки (например, что параметр compare вообще задан).

use \yii\validators\Validator;

class UniqueByTypeValidator extends Validator
{
    public $compare;

    public function validateAttribute($model, $attribute)
    {
        $compare = $this->compare;
        if ($this->$compare) {
            $existModel = Type::find()->byType($this->$compare)->bySerialNumber($this->$attribute)->one();
            if ($existModel) {
                $this->addError($attribute, 'Serial number must be unique for type.');
            }
        }
    }
}

Посты по теме:
Yii2: встроенные валидаторы. Описание, параметры
Yii2: валидация, правила валидации, встроенные валидаторы