Yii2 обработка ошибок валидации

Проверка входящих данных ¶

Как правило, вы никогда не должны доверять данным, полученным от пользователей и всегда проверять их прежде, чем работать с ними и добавлять в базу данных.

Учитывая модель данных которые должен заполнить пользователь, можно проверить эти данные на валидность воспользовавшись методом yiibaseModel::validate(). Метод возвращает логическое значение с результатом валидации ложь/истина. Если данные не валидны, ошибку можно получить воспользовавшись свойством yiibaseModel::$errors. Рассмотрим пример:

$model = new appmodelsContactForm;

// заполняем модель пользовательскими данными
$model->load(Yii::$app->request->post());
// аналогично следующей строке:
// $model->attributes = Yii::$app->request->post('ContactForm');

if ($model->validate()) {
    // все данные корректны
} else {
    // данные не корректны: $errors - массив содержащий сообщения об ошибках
    $errors = $model->errors;
}

Правила проверки ¶

Для того, чтобы validate() действительно работал, нужно объявить правила проверки атрибутов.
Правила для проверки нужно указать в методе yiibaseModel::rules(). В следующем примере показано, как
правила для проверки модели ContactForm, нужно объявлять:

public function rules()
{
    return [
        // атрибут required указывает, что name, email, subject, body обязательны для заполнения
        [['name', 'email', 'subject', 'body'], 'required'],

        // атрибут email указывает, что в переменной email должен быть корректный адрес электронной почты
        ['email', 'email'],
    ];
}

Метод rules() должен возвращать массив правил, каждое из которых является массивом в следующем формате:

[
    // обязательный, указывает, какие атрибуты должны быть проверены по этому правилу.
    // Для одного атрибута, вы можете использовать имя атрибута не создавая массив
    ['attribute1', 'attribute2', ...],

    // обязательный, указывает тип правила.
    // Это может быть имя класса, псевдоним валидатора, или метод для проверки
    'validator',

    // необязательный, указывает, в каком случае(ях) это правило должно применяться
    // если не указан, это означает, что правило применяется ко всем сценариям
    // Вы также можете настроить "except" этот вариант применяет правило ко всем
    // сценариям кроме перечисленных
    'on' => ['scenario1', 'scenario2', ...],

    // необязательный, задает дополнительные конфигурации для объекта validator
    'property1' => 'value1', 'property2' => 'value2', ...
]

Для каждого правила необходимо указать, по крайней мере, какие атрибуты относится к этому правилу и тип правила.
Вы можете указать тип правила в одном из следующих форматов:

• Псевдонимы основного валидатора, например required, in, date и другие. Пожалуйста, обратитесь к списку
  Основных валидаторов за более подробной информацией.
• Название метода проверки в модели класса, или анонимную функцию. Пожалуйста, обратитесь к разделу
  Встроенных валидаторов за более подробной информацией.
• Полное имя класса валидатора. Пожалуйста, обратитесь к разделу Автономных валидаторов
  за более подробной информацией.

Правило может использоваться для проверки одного или нескольких атрибутов. Атрибут может быть проверен одним или несколькими правилами.
Правило может быть применено только к определенным сценариям указав свойство on.
Если вы не укажите свойство on, это означает, что правило будет применяться ко всем сценариям.

Когда вызывается метод validate() для проверки, он выполняет следующие действия:

1. Определяет, какие атрибуты должны проверяться путем получения списка атрибутов от yiibaseModel::scenarios()
   используя текущий scenario. Эти атрибуты называются — активными атрибутами.
2. Определяет, какие правила проверки должны использоваться, получив список правил от yiibaseModel::rules()
   используя текущий scenario. Эти правила называются — активными правилами.
3. Каждое активное правило проверяет каждый активный атрибут, который ассоциируется с правилом.
   Правила проверки выполняются в том порядке, как они перечислены.

Согласно вышеизложенным пунктам, атрибут будет проверяться, если и только если он является
активным атрибутом, объявленным в scenarios() и связан с одним или несколькими активными правилами,
объявленными в rules().

Примечание: Правилам валидации полезно давать имена. Например:

public function rules()
{
    return [
        // ...
        'password' => [['password'], 'string', 'max' => 60],
    ];
}

В случае наследования предыдущей модели, именованные правила можно модифицировать или удалить:

public function rules()
{
    $rules = parent::rules();
    unset($rules['password']);
    return $rules;
}

Настройка сообщений об ошибках ¶

Большинство валидаторов имеют сообщения об ошибках по умолчанию, которые будут добавлены к модели когда его атрибуты не проходят проверку.
Например, required валидатор добавляет к модели сообщение об ошибке «Имя пользователя не может быть пустым.» когда атрибут username не удовлетворил правилу этого валидатора.

Вы можете настроить сообщение об ошибке для каждого правила, указав свойство message при объявлении правила, следующим образом:

public function rules()
{
    return [
        ['username', 'required', 'message' => 'Please choose a username.'],
    ];
}

Некоторые валидаторы могут поддерживать дополнительные сообщения об ошибках, чтобы более точно описать причину ошибки.
Например, number валидатор поддерживает
tooBig и tooSmall
для описания ошибки валидации, когда проверяемое значение является слишком большим и слишком маленьким, соответственно.
Вы можете настроить эти сообщения об ошибках, как в настройках валидаторов, так и непосредственно в правилах проверки.

События валидации ¶

Когда вызывается метод yiibaseModel::validate() он инициализирует вызов двух методов,
которые можно переопределить, чтобы настроить процесс проверки:

• yiibaseModel::beforeValidate(): выполнение по умолчанию вызовет yiibaseModel::EVENT_BEFORE_VALIDATE
  событие. Вы можете переопределить этот метод, или обрабатывать это событие, чтобы сделать некоторую предобработку данных (например, форматирование входных данных), метод вызывается до начала валидации. Этот метод должен возвращать логическое значение, указывающее, следует ли продолжать проверку или нет.
• yiibaseModel::afterValidate(): выполнение по умолчанию вызовет yiibaseModel::EVENT_AFTER_VALIDATE
  событие. Вы можете либо переопределить этот метод или обрабатывать это событие, чтобы сделать некоторую постобработку данных (например, отформатировать данные удобным для дальнейшей обработки образом), метод вызывается после валидации.

Условные валидации ¶

Для проверки атрибутов только при выполнении определенных условий, например если один атрибут зависит от значения другого атрибута можно использовать when свойство, чтобы определить такие условия. Например:

    ['state', 'required', 'when' => function($model) {
        return $model->country == 'USA';
    }],

Это свойство when принимает PHP callable функцию с следующим описанием:

/**
 * @param Model $model модель используемая для проверки
 * @param string $attribute атрибут для проверки
 * @return bool следует ли применять правило
 */
function ($model, $attribute)

Если вам нужна поддержка условной проверки на стороне клиента, вы должны настроить свойство метода
whenClient, которое принимает строку, представляющую JavaScript
функцию, возвращаемое значение определяет, следует ли применять правило или нет. Например:

    ['state', 'required', 'when' => function ($model) {
        return $model->country == 'USA';
    }, 'whenClient' => "function (attribute, value) {
        return $('#country').val() == 'USA';
    }"]

Фильтрация данных ¶

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

В следующих примерах показано, как обрезать пробелы во входных данных и превратить пустые входные данные в NULL
с помощью trim и указать значения по умолчанию с помощью свойства
default основного валидатора:

return [
    [['username', 'email'], 'trim'],
    [['username', 'email'], 'default'],
];

Вы также можете использовать более сложные фильтрации данных с помощью анонимной функции
подробнее об этом filter.

Как видите, эти правила валидации на самом деле не проверяют входные данные. Вместо этого,
они будут обрабатывать значения и обратно возвращать результат работы. Фильтры по сути выполняют предобработку входящих данных.

Обработка пустых входных данных ¶

Если входные данные представлены из HTML-формы, часто нужно присвоить некоторые значения
по умолчанию для входных данных, если они не заполнены. Вы можете сделать это с помощью
валидатора default. Например:

return [
    // установим "username" и "email" как NULL, если они пустые
    [['username', 'email'], 'default'],

    // установим "level" как 1 если он пустой
    ['level', 'default', 'value' => 1],
];

По умолчанию входные данные считаются пустыми, если их значением является пустая строка, пустой массив или null.
Вы можете реализовать свою логику определения пустых входящих данных путем переопределения метода yiivalidatorsValidator::isEmpty()
используя анонимную функцию. Например:

    ['agree', 'required', 'isEmpty' => function ($value) {
        return empty($value);
    }]

Примечание: большинство валидаторов не обрабатывает пустые входные данные, если их
yiibaseValidator::skipOnEmpty свойство принимает значение по умолчанию true.
Они просто будут пропущены во время проверки, если связанные с ними атрибуты являются пустыми.
Среди основных валидаторов, только captcha, default, filter,
required, и trim будут обрабатывать пустые входные данные.

Специальная валидация ¶

Иногда вам нужно сделать специальную валидацию для значений, которые не связаны с какой-либо моделью.

Если необходимо выполнить только один тип проверки (например, проверка адреса электронной почты),
вы можете вызвать метод validate() нужного валидатора.
Например:

$email = 'test@example.com';
$validator = new yiivalidatorsEmailValidator();

if ($validator->validate($email, $error)) {
    echo 'Email is valid.';
} else {
    echo $error;
}

Примечание: Не все валидаторы поддерживают такой тип проверки. Примером может служить
unique валидатор, который предназначен для работы с моделью.

Примечание: Свойство yiibaseValidator::skipOnEmpty используется только в yiibaseModel и использование его отдельно не будет иметь никакого эффекта.

Если необходимо выполнить несколько проверок в отношении нескольких значений,
вы можете использовать yiibaseDynamicModel, который поддерживает объявление, как
атрибутов так и правил «на лету». Его использование выглядит следующим образом:

public function actionSearch($name, $email)
{
    $model = DynamicModel::validateData(compact('name', 'email'), [
        [['name', 'email'], 'string', 'max' => 128],
        ['email', 'email'],
    ]);

    if ($model->hasErrors()) {
        // валидация завершилась с ошибкой
    } else {
        // Валидация успешно выполнена
    }
}

Метод yiibaseDynamicModel::validateData() создает экземпляр DynamicModel, определяет
атрибуты, используя приведенные данные (name и email в этом примере), и затем вызывает
yiibaseModel::validate()
с данными правилами.

Кроме того, вы можете использовать следующий «классический» синтаксис для выполнения специальной проверки данных:

public function actionSearch($name, $email)
{
    $model = new DynamicModel(compact('name', 'email'));
    $model->addRule(['name', 'email'], 'string', ['max' => 128])
        ->addRule('email', 'email')
        ->validate();

    if ($model->hasErrors()) {
        // валидация завершилась с ошибкой
    } else {
        // Валидация успешно выполнена
    }
}

После валидации, вы можете проверить успешность выполнения вызвав
метод hasErrors() и затем получить ошибки проверки вызвав
метод errors как это делают нормальные модели.
Вы можете также получить доступ к динамическим атрибутам, определенным через экземпляр модели, например,
$model->name и $model->email.

Создание Валидаторов ¶

Кроме того, используя основные валидаторы, включенные в релизы Yii, вы также можете
создавать свои собственные валидаторы. Вы можете создавать встроенные валидаторы или автономные валидаторы.

Встроенные Валидаторы ¶

Встроенный валидатор наследует методы модели или использует анонимную функцию.
Описание метода/функции:

/**
 * @param string $attribute атрибут проверяемый в настоящее время
 * @param array $params дополнительные пары имя-значение, заданное в правиле
 * @param yiivalidatorsInlineValidator $validator связь с экземпляром InlineValidator
 */
function ($attribute, $params, $validator)

Если атрибут не прошел проверку, метод/функция должна вызвать yiibaseModel::addError(),
чтобы сохранить сообщение об ошибке в модели, для того чтобы позже можно было получить сообщение об ошибке для
представления конечным пользователям.

Ниже приведены некоторые примеры:

use yiibaseModel;

class MyForm extends Model
{
    public $country;
    public $token;

    public function rules()
    {
        return [
            // встроенный валидатор определяется как модель метода validateCountry()
            ['country', 'validateCountry'],

            // встроенный валидатор определяется как анонимная функция
            ['token', function ($attribute, $params) {
                if (!ctype_alnum($this->$attribute)) {
                    $this->addError($attribute, 'Токен должен содержать буквы или цифры.');
                }
            }],
        ];
    }

    public function validateCountry($attribute, $params)
    {
        if (!in_array($this->$attribute, ['USA', 'Indonesia'])) {
            $this->addError($attribute, 'Страна должна быть либо "USA" или "Indonesia".');
        }
    }
}

Примечание: по умолчанию, встроенные валидаторы не будут применяться, если связанные с ними атрибуты
получат пустые входные данные, или если они уже не смогли пройти некоторые правила валидации.
Если вы хотите, чтобы, это правило применялось всегда, вы можете настроить свойства
skipOnEmpty и/или skipOnError
свойства false в правиле объявления. Например:

[
    ['country', 'validateCountry', 'skipOnEmpty' => false, 'skipOnError' => false],
]

Автономные валидаторы ¶

Автономный валидатор — это класс, расширяющий yiivalidatorsValidator или его дочерний класс.
Вы можете реализовать свою логику проверки путем переопределения метода
yiivalidatorsValidator::validateAttribute(). Если атрибут не прошел проверку, вызвать
yiibaseModel::addError(),
чтобы сохранить сообщение об ошибке в модели, как это делают встроенные валидаторы.

Валидация может быть помещена в отдельный класс [[components/validators/CountryValidator]]. В этом случае можно использовать метод yiivalidatorsValidator::addError() для того, чтобы добавить своё сообщение об ошибке в модель:

namespace appcomponents;

use yiivalidatorsValidator;

class CountryValidator extends Validator
{
    public function validateAttribute($model, $attribute)
    {
        if (!in_array($model->$attribute, ['USA', 'Indonesia'])) {
            $this->addError($model, $attribute, 'Страна должна быть либо "{country1}" либо "{country2}".', ['country1' => 'USA', 'country2' => 'Indonesia']);
        }
    }
}

Если вы хотите, чтобы ваш валидатор поддерживал проверку значений без модели, также необходимо переопределить
yiivalidatorsValidator::validate(). Вы можете также
переопределить yiivalidatorsValidator::validateValue()
вместо validateAttribute() и validate(), потому что по умолчанию последние два метода
реализуются путем вызова validateValue().

Валидация на стороне клиента ¶

Проверка на стороне клиента на основе JavaScript целесообразна, когда конечные пользователи вводят
входные данные через HTML-формы, так как эта проверка позволяет пользователям узнать ошибки ввода
быстрее и таким образом улучшает ваш пользовательский интерфейс. Вы можете использовать или
реализовать валидатор, который поддерживает валидацию на стороне клиента в дополнение к проверке на стороне сервера.

Информация: Проверка на стороне клиента желательна, но необязательна. Её основная цель заключается в
предоставлении пользователям более удобного интерфейса. Так как входные данные, поступают от конечных
пользователей, вы никогда не должны доверять верификации на стороне клиента. По этой причине, вы всегда
должны выполнять верификацию на стороне сервера путем вызова yiibaseModel::validate(),
как описано в предыдущих пунктах.

Использование валидации на стороне клиента ¶

Многие основные валидаторы поддерживают проверку на стороне клиента out-of-the-box.
Все, что вам нужно сделать, это просто использовать yiiwidgetsActiveForm для построения HTML-форм.

Например, LoginForm ниже объявляет два правила: первое использует required
основной валидатор, который поддерживается на стороне клиента и сервера; второе использует validatePassword
встроенный валидатор, который поддерживается только на стороне сервера.

namespace appmodels;

use yiibaseModel;
use appmodelsUser;

class LoginForm extends Model
{
    public $username;
    public $password;

    public function rules()
    {
        return [
            // username и password обязательны для заполнения
            [['username', 'password'], 'required'],

            // проверке пароля с помощью validatePassword()
            ['password', 'validatePassword'],
        ];
    }

    public function validatePassword()
    {
        $user = User::findByUsername($this->username);

        if (!$user || !$user->validatePassword($this->password)) {
            $this->addError('password', 'Неправильное имя пользователя или пароль.');
        }
    }
}

HTML-форма построена с помощью следующего кода, содержит поля для ввода username и password.
Если вы отправите форму, не вводя ничего, вы получите сообщения об ошибках, требующих ввести данные.
Сообщения появятся сразу, без обращения к серверу.

<?php $form = yiiwidgetsActiveForm::begin(); ?>
    <?= $form->field($model, 'username') ?>
    <?= $form->field($model, 'password')->passwordInput() ?>
    <?= Html::submitButton('Login') ?>
<?php yiiwidgetsActiveForm::end(); ?>

Класс yiiwidgetsActiveForm будет читать правила проверки заявленные в модели и генерировать
соответствующий код JavaScript для валидаторов, которые поддерживают проверку на стороне клиента.
Когда пользователь изменяет значение поля ввода или отправляет форму, JavaScript на стороне клиента
будет срабатывать и проверять введенные данные.

Если вы хотите отключить проверку на стороне клиента полностью, вы можете настроить свойство
yiiwidgetsActiveForm::$enableClientValidation установив значение false. Вы также можете отключить
проверку на стороне клиента отдельных полей ввода, настроив их с помощью свойства
yiiwidgetsActiveField::$enableClientValidation установив значение false.

Реализация проверки на стороне клиента ¶

Чтобы создать валидатор, который поддерживает проверку на стороне клиента, вы должны реализовать метод
yiivalidatorsValidator::clientValidateAttribute() возвращающий фрагмент кода JavaScript,
который выполняет проверку на стороне клиента. В JavaScript-коде, вы можете использовать следующие предопределенные переменные:

• attribute: имя атрибута для проверки.
• value: проверяемое значение.
• messages: массив, используемый для хранения сообщений об ошибках проверки значения атрибута.
• deferred: массив, который содержит отложенные объекты (описано в следующем подразделе).

В следующем примере мы создаем StatusValidator который проверяет значение поля на соответствие допустимым статусам.
Валидатор поддерживает оба способа проверки и на стороне сервера и на стороне клиента.

namespace appcomponents;

use yiivalidatorsValidator;
use appmodelsStatus;

class StatusValidator extends Validator
{
    public function init()
    {
        parent::init();
        $this->message = 'Invalid status input.';
    }

    public function validateAttribute($model, $attribute)
    {
        $value = $model->$attribute;
        if (!Status::find()->where(['id' => $value])->exists()) {
            $model->addError($attribute, $this->message);
        }
    }

    public function clientValidateAttribute($model, $attribute, $view)
    {
        $statuses = json_encode(Status::find()->select('id')->asArray()->column());
        $message = json_encode($this->message, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        return <<<JS
if ($.inArray(value, $statuses) === -1) {
    messages.push($message);
}
JS;
    }
}

Подсказка: приведенный выше код даётся, в основном, чтобы продемонстрировать, как осуществляется
поддержка проверки на стороне клиента. На практике вы можете использовать
in основные валидаторы для достижения той же цели.
Вы можете написать проверку, как правило, например:

[
    ['status', 'in', 'range' => Status::find()->select('id')->asArray()->column()],
]

Отложенная валидация ¶

Если Вам необходимо выполнить асинхронную проверку на стороне клиента, вы можете создавать
Deferred objects. Например, чтобы выполнить
пользовательские AJAX проверки, вы можете использовать следующий код:

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.push($.get("/check", {value: value}).done(function(data) {
            if ('' !== data) {
                messages.push(data);
            }
        }));
JS;
}

В примере выше переменная deferred предусмотренная Yii, которая является массивом Отложенных объектов.
$.get() метод jQuery создает Отложенный объект, который помещается в массив deferred.

Также можно явно создать Отложенный объект и вызвать его методом resolve(), тогда выполняется асинхронный
вызов к серверу. В следующем примере показано, как проверить размеры загружаемого файла изображения
на стороне клиента.

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        var def = $.Deferred();
        var img = new Image();
        img.onload = function() {
            if (this.width > 150) {
                messages.push('Изображение слишком широкое!');
            }
            def.resolve();
        }
        var reader = new FileReader();
        reader.onloadend = function() {
            img.src = reader.result;
        }
        reader.readAsDataURL(file);

        deferred.push(def);
JS;
}

Примечание: метод resolve() должен быть вызван после того, как атрибут был проверен.
В противном случае основная проверка формы не будет завершена.

Для простоты работы с массивом deferred, существует упрощенный метод add(), который автоматически создает Отложенный объект и добавляет его в deferred массив. Используя этот метод, вы можете упростить пример выше, следующим образом:

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.add(function(def) {
            var img = new Image();
            img.onload = function() {
                if (this.width > 150) {
                    messages.push('Изображение слишком широкое!');
                }
                def.resolve();
            }
            var reader = new FileReader();
            reader.onloadend = function() {
                img.src = reader.result;
            }
            reader.readAsDataURL(file);
        });
JS;
}

AJAX валидация ¶

Некоторые проверки можно сделать только на стороне сервера, потому что только сервер имеет необходимую информацию.
Например, чтобы проверить логин пользователя на уникальность, необходимо проверить логин в
базе данных на стороне сервера. Вы можете использовать проверку на основе AJAX в этом случае.
Это вызовет AJAX-запрос в фоновом режиме, чтобы проверить логин пользователя, сохраняя при этом валидацию
на стороне клиента. Выполняя её перед запросом к серверу.

Чтобы включить AJAX-валидацию для одного поля, Вы должны свойство enableAjaxValidation выбрать как true и указать уникальный id формы:

use yiiwidgetsActiveForm;

$form = ActiveForm::begin([
    'id' => 'registration-form',
]);

echo $form->field($model, 'username', ['enableAjaxValidation' => true]);

// ...

ActiveForm::end();

Чтобы включить AJAX-валидацию для всей формы, Вы должны свойство
enableAjaxValidation выбрать как true для формы:

$form = yiiwidgetsActiveForm::begin([
    'id' => 'contact-form',
    'enableAjaxValidation' => true,
]);

Примечание: В случае, если свойство enableAjaxValidation указано и у поля и у формы, первый вариант будет иметь приоритет.

Также необходимо подготовить сервер для обработки AJAX-запросов валидации. Это может быть достигнуто
с помощью следующего фрагмента кода, в контроллере действий:

if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}

Приведенный выше код будет проверять, является ли текущий запрос AJAX. Если да,
он будет отвечать на этот запрос, предварительно выполнив проверку и возвратит ошибки в
случае их появления в формате JSON.

Информация: Вы также можете использовать Deferred Validation AJAX валидации.
Однако, AJAX-функция проверки, описанная здесь более интегрированная и требует меньше усилий к написанию кода.

Проверка входящих данных

Как правило, вы никогда не должны доверять данным, полученным от пользователей и всегда проверять их прежде, чем работать с ними и добавлять в базу данных.

Учитывая модель данных которые должен заполнить пользователь, можно проверить эти данные на валидность воспользовавшись методом [[yiibaseModel::validate()]]. Метод возвращает логическое значение с результатом валидации ложь/истина. Если данные не валидны, ошибку можно получить воспользовавшись свойством [[yiibaseModel::errors]]. Рассмотрим пример:

$model = new appmodelsContactForm;

// заполняем модель пользовательскими данными
$model->load(Yii::$app->request->post());
// аналогично следующей строке:
// $model->attributes = Yii::$app->request->post('ContactForm');

if ($model->validate()) {
    // все данные корректны
} else {
    // данные не корректны: $errors - массив содержащий сообщения об ошибках
    $errors = $model->errors;
}

Правила проверки

Для того, чтобы validate() действительно работал, нужно объявить правила проверки атрибутов.
Правила для проверки нужно указать в методе [[yiibaseModel::rules()]]. В следующем примере показано, как
правила для проверки модели ContactForm, нужно объявлять:

public function rules()
{
    return [
        // атрибут required указывает, что name, email, subject, body обязательны для заполнения
        [['name', 'email', 'subject', 'body'], 'required'],

        // атрибут email указывает, что в переменной email должен быть корректный адрес электронной почты
        ['email', 'email'],
    ];
}

Метод [[yiibaseModel::rules()|rules()]] должен возвращать массив правил, каждое из которых является массивом в следующем формате:

[
    // обязательный, указывает, какие атрибуты должны быть проверены по этому правилу.
    // Для одного атрибута, вы можете использовать имя атрибута не создавая массив
    ['attribute1', 'attribute2', ...],

    // обязательный, указывает тип правила.
    // Это может быть имя класса, псевдоним валидатора, или метод для проверки
    'validator',

    // необязательный, указывает, в каком случае(ях) это правило должно применяться
    // если не указан, это означает, что правило применяется ко всем сценариям
    // Вы также можете настроить "except" этот вариант применяет правило ко всем
    // сценариям кроме перечисленных
    'on' => ['scenario1', 'scenario2', ...],

    // необязательный, задает дополнительные конфигурации для объекта validator
    'property1' => 'value1', 'property2' => 'value2', ...
]

Для каждого правила необходимо указать, по крайней мере, какие атрибуты относится к этому правилу и тип правила.
Вы можете указать тип правила в одном из следующих форматов:

• Псевдонимы основного валидатора, например required, in, date и другие. Пожалуйста, обратитесь к списку
  Основных валидаторов за более подробной информацией.
• Название метода проверки в модели класса, или анонимную функцию. Пожалуйста, обратитесь к разделу
  Встроенных валидаторов за более подробной информацией.
• Полное имя класса валидатора. Пожалуйста, обратитесь к разделу Автономных валидаторов
  за более подробной информацией.

Правило может использоваться для проверки одного или нескольких атрибутов. Атрибут может быть проверен одним или несколькими правилами.
Правило может быть применено только к определенным сценариям указав свойство on.
Если вы не укажите свойство on, это означает, что правило будет применяться ко всем сценариям.

Когда вызывается метод validate() для проверки, он выполняет следующие действия:

1. Определяет, какие атрибуты должны проверяться путем получения списка атрибутов от [[yiibaseModel::scenarios()]]
   используя текущий [[yiibaseModel::scenario|scenario]]. Эти атрибуты называются — активными атрибутами.
2. Определяет, какие правила проверки должны использоваться, получив список правил от [[yiibaseModel::rules()]]
   используя текущий [[yiibaseModel::scenario|scenario]]. Эти правила называются — активными правилами.
3. Каждое активное правило проверяет каждый активный атрибут, который ассоциируется с правилом.
   Правила проверки выполняются в том порядке, как они перечислены.

Согласно вышеизложенным пунктам, атрибут будет проверяться, если и только если он является
активным атрибутом, объявленным в scenarios() и связан с одним или несколькими активными правилами,
объявленными в rules().

Note: Правилам валидации полезно давать имена. Например:

public function rules()
{
    return [
        // ...
        'password' => [['password'], 'string', 'max' => 60],
    ];
}

В случае наследования предыдущей модели, именованные правила можно модифицировать или удалить:

public function rules()
{
    $rules = parent::rules();
    unset($rules['password']);
    return $rules;
}

Настройка сообщений об ошибках

Большинство валидаторов имеют сообщения об ошибках по умолчанию, которые будут добавлены к модели когда его атрибуты не проходят проверку.
Например, [[yiivalidatorsRequiredValidator|required]] валидатор добавляет к модели сообщение об ошибке «Имя пользователя не может быть пустым.» когда атрибут username не удовлетворил правилу этого валидатора.

Вы можете настроить сообщение об ошибке для каждого правила, указав свойство message при объявлении правила, следующим образом:

public function rules()
{
    return [
        ['username', 'required', 'message' => 'Please choose a username.'],
    ];
}

Некоторые валидаторы могут поддерживать дополнительные сообщения об ошибках, чтобы более точно описать причину ошибки.
Например, [[yiivalidatorsNumberValidator|number]] валидатор поддерживает
[[yiivalidatorsNumberValidator::tooBig|tooBig]] и [[yiivalidatorsNumberValidator::tooSmall|tooSmall]]
для описания ошибки валидации, когда проверяемое значение является слишком большим и слишком маленьким, соответственно.
Вы можете настроить эти сообщения об ошибках, как в настройках валидаторов, так и непосредственно в правилах проверки.

События валидации

Когда вызывается метод [[yiibaseModel::validate()]] он инициализирует вызов двух методов,
которые можно переопределить, чтобы настроить процесс проверки:

• [[yiibaseModel::beforeValidate()]]: выполнение по умолчанию вызовет [[yiibaseModel::EVENT_BEFORE_VALIDATE]]
  событие. Вы можете переопределить этот метод, или обрабатывать это событие, чтобы сделать некоторую предобработку данных (например, форматирование входных данных), метод вызывается до начала валидации. Этот метод должен возвращать логическое значение, указывающее, следует ли продолжать проверку или нет.
• [[yiibaseModel::afterValidate()]]: выполнение по умолчанию вызовет [[yiibaseModel::EVENT_AFTER_VALIDATE]]
  событие. Вы можете либо переопределить этот метод или обрабатывать это событие, чтобы сделать некоторую постобработку данных (например, отформатировать данные удобным для дальнейшей обработки образом), метод вызывается после валидации.

Условные валидации

Для проверки атрибутов только при выполнении определенных условий, например если один атрибут зависит от значения другого атрибута можно использовать [[yiivalidatorsValidator::when|when]] свойство, чтобы определить такие условия. Например:

    ['state', 'required', 'when' => function($model) {
        return $model->country == 'USA';
    }],

Это свойство [[yiivalidatorsValidator::when|when]] принимает PHP callable функцию с следующим описанием:

/**
 * @param Model $model модель используемая для проверки
 * @param string $attribute атрибут для проверки
 * @return bool следует ли применять правило
 */
function ($model, $attribute)

Если вам нужна поддержка условной проверки на стороне клиента, вы должны настроить свойство метода
[[yiivalidatorsValidator::whenClient|whenClient]], которое принимает строку, представляющую JavaScript
функцию, возвращаемое значение определяет, следует ли применять правило или нет. Например:

    ['state', 'required', 'when' => function ($model) {
        return $model->country == 'USA';
    }, 'whenClient' => "function (attribute, value) {
        return $('#country').val() == 'USA';
    }"]

Фильтрация данных

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

В следующих примерах показано, как обрезать пробелы во входных данных и превратить пустые входные данные в NULL
с помощью trim и указать значения по умолчанию с помощью свойства
default основного валидатора:

return [
    [['username', 'email'], 'trim'],
    [['username', 'email'], 'default'],
];

Вы также можете использовать более сложные фильтрации данных с помощью анонимной функции
подробнее об этом filter.

Как видите, эти правила валидации на самом деле не проверяют входные данные. Вместо этого,
они будут обрабатывать значения и обратно возвращать результат работы. Фильтры по сути выполняют предобработку входящих данных.

Обработка пустых входных данных

Если входные данные представлены из HTML-формы, часто нужно присвоить некоторые значения
по умолчанию для входных данных, если они не заполнены. Вы можете сделать это с помощью
валидатора default. Например:

return [
    // установим "username" и "email" как NULL, если они пустые
    [['username', 'email'], 'default'],

    // установим "level" как 1 если он пустой
    ['level', 'default', 'value' => 1],
];

По умолчанию входные данные считаются пустыми, если их значением является пустая строка, пустой массив или null.
Вы можете реализовать свою логику определения пустых входящих данных путем переопределения метода [[yiivalidatorsValidator::isEmpty]]
используя анонимную функцию. Например:

    ['agree', 'required', 'isEmpty' => function ($value) {
        return empty($value);
    }]

Note: большинство валидаторов не обрабатывает пустые входные данные, если их
[[yiibaseValidator::skipOnEmpty]] свойство принимает значение по умолчанию true.
Они просто будут пропущены во время проверки, если связанные с ними атрибуты являются пустыми.
Среди основных валидаторов, только captcha, default, filter,
required, и trim будут обрабатывать пустые входные данные.

Специальная валидация

Иногда вам нужно сделать специальную валидацию для значений, которые не связаны с какой-либо моделью.

Если необходимо выполнить только один тип проверки (например, проверка адреса электронной почты),
вы можете вызвать метод [[yiivalidatorsValidator::validate()|validate()]] нужного валидатора.
Например:

$email = 'test@example.com';
$validator = new yiivalidatorsEmailValidator();

if ($validator->validate($email, $error)) {
    echo 'Email is valid.';
} else {
    echo $error;
}

Note: Не все валидаторы поддерживают такой тип проверки. Примером может служить
unique валидатор, который предназначен для работы с моделью.

Note: Свойство [[yiibaseValidator::skipOnEmpty]] используется только в [[yiibaseModel]] и использование его отдельно не будет иметь никакого эффекта.

Если необходимо выполнить несколько проверок в отношении нескольких значений,
вы можете использовать [[yiibaseDynamicModel]], который поддерживает объявление, как
атрибутов так и правил «на лету». Его использование выглядит следующим образом:

public function actionSearch($name, $email)
{
    $model = DynamicModel::validateData(compact('name', 'email'), [
        [['name', 'email'], 'string', 'max' => 128],
        ['email', 'email'],
    ]);

    if ($model->hasErrors()) {
        // валидация завершилась с ошибкой
    } else {
        // Валидация успешно выполнена
    }
}

Метод [[yiibaseDynamicModel::validateData()]] создает экземпляр DynamicModel, определяет
атрибуты, используя приведенные данные (name и email в этом примере), и затем вызывает
[[yiibaseModel::validate()]]
с данными правилами.

Кроме того, вы можете использовать следующий «классический» синтаксис для выполнения специальной проверки данных:

public function actionSearch($name, $email)
{
    $model = new DynamicModel(compact('name', 'email'));
    $model->addRule(['name', 'email'], 'string', ['max' => 128])
        ->addRule('email', 'email')
        ->validate();

    if ($model->hasErrors()) {
        // валидация завершилась с ошибкой
    } else {
        // Валидация успешно выполнена
    }
}

После валидации, вы можете проверить успешность выполнения вызвав
метод [[yiibaseDynamicModel::hasErrors()|hasErrors()]] и затем получить ошибки проверки вызвав
метод [[yiibaseDynamicModel::errors|errors]] как это делают нормальные модели.
Вы можете также получить доступ к динамическим атрибутам, определенным через экземпляр модели, например,
$model->name и $model->email.

Создание Валидаторов

Кроме того, используя основные валидаторы, включенные в релизы Yii, вы также можете
создавать свои собственные валидаторы. Вы можете создавать встроенные валидаторы или автономные валидаторы.

Встроенные Валидаторы

Встроенный валидатор наследует методы модели или использует анонимную функцию.
Описание метода/функции:

/**
 * @param string $attribute атрибут проверяемый в настоящее время
 * @param array $params дополнительные пары имя-значение, заданное в правиле
 * @param yiivalidatorsInlineValidator $validator связь с экземпляром InlineValidator
 */
function ($attribute, $params, $validator)

Если атрибут не прошел проверку, метод/функция должна вызвать [[yiibaseModel::addError()]],
чтобы сохранить сообщение об ошибке в модели, для того чтобы позже можно было получить сообщение об ошибке для
представления конечным пользователям.

Ниже приведены некоторые примеры:

use yiibaseModel;

class MyForm extends Model
{
    public $country;
    public $token;

    public function rules()
    {
        return [
            // встроенный валидатор определяется как модель метода validateCountry()
            ['country', 'validateCountry'],

            // встроенный валидатор определяется как анонимная функция
            ['token', function ($attribute, $params) {
                if (!ctype_alnum($this->$attribute)) {
                    $this->addError($attribute, 'Токен должен содержать буквы или цифры.');
                }
            }],
        ];
    }

    public function validateCountry($attribute, $params)
    {
        if (!in_array($this->$attribute, ['USA', 'Indonesia'])) {
            $this->addError($attribute, 'Страна должна быть либо "USA" или "Indonesia".');
        }
    }
}

Note: по умолчанию, встроенные валидаторы не будут применяться, если связанные с ними атрибуты
получат пустые входные данные, или если они уже не смогли пройти некоторые правила валидации.
Если вы хотите, чтобы, это правило применялось всегда, вы можете настроить свойства
[[yiivalidatorsValidator::skipOnEmpty|skipOnEmpty]] и/или [[yiivalidatorsValidator::skipOnError|skipOnError]]
свойства false в правиле объявления. Например:

[
    ['country', 'validateCountry', 'skipOnEmpty' => false, 'skipOnError' => false],
]

Автономные валидаторы

Автономный валидатор — это класс, расширяющий [[yiivalidatorsValidator]] или его дочерний класс.
Вы можете реализовать свою логику проверки путем переопределения метода
[[yiivalidatorsValidator::validateAttribute()]]. Если атрибут не прошел проверку, вызвать
[[yiibaseModel::addError()]],
чтобы сохранить сообщение об ошибке в модели, как это делают встроенные валидаторы.

Валидация может быть помещена в отдельный класс [[components/validators/CountryValidator]]. В этом случае можно использовать метод [[yiivalidatorsValidator::addError()]] для того, чтобы добавить своё сообщение об ошибке в модель:

namespace appcomponents;

use yiivalidatorsValidator;

class CountryValidator extends Validator
{
    public function validateAttribute($model, $attribute)
    {
        if (!in_array($model->$attribute, ['USA', 'Indonesia'])) {
            $this->addError($model, $attribute, 'Страна должна быть либо "{country1}" либо "{country2}".', ['country1' => 'USA', 'country2' => 'Indonesia']);
        }
    }
}

Если вы хотите, чтобы ваш валидатор поддерживал проверку значений без модели, также необходимо переопределить
[[yiivalidatorsValidator::validate()]]. Вы можете также
переопределить [[yiivalidatorsValidator::validateValue()]]
вместо validateAttribute() и validate(), потому что по умолчанию последние два метода
реализуются путем вызова validateValue().

Валидация на стороне клиента

Проверка на стороне клиента на основе JavaScript целесообразна, когда конечные пользователи вводят
входные данные через HTML-формы, так как эта проверка позволяет пользователям узнать ошибки ввода
быстрее и таким образом улучшает ваш пользовательский интерфейс. Вы можете использовать или
реализовать валидатор, который поддерживает валидацию на стороне клиента в дополнение к проверке на стороне сервера.

Info: Проверка на стороне клиента желательна, но необязательна. Её основная цель заключается в
предоставлении пользователям более удобного интерфейса. Так как входные данные, поступают от конечных
пользователей, вы никогда не должны доверять верификации на стороне клиента. По этой причине, вы всегда
должны выполнять верификацию на стороне сервера путем вызова [[yiibaseModel::validate()]],
как описано в предыдущих пунктах.

Использование валидации на стороне клиента

Многие основные валидаторы поддерживают проверку на стороне клиента out-of-the-box.
Все, что вам нужно сделать, это просто использовать [[yiiwidgetsActiveForm]] для построения HTML-форм.

Например, LoginForm ниже объявляет два правила: первое использует required
основной валидатор, который поддерживается на стороне клиента и сервера; второе использует validatePassword
встроенный валидатор, который поддерживается только на стороне сервера.

namespace appmodels;

use yiibaseModel;
use appmodelsUser;

class LoginForm extends Model
{
    public $username;
    public $password;

    public function rules()
    {
        return [
            // username и password обязательны для заполнения
            [['username', 'password'], 'required'],

            // проверке пароля с помощью validatePassword()
            ['password', 'validatePassword'],
        ];
    }

    public function validatePassword()
    {
        $user = User::findByUsername($this->username);

        if (!$user || !$user->validatePassword($this->password)) {
            $this->addError('password', 'Неправильное имя пользователя или пароль.');
        }
    }
}

HTML-форма построена с помощью следующего кода, содержит поля для ввода username и password.
Если вы отправите форму, не вводя ничего, вы получите сообщения об ошибках, требующих ввести данные.
Сообщения появятся сразу, без обращения к серверу.

<?php $form = yiiwidgetsActiveForm::begin(); ?>
    <?= $form->field($model, 'username') ?>
    <?= $form->field($model, 'password')->passwordInput() ?>
    <?= Html::submitButton('Login') ?>
<?php yiiwidgetsActiveForm::end(); ?>

Класс [[yiiwidgetsActiveForm]] будет читать правила проверки заявленные в модели и генерировать
соответствующий код JavaScript для валидаторов, которые поддерживают проверку на стороне клиента.
Когда пользователь изменяет значение поля ввода или отправляет форму, JavaScript на стороне клиента
будет срабатывать и проверять введенные данные.

Если вы хотите отключить проверку на стороне клиента полностью, вы можете настроить свойство
[[yiiwidgetsActiveForm::enableClientValidation]] установив значение false. Вы также можете отключить
проверку на стороне клиента отдельных полей ввода, настроив их с помощью свойства
[[yiiwidgetsActiveField::enableClientValidation]] установив значение false.

Реализация проверки на стороне клиента

Чтобы создать валидатор, который поддерживает проверку на стороне клиента, вы должны реализовать метод
[[yiivalidatorsValidator::clientValidateAttribute()]] возвращающий фрагмент кода JavaScript,
который выполняет проверку на стороне клиента. В JavaScript-коде, вы можете использовать следующие предопределенные переменные:

• attribute: имя атрибута для проверки.
• value: проверяемое значение.
• messages: массив, используемый для хранения сообщений об ошибках проверки значения атрибута.
• deferred: массив, который содержит отложенные объекты (описано в следующем подразделе).

В следующем примере мы создаем StatusValidator который проверяет значение поля на соответствие допустимым статусам.
Валидатор поддерживает оба способа проверки и на стороне сервера и на стороне клиента.

namespace appcomponents;

use yiivalidatorsValidator;
use appmodelsStatus;

class StatusValidator extends Validator
{
    public function init()
    {
        parent::init();
        $this->message = 'Invalid status input.';
    }

    public function validateAttribute($model, $attribute)
    {
        $value = $model->$attribute;
        if (!Status::find()->where(['id' => $value])->exists()) {
            $model->addError($attribute, $this->message);
        }
    }

    public function clientValidateAttribute($model, $attribute, $view)
    {
        $statuses = json_encode(Status::find()->select('id')->asArray()->column());
        $message = json_encode($this->message, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        return <<<JS
if ($.inArray(value, $statuses) === -1) {
    messages.push($message);
}
JS;
    }
}

Tip: приведенный выше код даётся, в основном, чтобы продемонстрировать, как осуществляется
поддержка проверки на стороне клиента. На практике вы можете использовать
in основные валидаторы для достижения той же цели.
Вы можете написать проверку, как правило, например:

[
    ['status', 'in', 'range' => Status::find()->select('id')->asArray()->column()],
]

Отложенная валидация

Если Вам необходимо выполнить асинхронную проверку на стороне клиента, вы можете создавать
Deferred objects. Например, чтобы выполнить
пользовательские AJAX проверки, вы можете использовать следующий код:

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.push($.get("/check", {value: value}).done(function(data) {
            if ('' !== data) {
                messages.push(data);
            }
        }));
JS;
}

В примере выше переменная deferred предусмотренная Yii, которая является массивом Отложенных объектов.
$.get() метод jQuery создает Отложенный объект, который помещается в массив deferred.

Также можно явно создать Отложенный объект и вызвать его методом resolve(), тогда выполняется асинхронный
вызов к серверу. В следующем примере показано, как проверить размеры загружаемого файла изображения
на стороне клиента.

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        var def = $.Deferred();
        var img = new Image();
        img.onload = function() {
            if (this.width > 150) {
                messages.push('Изображение слишком широкое!');
            }
            def.resolve();
        }
        var reader = new FileReader();
        reader.onloadend = function() {
            img.src = reader.result;
        }
        reader.readAsDataURL(file);

        deferred.push(def);
JS;
}

Note: метод resolve() должен быть вызван после того, как атрибут был проверен.
В противном случае основная проверка формы не будет завершена.

Для простоты работы с массивом deferred, существует упрощенный метод add(), который автоматически создает Отложенный объект и добавляет его в deferred массив. Используя этот метод, вы можете упростить пример выше, следующим образом:

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.add(function(def) {
            var img = new Image();
            img.onload = function() {
                if (this.width > 150) {
                    messages.push('Изображение слишком широкое!');
                }
                def.resolve();
            }
            var reader = new FileReader();
            reader.onloadend = function() {
                img.src = reader.result;
            }
            reader.readAsDataURL(file);
        });
JS;
}

AJAX валидация

Некоторые проверки можно сделать только на стороне сервера, потому что только сервер имеет необходимую информацию.
Например, чтобы проверить логин пользователя на уникальность, необходимо проверить логин в
базе данных на стороне сервера. Вы можете использовать проверку на основе AJAX в этом случае.
Это вызовет AJAX-запрос в фоновом режиме, чтобы проверить логин пользователя, сохраняя при этом валидацию
на стороне клиента. Выполняя её перед запросом к серверу.

Чтобы включить AJAX-валидацию для одного поля, Вы должны свойство [[yiiwidgetsActiveField::enableAjaxValidation|enableAjaxValidation]] выбрать как true и указать уникальный id формы:

use yiiwidgetsActiveForm;

$form = ActiveForm::begin([
    'id' => 'registration-form',
]);

echo $form->field($model, 'username', ['enableAjaxValidation' => true]);

// ...

ActiveForm::end();

Чтобы включить AJAX-валидацию для всей формы, Вы должны свойство
[[yiiwidgetsActiveForm::enableAjaxValidation|enableAjaxValidation]] выбрать как true для формы:

$form = yiiwidgetsActiveForm::begin([
    'id' => 'contact-form',
    'enableAjaxValidation' => true,
]);

Note: В случае, если свойство enableAjaxValidation указано и у поля и у формы, первый вариант будет иметь приоритет.

Также необходимо подготовить сервер для обработки AJAX-запросов валидации. Это может быть достигнуто
с помощью следующего фрагмента кода, в контроллере действий:

if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}

Приведенный выше код будет проверять, является ли текущий запрос AJAX. Если да,
он будет отвечать на этот запрос, предварительно выполнив проверку и возвратит ошибки в
случае их появления в формате JSON.

Info: Вы также можете использовать Deferred Validation AJAX валидации.
Однако, AJAX-функция проверки, описанная здесь более интегрированная и требует меньше усилий к написанию кода.

Проверка входящих данных ¶

Как правило, вы никогда не должны доверять данным, полученным от пользователей и всегда проверять их прежде, чем работать с ними и добавлять в базу данных.

Учитывая модель данных которые должен заполнить пользователь, можно проверить эти данные на валидность воспользовавшись методом yiibaseModel::validate(). Метод возвращает логическое значение с результатом валидации ложь/истина. Если данные не валидны, ошибку можно получить воспользовавшись свойством yiibaseModel::$errors. Рассмотрим пример:

Правила проверки ¶

Для того, чтобы validate() действительно работал, нужно объявить правила проверки атрибутов. Правила для проверки нужно указать в методе yiibaseModel::rules(). В следующем примере показано, как правила для проверки модели ContactForm , нужно объявлять:

Метод rules() должен возвращать массив правил, каждое из которых является массивом в следующем формате:

Для каждого правила необходимо указать, по крайней мере, какие атрибуты относится к этому правилу и тип правила. Вы можете указать тип правила в одном из следующих форматов:

• Псевдонимы основного валидатора, например required , in , date и другие. Пожалуйста, обратитесь к списку Основных валидаторов за более подробной информацией.
• Название метода проверки в модели класса, или анонимную функцию. Пожалуйста, обратитесь к разделу Встроенных валидаторов за более подробной информацией.
• Полное имя класса валидатора. Пожалуйста, обратитесь к разделу Автономных валидаторов за более подробной информацией.

Правило может использоваться для проверки одного или нескольких атрибутов. Атрибут может быть проверен одним или несколькими правилами. Правило может быть применено только к определенным сценариям указав свойство on . Если вы не укажите свойство on , это означает, что правило будет применяться ко всем сценариям.

Когда вызывается метод validate() для проверки, он выполняет следующие действия:

1. Определяет, какие атрибуты должны проверяться путем получения списка атрибутов от yiibaseModel::scenarios() используя текущий scenario. Эти атрибуты называются — активными атрибутами.
2. Определяет, какие правила проверки должны использоваться, получив список правил от yiibaseModel::rules() используя текущий scenario. Эти правила называются — активными правилами.
3. Каждое активное правило проверяет каждый активный атрибут, который ассоциируется с правилом. Правила проверки выполняются в том порядке, как они перечислены.

Согласно вышеизложенным пунктам, атрибут будет проверяться, если и только если он является активным атрибутом, объявленным в scenarios() и связан с одним или несколькими активными правилами, объявленными в rules() .

Примечание: Правилам валидации полезно давать имена. Например:

В случае наследования предыдущей модели, именованные правила можно модифицировать или удалить:

Настройка сообщений об ошибках ¶

Большинство валидаторов имеют сообщения об ошибках по умолчанию, которые будут добавлены к модели когда его атрибуты не проходят проверку. Например, required валидатор добавляет к модели сообщение об ошибке «Имя пользователя не может быть пустым.» когда атрибут username не удовлетворил правилу этого валидатора.

Вы можете настроить сообщение об ошибке для каждого правила, указав свойство message при объявлении правила, следующим образом:

Некоторые валидаторы могут поддерживать дополнительные сообщения об ошибках, чтобы более точно описать причину ошибки. Например, number валидатор поддерживает tooBig и tooSmall для описания ошибки валидации, когда проверяемое значение является слишком большим и слишком маленьким, соответственно. Вы можете настроить эти сообщения об ошибках, как в настройках валидаторов, так и непосредственно в правилах проверки.

События валидации ¶

Когда вызывается метод yiibaseModel::validate() он инициализирует вызов двух методов, которые можно переопределить, чтобы настроить процесс проверки:

• yiibaseModel::beforeValidate(): выполнение по умолчанию вызовет yiibaseModel::EVENT_BEFORE_VALIDATE событие. Вы можете переопределить этот метод, или обрабатывать это событие, чтобы сделать некоторую предобработку данных (например, форматирование входных данных), метод вызывается до начала валидации. Этот метод должен возвращать логическое значение, указывающее, следует ли продолжать проверку или нет.
• yiibaseModel::afterValidate(): выполнение по умолчанию вызовет yiibaseModel::EVENT_AFTER_VALIDATE событие. Вы можете либо переопределить этот метод или обрабатывать это событие, чтобы сделать некоторую постобработку данных (например, отформатировать данные удобным для дальнейшей обработки образом), метод вызывается после валидации.

Условные валидации ¶

Для проверки атрибутов только при выполнении определенных условий, например если один атрибут зависит от значения другого атрибута можно использовать when свойство, чтобы определить такие условия. Например:

Это свойство when принимает PHP callable функцию с следующим описанием:

Если вам нужна поддержка условной проверки на стороне клиента, вы должны настроить свойство метода whenClient, которое принимает строку, представляющую JavaScript функцию, возвращаемое значение определяет, следует ли применять правило или нет. Например:

Фильтрация данных ¶

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

В следующих примерах показано, как обрезать пробелы во входных данных и превратить пустые входные данные в NULL с помощью trim и указать значения по умолчанию с помощью свойства default основного валидатора:

Вы также можете использовать более сложные фильтрации данных с помощью анонимной функции подробнее об этом filter.

Как видите, эти правила валидации на самом деле не проверяют входные данные. Вместо этого, они будут обрабатывать значения и обратно возвращать результат работы. Фильтры по сути выполняют предобработку входящих данных.

Обработка пустых входных данных ¶

Если входные данные представлены из HTML-формы, часто нужно присвоить некоторые значения по умолчанию для входных данных, если они не заполнены. Вы можете сделать это с помощью валидатора default. Например:

По умолчанию входные данные считаются пустыми, если их значением является пустая строка, пустой массив или null . Вы можете реализовать свою логику определения пустых входящих данных путем переопределения метода yiivalidatorsValidator::isEmpty() используя анонимную функцию. Например:

Примечание: большинство валидаторов не обрабатывает пустые входные данные, если их yiibaseValidator::skipOnEmpty свойство принимает значение по умолчанию true . Они просто будут пропущены во время проверки, если связанные с ними атрибуты являются пустыми. Среди основных валидаторов, только captcha , default , filter , required , и trim будут обрабатывать пустые входные данные.

Специальная валидация ¶

Иногда вам нужно сделать специальную валидацию для значений, которые не связаны с какой-либо моделью.

Если необходимо выполнить только один тип проверки (например, проверка адреса электронной почты), вы можете вызвать метод validate() нужного валидатора. Например:

Примечание: Не все валидаторы поддерживают такой тип проверки. Примером может служить unique валидатор, который предназначен для работы с моделью.

Примечание: Свойство yiibaseValidator::skipOnEmpty используется только в yiibaseModel и использование его отдельно не будет иметь никакого эффекта.

Если необходимо выполнить несколько проверок в отношении нескольких значений, вы можете использовать yiibaseDynamicModel, который поддерживает объявление, как атрибутов так и правил «на лету». Его использование выглядит следующим образом:

Метод yiibaseDynamicModel::validateData() создает экземпляр DynamicModel , определяет атрибуты, используя приведенные данные ( name и email в этом примере), и затем вызывает yiibaseModel::validate() с данными правилами.

Кроме того, вы можете использовать следующий «классический» синтаксис для выполнения специальной проверки данных:

После валидации, вы можете проверить успешность выполнения вызвав метод hasErrors() и затем получить ошибки проверки вызвав метод errors как это делают нормальные модели. Вы можете также получить доступ к динамическим атрибутам, определенным через экземпляр модели, например, $model->name и $model->email .

Создание Валидаторов ¶

Кроме того, используя основные валидаторы, включенные в релизы Yii, вы также можете создавать свои собственные валидаторы. Вы можете создавать встроенные валидаторы или автономные валидаторы.

Встроенные Валидаторы ¶

Встроенный валидатор наследует методы модели или использует анонимную функцию. Описание метода/функции:

Если атрибут не прошел проверку, метод/функция должна вызвать yiibaseModel::addError(), чтобы сохранить сообщение об ошибке в модели, для того чтобы позже можно было получить сообщение об ошибке для представления конечным пользователям.

Ниже приведены некоторые примеры:

Примечание: по умолчанию, встроенные валидаторы не будут применяться, если связанные с ними атрибуты получат пустые входные данные, или если они уже не смогли пройти некоторые правила валидации. Если вы хотите, чтобы, это правило применялось всегда, вы можете настроить свойства skipOnEmpty и/или skipOnError свойства false в правиле объявления. Например:

Автономные валидаторы ¶

Автономный валидатор — это класс, расширяющий yiivalidatorsValidator или его дочерний класс. Вы можете реализовать свою логику проверки путем переопределения метода yiivalidatorsValidator::validateAttribute(). Если атрибут не прошел проверку, вызвать yiibaseModel::addError(), чтобы сохранить сообщение об ошибке в модели, как это делают встроенные валидаторы.

Валидация может быть помещена в отдельный класс [[components/validators/CountryValidator]]. В этом случае можно использовать метод yiivalidatorsValidator::addError() для того, чтобы добавить своё сообщение об ошибке в модель:

Если вы хотите, чтобы ваш валидатор поддерживал проверку значений без модели, также необходимо переопределить yiivalidatorsValidator::validate(). Вы можете также переопределить yiivalidatorsValidator::validateValue() вместо validateAttribute() и validate() , потому что по умолчанию последние два метода реализуются путем вызова validateValue() .

Валидация на стороне клиента ¶

Проверка на стороне клиента на основе JavaScript целесообразна, когда конечные пользователи вводят входные данные через HTML-формы, так как эта проверка позволяет пользователям узнать ошибки ввода быстрее и таким образом улучшает ваш пользовательский интерфейс. Вы можете использовать или реализовать валидатор, который поддерживает валидацию на стороне клиента в дополнение к проверке на стороне сервера.

Информация: Проверка на стороне клиента желательна, но необязательна. Её основная цель заключается в предоставлении пользователям более удобного интерфейса. Так как входные данные, поступают от конечных пользователей, вы никогда не должны доверять верификации на стороне клиента. По этой причине, вы всегда должны выполнять верификацию на стороне сервера путем вызова yiibaseModel::validate(), как описано в предыдущих пунктах.

Использование валидации на стороне клиента ¶

Многие основные валидаторы поддерживают проверку на стороне клиента out-of-the-box. Все, что вам нужно сделать, это просто использовать yiiwidgetsActiveForm для построения HTML-форм.

Например, LoginForm ниже объявляет два правила: первое использует required основной валидатор, который поддерживается на стороне клиента и сервера; второе использует validatePassword встроенный валидатор, который поддерживается только на стороне сервера.

HTML-форма построена с помощью следующего кода, содержит поля для ввода username и password . Если вы отправите форму, не вводя ничего, вы получите сообщения об ошибках, требующих ввести данные. Сообщения появятся сразу, без обращения к серверу.

Класс yiiwidgetsActiveForm будет читать правила проверки заявленные в модели и генерировать соответствующий код JavaScript для валидаторов, которые поддерживают проверку на стороне клиента. Когда пользователь изменяет значение поля ввода или отправляет форму, JavaScript на стороне клиента будет срабатывать и проверять введенные данные.

Если вы хотите отключить проверку на стороне клиента полностью, вы можете настроить свойство yiiwidgetsActiveForm::$enableClientValidation установив значение false . Вы также можете отключить проверку на стороне клиента отдельных полей ввода, настроив их с помощью свойства yiiwidgetsActiveField::$enableClientValidation установив значение false .

Реализация проверки на стороне клиента ¶

Чтобы создать валидатор, который поддерживает проверку на стороне клиента, вы должны реализовать метод yiivalidatorsValidator::clientValidateAttribute() возвращающий фрагмент кода JavaScript, который выполняет проверку на стороне клиента. В JavaScript-коде, вы можете использовать следующие предопределенные переменные:

• attribute : имя атрибута для проверки.
• value : проверяемое значение.
• messages : массив, используемый для хранения сообщений об ошибках проверки значения атрибута.
• deferred : массив, который содержит отложенные объекты (описано в следующем подразделе).

В следующем примере мы создаем StatusValidator который проверяет значение поля на соответствие допустимым статусам. Валидатор поддерживает оба способа проверки и на стороне сервера и на стороне клиента.

Подсказка: приведенный выше код даётся, в основном, чтобы продемонстрировать, как осуществляется поддержка проверки на стороне клиента. На практике вы можете использовать in основные валидаторы для достижения той же цели. Вы можете написать проверку, как правило, например:

Отложенная валидация ¶

Если Вам необходимо выполнить асинхронную проверку на стороне клиента, вы можете создавать Deferred objects. Например, чтобы выполнить пользовательские AJAX проверки, вы можете использовать следующий код:

В примере выше переменная deferred предусмотренная Yii, которая является массивом Отложенных объектов. $.get() метод jQuery создает Отложенный объект, который помещается в массив deferred .

Также можно явно создать Отложенный объект и вызвать его методом resolve() , тогда выполняется асинхронный вызов к серверу. В следующем примере показано, как проверить размеры загружаемого файла изображения на стороне клиента.

Примечание: метод resolve() должен быть вызван после того, как атрибут был проверен. В противном случае основная проверка формы не будет завершена.

Для простоты работы с массивом deferred , существует упрощенный метод add() , который автоматически создает Отложенный объект и добавляет его в deferred массив. Используя этот метод, вы можете упростить пример выше, следующим образом:

AJAX валидация ¶

Некоторые проверки можно сделать только на стороне сервера, потому что только сервер имеет необходимую информацию. Например, чтобы проверить логин пользователя на уникальность, необходимо проверить логин в базе данных на стороне сервера. Вы можете использовать проверку на основе AJAX в этом случае. Это вызовет AJAX-запрос в фоновом режиме, чтобы проверить логин пользователя, сохраняя при этом валидацию на стороне клиента. Выполняя её перед запросом к серверу.

Чтобы включить AJAX-валидацию для одного поля, Вы должны свойство enableAjaxValidation выбрать как true и указать уникальный id формы:

Чтобы включить AJAX-валидацию для всей формы, Вы должны свойство enableAjaxValidation выбрать как true для формы:

Примечание: В случае, если свойство enableAjaxValidation указано и у поля и у формы, первый вариант будет иметь приоритет.

Также необходимо подготовить сервер для обработки AJAX-запросов валидации. Это может быть достигнуто с помощью следующего фрагмента кода, в контроллере действий:

Приведенный выше код будет проверять, является ли текущий запрос AJAX. Если да, он будет отвечать на этот запрос, предварительно выполнив проверку и возвратит ошибки в случае их появления в формате JSON.

Информация: Вы также можете использовать Deferred Validation AJAX валидации. Однако, AJAX-функция проверки, описанная здесь более интегрированная и требует меньше усилий к написанию кода.

Источник

Как правило, вы никогда не должны доверять данным, полученным от конечных пользователей, и всегда должны проверять его, прежде чем использовать его.

Для модели, заполненной пользовательскими вводами, вы можете проверить входные данные, вызвав метод yiibaseModel::validate(). Метод вернет логическое значение, указывающее, успешно ли выполнена проверка. Если нет, вы можете получить сообщения об ошибках из свойства yiibaseModel::$errors. Например:

$model = new appmodelsContactForm();

// populate model attributes with user inputs
$model->load(Yii::$app->request->post());
// which is equivalent to the following:
// $model->attributes = Yii::$app->request->post('ContactForm');

if ($model->validate()) {
    // all inputs are valid
} else {
    // validation failed: $errors is an array containing error messages
    $errors = $model->errors;
}

Объявление правил

Чтобы заставить validate () работать действительно, вы должны объявить правила проверки для атрибутов, которые вы планируете проверять. Это должно быть сделано путем переопределения метода yiibaseModel::rules(). В следующем примере показано, как объявляются правила проверки для модели ContactForm:

public function rules()
{
    return [
        // the name, email, subject and body attributes are required
        [['name', 'email', 'subject', 'body'], 'required'],

        // the email attribute should be a valid email address
        ['email', 'email'],
    ];
}

Метод rules() должен возвращать массив правил, каждый из которых представляет собой массив следующего формата:

[
    // required, specifies which attributes should be validated by this rule.
    // For a single attribute, you can use the attribute name directly
    // without having it in an array
    ['attribute1', 'attribute2', ...],

    // required, specifies the type of this rule.
    // It can be a class name, validator alias, or a validation method name
    'validator',

    // optional, specifies in which scenario(s) this rule should be applied
    // if not given, it means the rule applies to all scenarios
    // You may also configure the "except" option if you want to apply the rule
    // to all scenarios except the listed ones
    'on' => ['scenario1', 'scenario2', ...],

    // optional, specifies additional configurations for the validator object
    'property1' => 'value1', 'property2' => 'value2', ...
]

Для каждого правила вы должны указать, по крайней мере, какие атрибуты применяет правило и какой тип правила. Вы можете указать тип правила в одной из следующих форм:

• Псевдоним основного валидатора, например, required, in, date и т. д.
• Имя метода проверки в классе модели или анонимную функцию. 
• Полное имя класса валидатора. 

Правило может использоваться для проверки одного или нескольких атрибутов, а атрибут может быть проверен одним или несколькими правилами. Правило может применяться в определенных сценариях только путем указания опции включения. Если вы не укажете опцию on, это означает, что правило будет применено ко всем сценариям.

Когда вызывается метод validate(), для выполнения проверки выполняются следующие шаги:

1. Определите, какие атрибуты должны проверяться путем получения списка атрибутов из yiibaseModel::scenarios() с использованием текущего сценария. Эти атрибуты называются активными атрибутами.
2. Определите, какие правила проверки следует использовать, получая список правил из yiibaseModel::rules() с использованием текущего сценария. Эти правила называются активными правилами.
3. Используйте каждое активное правило для проверки каждого активного атрибута, связанного с этим правилом. Правила проверки проверяются в порядке их перечисления.

Согласно вышеописанным шагам проверки атрибут будет проверен тогда и только тогда, когда он является активным атрибутом, объявленным в scenarios(), и связан с одним или несколькими активными правилами, объявленными в rules().

Настройка сообщений об ошибках

Большинство валидаторов имеют сообщения об ошибках по умолчанию, которые будут добавлены в проверяемую модель, если ее атрибуты не пройдут проверку. Например, требуемый валидатор добавит сообщение «Имя пользователя не может быть пустым». К модели, когда атрибут username выдает ошибку с использованием этого валидатора.

Вы можете настроить сообщение об ошибке правила, указав свойство message при объявлении правила, например:

public function rules()
{
    return [
        ['username', 'required', 'message' => 'Please choose a username.'],
    ];
}

Некоторые валидаторы могут поддерживать дополнительные сообщения об ошибках, чтобы точнее описывать различные причины сбоев валидации. Например, средство проверки числа поддерживает tooBig и tooSmall, чтобы описать отказ проверки, когда проверяемое значение слишком велико и слишком мало, соответственно. Вы можете настроить эти сообщения об ошибках, например, настроить другие свойства валидаторов в правиле проверки.

События проверки

Когда вызывается yiibaseModel::validate(), он вызовет два метода, которые вы можете переопределить, чтобы настроить процесс валидации:

• yiibaseModel::beforeValidate(): реализация по умолчанию вызовет событие yiibaseModel::EVENT_BEFORE_VALIDATE. Вы можете либо переопределить этот метод, либо ответить на это событие, чтобы выполнить некоторую работу по препроцессорному процессу (например, нормализовать ввод данных) до того, как произойдет проверка. Метод должен возвращать логическое значение, указывающее, следует ли продолжать проверку или нет.
• yiibaseModel::afterValidate(): реализация по умолчанию вызовет событие yiibaseModel::EVENT_AFTER_VALIDATE. Вы можете либо переопределить этот метод, либо ответить на это событие, чтобы выполнить некоторую постобработку после завершения проверки.

Условная проверка

Проверка атрибутов только при определенных условиях, например. Проверка одного атрибута зависит от значения другого атрибута, который можно использовать для свойства when, чтобы определить такие условия. Например:

  ['state', 'required', 'when' => function($model) {
        return $model->country == 'USA';
    }]

Свойство when принимает вызов PHP со следующей сигнатурой:

/**
 * @param Model $model the model being validated
 * @param string $attribute the attribute being validated
 * @return bool whether the rule should be applied
 */
function ($model, $attribute)

Если вам также нужно поддерживать условную проверку на стороне клиента, вы должны настроить свойство whenClient, которое принимает строку, представляющую функцию JavaScript, возвращаемое значение которой определяет, применять это правило или нет. Например:

  ['state', 'required', 'when' => function ($model) {
        return $model->country == 'USA';
    }, 'whenClient' => "function (attribute, value) {
        return $('#country').val() == 'USA';
    }"]

Фильтрация данных

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

В следующих примерах показано, как обрезать пробелы на входах и превращать пустые вводы в значения NULL, используя trim и default валидаторы ядра:

return [
    [['username', 'email'], 'trim'],
    [['username', 'email'], 'default'],
];

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

Обработка пустых входов

Когда входные данные передаются из форм HTML, вам часто приходится присваивать некоторым значениям по умолчанию входы, если они пусты. Вы можете это сделать, используя валидатор по умолчанию. Например:

return [
    // set "username" and "email" as null if they are empty
    [['username', 'email'], 'default'],

    // set "level" to be 1 if it is empty
    ['level', 'default', 'value' => 1],
];

По умолчанию вход считается пустым, если его значением является пустая строка, пустой массив или null. Вы можете настроить пустую логику обнаружения по умолчанию, настроив свойство yiivalidatorsValidator::isEmpty() с возможностью вызова PHP. Например:

  ['agree', 'required', 'isEmpty' => function ($value) {
        return empty($value);
    }]

Специальная проверка

Иногда вам нужно выполнить специальную проверку для значений, которые не привязаны к какой-либо модели. Если вам нужно выполнить только один тип проверки (например, проверку адресов электронной почты), вы можете вызвать метод validate() нужного валидатора, например:

$email = 'test@example.com';
$validator = new yiivalidatorsEmailValidator();

if ($validator->validate($email, $error)) {
    echo 'Email is valid.';
} else {
    echo $error;
}

Если вам нужно выполнить несколько проверок против нескольких значений, вы можете использовать yiibaseDynamicModel, которая поддерживает объявление атрибутов и правил на лету. Его использование выглядит следующим образом:

public function actionSearch($name, $email)
{
    $model = DynamicModel::validateData(compact('name', 'email'), [
        [['name', 'email'], 'string', 'max' => 128],
        ['email', 'email'],
    ]);

    if ($model->hasErrors()) {
        // validation fails
    } else {
        // validation succeeds
    }
}

Метод yiibaseDynamicModel::validateData() создает экземпляр DynamicModel, определяет атрибуты, используя данные (name и email в этом примере), а затем вызывает yiibaseModel::validate() с заданным правилом. В качестве альтернативы вы можете использовать следующий более «классический» синтаксис для выполнения проверки данных:

public function actionSearch($name, $email)
{
    $model = new DynamicModel(compact('name', 'email'));
    $model->addRule(['name', 'email'], 'string', ['max' => 128])
        ->addRule('email', 'email')
        ->validate();

    if ($model->hasErrors()) {
        // validation fails
    } else {
        // validation succeeds
    }
}

После проверки вы можете проверить, удалось ли выполнить проверку, или нет, вызвав метод hasErrors(), а затем получить ошибки проверки из свойства errors, как это делается с обычной моделью. Вы также можете получить доступ к динамическим атрибутам, определенным через экземпляр модели, например, $model->name и $model->email.

Создание валидаторов

Помимо использования основных валидаторов, включенных в выпуски Yii, вы также можете создать свои собственные валидаторы. Вы можете создавать встроенные валидаторы или автономные валидаторы.

Встроенные валидаторы

Встроенный валидатор — это единица, определенная с точки зрения модельного метода или анонимной функции. Подпись метода/функции:

/**
 * @param string $attribute the attribute currently being validated
 * @param mixed $params the value of the "params" given in the rule
 * @param yiivalidatorsInlineValidator related InlineValidator instance.
 * This parameter is available since version 2.0.11.
 */
function ($attribute, $params, $validator)

Если атрибут терпит неудачу при проверке, метод/функция должен вызвать yiibaseModel::addError(), чтобы сохранить сообщение об ошибке в модели, чтобы оно могло быть возвращено позже, чтобы представить конечным пользователям.

Ниже приведены некоторые примеры:

use yiibaseModel;

class MyForm extends Model
{
    public $country;
    public $token;

    public function rules()
    {
        return [
            // an inline validator defined as the model method validateCountry()
            ['country', 'validateCountry'],

            // an inline validator defined as an anonymous function
            ['token', function ($attribute, $params, $validator) {
                if (!ctype_alnum($this->$attribute)) {
                    $this->addError($attribute, 'The token must contain letters or digits.');
                }
            }],
        ];
    }

    public function validateCountry($attribute, $params, $validator)
    {
        if (!in_array($this->$attribute, ['USA', 'Web'])) {
            $this->addError($attribute, 'The country must be either "USA" or "Web".');
        }
    }
}

Автономные валидаторы

Автономный валидатор — это класс, расширяющий yiivalidatorsValidator или его дочерний класс. Вы можете реализовать свою логику валидации, переопределив метод yiivalidatorsValidator::validateAttribute(). Если атрибут не прошел проверку, вызовите yiibaseModel::addError(), чтобы сохранить сообщение об ошибке в модели, как это делается с встроенными валидаторами.

Например, встроенный валидатор выше может быть перемещен в новый класс [[components/validators/CountryValidator]].

namespace appcomponents;

use yiivalidatorsValidator;

class CountryValidator extends Validator
{
    public function validateAttribute($model, $attribute)
    {
        if (!in_array($model->$attribute, ['USA', 'Web'])) {
            $this->addError($model, $attribute, 'The country must be either "USA" or "Web".');
        }
    }
}

Если вы хотите, чтобы ваш валидатор поддерживал проверку значения без модели, вы также должны переопределить yiivalidatorsValidator::validate(). Вы также можете переопределить yiivalidatorsValidator::validateValue() вместо validateAttribute() и validate(), потому что по умолчанию последние два метода реализуются вызовом validateValue().

Ниже приведен пример того, как вы могли бы использовать вышеуказанный класс валидатора в вашей модели.

namespace appmodels;

use Yii;
use yiibaseModel;
use appcomponentsvalidatorsCountryValidator;

class EntryForm extends Model
{
    public $name;
    public $email;
    public $country;

    public function rules()
    {
        return [
            [['name', 'email'], 'required'],
            ['country', CountryValidator::className()],
            ['email', 'email'],
        ];
    }
}

Проверка множественных атрибутов

Иногда валидаторы включают несколько атрибутов. Рассмотрим следующую форму:

class MigrationForm extends yiibaseModel
{
    /**
     * Minimal funds amount for one adult person
     */
    const MIN_ADULT_FUNDS = 3000;
    /**
     * Minimal funds amount for one child
     */
    const MIN_CHILD_FUNDS = 1500;

    public $personalSalary;
    public $spouseSalary;
    public $childrenCount;
    public $description;

    public function rules()
    {
        return [
            [['personalSalary', 'description'], 'required'],
            [['personalSalary', 'spouseSalary'], 'integer', 'min' => self::MIN_ADULT_FUNDS],
            ['childrenCount', 'integer', 'min' => 0, 'max' => 5],
            [['spouseSalary', 'childrenCount'], 'default', 'value' => 0],
            ['description', 'string'],
        ];
    }
}

Создание валидатора

Скажем, нам нужно проверить, достаточно ли семейного дохода для детей. Мы можем создать встроенный валидатор validateChildrenFunds для того, что будет работать, только когда childrenCount больше 0.

Обратите внимание, что мы не можем использовать все проверенные атрибуты (['personalSalary', 'spouseSalary', 'childrenCount']) при прикреплении валидатора. Это связано с тем, что один и тот же валидатор будет запускаться для каждого атрибута (всего три раза), и нам нужно всего один раз запустить его для всего набора атрибутов.

Вы можете использовать любой из этих атрибутов (или использовать то, что вы считаете наиболее релевантным):

['childrenCount', 'validateChildrenFunds', 'when' => function ($model) {
    return $model->childrenCount > 0;
}],

Реализация validateChildrenFunds может быть такой:

public function validateChildrenFunds($attribute, $params)
{
    $totalSalary = $this->personalSalary + $this->spouseSalary;
    // Double the minimal adult funds if spouse salary is specified
    $minAdultFunds = $this->spouseSalary ? self::MIN_ADULT_FUNDS * 2 : self::MIN_ADULT_FUNDS;
    $childFunds = $totalSalary - $minAdultFunds;
    if ($childFunds / $this->childrenCount < self::MIN_CHILD_FUNDS) {
        $this->addError('childrenCount', 'Your salary is not enough for children.');
    }
}

Вы можете игнорировать параметр $attribute, потому что проверка не связана с одним атрибутом.

Добавление ошибок

Добавление ошибки в случае нескольких атрибутов может варьироваться в зависимости от желаемой формы:

• Выберите, по вашему мнению, наиболее релевантное поле и добавьте ошибку в его атрибут:

$this->addError('childrenCount', 'Your salary is not enough for children.');

• Выберите несколько важных релевантных атрибутов или все атрибуты и добавьте к ним одно и то же сообщение об ошибке. Мы можем хранить сообщение в отдельной переменной перед передачей его в addError, чтобы сохранить код DRY.

$message = 'Your salary is not enough for children.';
$this->addError('personalSalary', $message);
$this->addError('wifeSalary', $message);
$this->addError('childrenCount', $message);

Или используйте цикл:

$attributes = ['personalSalary, 'wifeSalary', 'childrenCount'];
foreach ($attributes as $attribute) {
    $this->addError($attribute, 'Your salary is not enough for children.');
}

• Добавьте общую ошибку (не связанную с конкретным атрибутом). Мы можем использовать несуществующее имя атрибута для добавления ошибки, например *, потому что существование атрибута в этой точке не проверяется.

$this->addError('*', 'Your salary is not enough for children.');

В результате мы не увидим сообщение об ошибке возле полей формы. Чтобы отобразить его, мы можем включить в отчет информацию об ошибках:

<?= $form->errorSummary($model) ?>

Проверка на стороне клиента

Проверка на стороне клиента, основанная на JavaScript, желательна, когда конечные пользователи предоставляют входные данные через формы HTML, так как это позволяет пользователям быстрее находить входные ошибки и, таким образом, обеспечивает лучший пользовательский опыт. Вы можете использовать или внедрять валидатор, который поддерживает проверку на стороне клиента в дополнение к проверке на стороне сервера.

Использование проверки на стороне клиента

Многие валидаторы ядра поддерживают проверку подлинности на клиентской стороне. Все, что вам нужно сделать, это просто использовать yiiwidgetsActiveForm для создания ваших HTML-форм. Например, LoginForm ниже объявляет два правила: один использует необходимый валидатор ядра, который поддерживается как на стороне клиента, так и на стороне сервера; Другой использует валидатор validatePassword, который поддерживается только на стороне сервера.

namespace appmodels;

use yiibaseModel;
use appmodelsUser;

class LoginForm extends Model
{
    public $username;
    public $password;

    public function rules()
    {
        return [
            // username and password are both required
            [['username', 'password'], 'required'],

            // password is validated by validatePassword()
            ['password', 'validatePassword'],
        ];
    }

    public function validatePassword()
    {
        $user = User::findByUsername($this->username);

        if (!$user || !$user->validatePassword($this->password)) {
            $this->addError('password', 'Incorrect username or password.');
        }
    }
}

Форма HTML, созданная следующим кодом, содержит два поля ввода username и password. Если вы отправите форму без ввода чего-либо, вы обнаружите, что сообщения об ошибках, требующие ввода чего-либо, появятся сразу же без связи с сервером.

<?php $form = yiiwidgetsActiveForm::begin(); ?>
    <?= $form->field($model, 'username') ?>
    <?= $form->field($model, 'password')->passwordInput() ?>
    <?= Html::submitButton('Login') ?>
<?php yiiwidgetsActiveForm::end(); ?>

За сценой yiiwidgetsActiveForm будет читать правила проверки, объявленные в модели, и генерировать соответствующий код JavaScript для валидаторов, которые поддерживают проверку на стороне клиента. Когда пользователь изменяет значение поля ввода или отправляет форму, активируется JavaScript-код проверки на стороне клиента.

Если вы хотите полностью отключить проверку на стороне клиента, вы можете настроить свойство yiiwidgetsActiveForm::$enableClientValidation как false. Вы также можете отключить проверку на стороне клиента отдельных полей ввода, настроив их свойство yiiwidgetsActiveField::$enableClientValidation как false. Когда enableClientValidation настроен как на уровне поля ввода, так и на уровне формы, приоритет будет иметь первый.

Внедрение проверки на стороне клиента

Чтобы создать валидатор, поддерживающий проверку на стороне клиента, вы должны реализовать метод yiivalidatorsValidator::clientValidateAttribute(), который возвращает фрагмент кода JavaScript, который выполняет проверку на стороне клиента. В коде JavaScript вы можете использовать следующие предопределенные переменные:

• attribute: имя проверяемого атрибута.
• value: проверяемое значение.
• messages: массив, используемый для хранения сообщений об ошибках проверки для этого атрибута.
• deferred: массив, в который могут быть помещены отложенные объекты.

В следующем примере мы создаем StatusValidator, который проверяет, является ли вход действительным входом состояния в сравнении с существующими данными состояния. Валидатор поддерживает как проверку на стороне сервера, так и проверку на стороне клиента.

namespace appcomponents;

use yiivalidatorsValidator;
use appmodelsStatus;

class StatusValidator extends Validator
{
    public function init()
    {
        parent::init();
        $this->message = 'Invalid status input.';
    }

    public function validateAttribute($model, $attribute)
    {
        $value = $model->$attribute;
        if (!Status::find()->where(['id' => $value])->exists()) {
            $model->addError($attribute, $this->message);
        }
    }

    public function clientValidateAttribute($model, $attribute, $view)
    {
        $statuses = json_encode(Status::find()->select('id')->asArray()->column());
        $message = json_encode($this->message, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        return <<<JS
if ($.inArray(value, $statuses) === -1) {
    messages.push($message);
}
JS;
    }
}

Отложенная валидация

Если вам нужно выполнить асинхронную проверку на стороне клиента, вы можете создать объекты Deferred. Например, чтобы выполнить настраиваемую проверку AJAX, вы можете использовать следующий код:

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.push($.get("/check", {value: value}).done(function(data) {
            if ('' !== data) {
                messages.push(data);
            }
        }));
JS;
}

В приведенном выше отложенная переменная предоставляется Yii, которая является массивом отложенных объектов. Метод $.get() jQuery создает объект deferred, который помещается в отложенный массив.

Вы также можете явно создать объект deferred и вызвать его метод resolve() при ударе асинхронного обратного вызова. В следующем примере показано, как проверить размеры загруженного файла изображения на стороне клиента.

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        var def = $.Deferred();
        var img = new Image();
        img.onload = function() {
            if (this.width > 150) {
                messages.push('Image too wide!!');
            }
            def.resolve();
        }
        var reader = new FileReader();
        reader.onloadend = function() {
            img.src = reader.result;
        }
        reader.readAsDataURL(file);

        deferred.push(def);
JS;
}

Для простоты deferred массив снабжен специальным методом add(), который автоматически создает объект deferred и добавляет его в отложенный массив. Используя этот метод, вы можете упростить приведенный выше пример следующим образом:

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.add(function(def) {
            var img = new Image();
            img.onload = function() {
                if (this.width > 150) {
                    messages.push('Image too wide!!');
                }
                def.resolve();
            }
            var reader = new FileReader();
            reader.onloadend = function() {
                img.src = reader.result;
            }
            reader.readAsDataURL(file);
        });
JS;
}

Проверка AJAX

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

Чтобы включить проверку AJAX для одного поля ввода, настройте для свойства enableAjaxValidation этого поля значение true и укажите id формы:

use yiiwidgetsActiveForm;

$form = ActiveForm::begin([
    'id' => 'registration-form',
]);

echo $form->field($model, 'username', ['enableAjaxValidation' => true]);

// ...

ActiveForm::end();

Чтобы включить проверку AJAX для всей формы, настройте enableAjaxValidation на уровне формы:

$form = ActiveForm::begin([
    'id' => 'contact-form',
    'enableAjaxValidation' => true,
]);

Вам также необходимо подготовить сервер, чтобы он мог обрабатывать запросы проверки AJAX. Этого можно добиться с помощью фрагмента кода, подобного следующему в действиях контроллера:

if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}

Вышеприведенный код проверит, является ли текущий запрос AJAX. Если да, то он ответит на этот запрос, выполнив проверку и возвратив ошибки в формате JSON. Если для обоих enableClientValidation и enableAjaxValidation установлено значение true, запрос проверки AJAX будет запущен только после успешной проверки клиента.

As a rule of thumb, you should never trust the data received from end users and should always validate it
before putting it to good use.

Given a model populated with user inputs, you can validate the inputs by calling the
yiibaseModel::validate() method. The method will return a boolean value indicating whether the validation
succeeded or not. If not, you may get the error messages from the yiibaseModel::$errors property. For example,

$model = new appmodelsContactForm();

// populate model attributes with user inputs
$model->load(Yii::$app->request->post());
// which is equivalent to the following:
// $model->attributes = Yii::$app->request->post('ContactForm');

if ($model->validate()) {
    // all inputs are valid
} else {
    // validation failed: $errors is an array containing error messages
    $errors = $model->errors;
}

Declaring Rules ¶

To make validate() really work, you should declare validation rules for the attributes you plan to validate.
This should be done by overriding the yiibaseModel::rules() method. The following example shows how
the validation rules for the ContactForm model are declared:

public function rules()
{
    return [
        // the name, email, subject and body attributes are required
        [['name', 'email', 'subject', 'body'], 'required'],

        // the email attribute should be a valid email address
        ['email', 'email'],
    ];
}

The rules() method should return an array of rules, each of which is an array
of the following format:

[
    // required, specifies which attributes should be validated by this rule.
    // For a single attribute, you can use the attribute name directly
    // without having it in an array
    ['attribute1', 'attribute2', ...],

    // required, specifies the type of this rule.
    // It can be a class name, validator alias, or a validation method name
    'validator',

    // optional, specifies in which scenario(s) this rule should be applied
    // if not given, it means the rule applies to all scenarios
    // You may also configure the "except" option if you want to apply the rule
    // to all scenarios except the listed ones
    'on' => ['scenario1', 'scenario2', ...],

    // optional, specifies additional configurations for the validator object
    'property1' => 'value1', 'property2' => 'value2', ...
]

For each rule you must specify at least which attributes the rule applies to and what is the type of the rule.
You can specify the rule type in one of the following forms:

• the alias of a core validator, such as required, in, date, etc. Please refer to
  the Core Validators for the complete list of core validators.
• the name of a validation method in the model class, or an anonymous function. Please refer to the
  Inline Validators subsection for more details.
• a fully qualified validator class name. Please refer to the Standalone Validators
  subsection for more details.

A rule can be used to validate one or multiple attributes, and an attribute may be validated by one or multiple rules.
A rule may be applied in certain scenarios only by specifying the on option.
If you do not specify an on option, it means the rule will be applied to all scenarios.

When the validate() method is called, it does the following steps to perform validation:

1. Determine which attributes should be validated by getting the attribute list from yiibaseModel::scenarios()
   using the current scenario. These attributes are called active attributes.
2. Determine which validation rules should be used by getting the rule list from yiibaseModel::rules()
   using the current scenario. These rules are called active rules.
3. Use each active rule to validate each active attribute which is associated with the rule.
   The validation rules are evaluated in the order they are listed.

According to the above validation steps, an attribute will be validated if and only if it is
an active attribute declared in scenarios() and is associated with one or multiple active rules
declared in rules().

Note: It is handy to give names to rules i.e.

public function rules()
{
    return [
        // ...
        'password' => [['password'], 'string', 'max' => 60],
    ];
}

You can use it in a child model:

public function rules()
{
    $rules = parent::rules();
    unset($rules['password']);
    return $rules;
}

Customizing Error Messages ¶

Most validators have default error messages that will be added to the model being validated when its attributes
fail the validation. For example, the required validator will add
a message «Username cannot be blank.» to a model when the username attribute fails the rule using this validator.

You can customize the error message of a rule by specifying the message property when declaring the rule,
like the following,

public function rules()
{
    return [
        ['username', 'required', 'message' => 'Please choose a username.'],
    ];
}

Some validators may support additional error messages to more precisely describe different causes of
validation failures. For example, the number validator supports
tooBig and tooSmall
to describe the validation failure when the value being validated is too big and too small, respectively.
You may configure these error messages like configuring other properties of validators in a validation rule.

Validation Events ¶

When yiibaseModel::validate() is called, it will call two methods that you may override to customize
the validation process:

• yiibaseModel::beforeValidate(): the default implementation will trigger a yiibaseModel::EVENT_BEFORE_VALIDATE
  event. You may either override this method or respond to this event to do some preprocessing work
  (e.g. normalizing data inputs) before the validation occurs. The method should return a boolean value indicating
  whether the validation should proceed or not.
• yiibaseModel::afterValidate(): the default implementation will trigger a yiibaseModel::EVENT_AFTER_VALIDATE
  event. You may either override this method or respond to this event to do some postprocessing work after
  the validation is completed.

Conditional Validation ¶

To validate attributes only when certain conditions apply, e.g. the validation of one attribute depends
on the value of another attribute you can use the when property
to define such conditions. For example,

    ['state', 'required', 'when' => function($model) {
        return $model->country == 'USA';
    }]

The when property takes a PHP callable with the following signature:

/**
 * @param Model $model the model being validated
 * @param string $attribute the attribute being validated
 * @return bool whether the rule should be applied
 */
function ($model, $attribute)

If you also need to support client-side conditional validation, you should configure
the whenClient property which takes a string representing a JavaScript
function whose return value determines whether to apply the rule or not. For example,

    ['state', 'required', 'when' => function ($model) {
        return $model->country == 'USA';
    }, 'whenClient' => "function (attribute, value) {
        return $('#country').val() == 'USA';
    }"]

Data Filtering ¶

User inputs often need to be filtered or preprocessed. For example, you may want to trim the spaces around the
username input. You may use validation rules to achieve this goal.

The following examples shows how to trim the spaces in the inputs and turn empty inputs into nulls by using
the trim and default core validators:

return [
    [['username', 'email'], 'trim'],
    [['username', 'email'], 'default'],
];

You may also use the more general filter validator to perform more complex
data filtering.

As you can see, these validation rules do not really validate the inputs. Instead, they will process the values
and save them back to the attributes being validated.

A complete processing of user input is shown in the following example code, which will ensure only integer
values are stored in an attribute:

['age', 'trim'],
['age', 'default', 'value' => null],
['age', 'integer', 'min' => 0],
['age', 'filter', 'filter' => 'intval', 'skipOnEmpty' => true],

The above code will perform the following operations on the input:

1. Trim whitespace from the input value.
2. Make sure empty input is stored as null in the database; we differentiate between a value being «not set»
   and the actual value 0. If null is not allowed you can set another default value here.
3. Validate that the value is an integer greater than 0 if it is not empty. Normal validators have
   $skipOnEmpty set to true.
4. Make sure the value is of type integer, e.g. casting a string '42' to integer 42.
   Here we set $skipOnEmpty to true, which is false by default
   on the filter validator.

Handling Empty Inputs ¶

When input data are submitted from HTML forms, you often need to assign some default values to the inputs
if they are empty. You can do so by using the default validator. For example,

return [
    // set "username" and "email" as null if they are empty
    [['username', 'email'], 'default'],

    // set "level" to be 1 if it is empty
    ['level', 'default', 'value' => 1],
];

By default, an input is considered empty if its value is an empty string, an empty array or a null.
You may customize the default empty detection logic by configuring the yiivalidatorsValidator::isEmpty() property
with a PHP callable. For example,

    ['agree', 'required', 'isEmpty' => function ($value) {
        return empty($value);
    }]

Note: Most validators do not handle empty inputs if their yiivalidatorsValidator::$skipOnEmpty property takes
the default value true. They will simply be skipped during validation if their associated attributes receive empty
inputs. Among the core validators, only the captcha, default, filter,
required, and trim validators will handle empty inputs.

Ad Hoc Validation ¶

Sometimes you need to do ad hoc validation for values that are not bound to any model.

If you only need to perform one type of validation (e.g. validating email addresses), you may call
the validate() method of the desired validator, like the following:

$email = 'test@example.com';
$validator = new yiivalidatorsEmailValidator();

if ($validator->validate($email, $error)) {
    echo 'Email is valid.';
} else {
    echo $error;
}

Note: Not all validators support this type of validation. An example is the unique
core validator which is designed to work with a model only.

Note: The yiibaseValidator::skipOnEmpty property is used for yiibaseModel validation only. Using it without a model has no effect.

If you need to perform multiple validations against several values, you can use yiibaseDynamicModel
which supports declaring both attributes and rules on the fly. Its usage is like the following:

public function actionSearch($name, $email)
{
    $model = DynamicModel::validateData(['name' => $name, 'email' => $email], [
        [['name', 'email'], 'string', 'max' => 128],
        ['email', 'email'],
    ]);

    if ($model->hasErrors()) {
        // validation fails
    } else {
        // validation succeeds
    }
}

The yiibaseDynamicModel::validateData() method creates an instance of DynamicModel, defines the attributes
using the given data (name and email in this example), and then calls yiibaseModel::validate()
with the given rules.

Alternatively, you may use the following more «classic» syntax to perform ad hoc data validation:

public function actionSearch($name, $email)
{
    $model = new DynamicModel(['name' => $name, 'email' => $email]);
    $model->addRule(['name', 'email'], 'string', ['max' => 128])
        ->addRule('email', 'email')
        ->validate();

    if ($model->hasErrors()) {
        // validation fails
    } else {
        // validation succeeds
    }
}

After validation, you can check if the validation succeeded or not by calling the
hasErrors() method, and then get the validation errors from the
errors property, like you do with a normal model.
You may also access the dynamic attributes defined through the model instance, e.g.,
$model->name and $model->email.

Creating Validators ¶

Besides using the core validators included in the Yii releases, you may also
create your own validators. You may create inline validators or standalone validators.

Inline Validators ¶

An inline validator is one defined in terms of a model method or an anonymous function. The signature of
the method/function is:

/**
 * @param string $attribute the attribute currently being validated
 * @param mixed $params the value of the "params" given in the rule
 * @param yiivalidatorsInlineValidator $validator related InlineValidator instance.
 * This parameter is available since version 2.0.11.
 * @param mixed $current the currently validated value of attribute.
 * This parameter is available since version 2.0.36.
 */
function ($attribute, $params, $validator, $current)

If an attribute fails the validation, the method/function should call yiibaseModel::addError() to save
the error message in the model so that it can be retrieved back later to present to end users.

Below are some examples:

use yiibaseModel;

class MyForm extends Model
{
    public $country;
    public $token;

    public function rules()
    {
        return [
            // an inline validator defined as the model method validateCountry()
            ['country', 'validateCountry'],

            // an inline validator defined as an anonymous function
            ['token', function ($attribute, $params, $validator) {
                if (!ctype_alnum($this->$attribute)) {
                    $this->addError($attribute, 'The token must contain letters or digits.');
                }
            }],
        ];
    }

    public function validateCountry($attribute, $params, $validator)
    {
        if (!in_array($this->$attribute, ['USA', 'Indonesia'])) {
            $this->addError($attribute, 'The country must be either "USA" or "Indonesia".');
        }
    }
}

Note: Since version 2.0.11 you can use yiivalidatorsInlineValidator::addError() for adding errors instead. That way the error
message can be formatted using yiii18nI18N::format() right away. Use {attribute} and {value} in the error
message to refer to an attribute label (no need to get it manually) and attribute value accordingly:

$validator->addError($this, $attribute, 'The value "{value}" is not acceptable for {attribute}.');

Note: By default, inline validators will not be applied if their associated attributes receive empty inputs
or if they have already failed some validation rules. If you want to make sure a rule is always applied,
you may configure the skipOnEmpty and/or skipOnError
properties to be false in the rule declarations. For example:

[
    ['country', 'validateCountry', 'skipOnEmpty' => false, 'skipOnError' => false],
]

Standalone Validators ¶

A standalone validator is a class extending yiivalidatorsValidator or its child class. You may implement
its validation logic by overriding the yiivalidatorsValidator::validateAttribute() method. If an attribute
fails the validation, call yiibaseModel::addError() to save the error message in the model, like you do
with inline validators.

For example, the inline validator above could be moved into new [[components/validators/CountryValidator]] class.
In this case we can use yiivalidatorsValidator::addError() to set customized message for the model.

namespace appcomponents;

use yiivalidatorsValidator;

class CountryValidator extends Validator
{
    public function validateAttribute($model, $attribute)
    {
        if (!in_array($model->$attribute, ['USA', 'Indonesia'])) {
            $this->addError($model, $attribute, 'The country must be either "{country1}" or "{country2}".', ['country1' => 'USA', 'country2' => 'Indonesia']);
        }
    }
}

If you want your validator to support validating a value without a model, you should also override
yiivalidatorsValidator::validate(). You may also override yiivalidatorsValidator::validateValue()
instead of validateAttribute() and validate() because by default the latter two methods are implemented
by calling validateValue().

Below is an example of how you could use the above validator class within your model.

namespace appmodels;

use Yii;
use yiibaseModel;
use appcomponentsvalidatorsCountryValidator;

class EntryForm extends Model
{
    public $name;
    public $email;
    public $country;

    public function rules()
    {
        return [
            [['name', 'email'], 'required'],
            ['country', CountryValidator::class],
            ['email', 'email'],
        ];
    }
}

Multiple Attributes Validation ¶

Sometimes validators involve multiple attributes. Consider the following form:

class MigrationForm extends yiibaseModel
{
    /**
     * Minimal funds amount for one adult person
     */
    const MIN_ADULT_FUNDS = 3000;
    /**
     * Minimal funds amount for one child
     */
    const MIN_CHILD_FUNDS = 1500;

    public $personalSalary;
    public $spouseSalary;
    public $childrenCount;
    public $description;

    public function rules()
    {
        return [
            [['personalSalary', 'description'], 'required'],
            [['personalSalary', 'spouseSalary'], 'integer', 'min' => self::MIN_ADULT_FUNDS],
            ['childrenCount', 'integer', 'min' => 0, 'max' => 5],
            [['spouseSalary', 'childrenCount'], 'default', 'value' => 0],
            ['description', 'string'],
        ];
    }
}

Creating validator ¶

Let’s say we need to check if the family income is enough for children. We can create inline validator
validateChildrenFunds for that which will run only when childrenCount is more than 0.

Note that we can’t use all validated attributes (['personalSalary', 'spouseSalary', 'childrenCount']) when attaching
validator. This is because the same validator will run for each attribute (3 times in total) and we only need to run it
once for the whole attribute set.

You can use any of these attributes instead (or use what you think is the most relevant):

['childrenCount', 'validateChildrenFunds', 'when' => function ($model) {
    return $model->childrenCount > 0;
}],

Implementation of validateChildrenFunds can be like this:

public function validateChildrenFunds($attribute, $params)
{
    $totalSalary = $this->personalSalary + $this->spouseSalary;
    // Double the minimal adult funds if spouse salary is specified
    $minAdultFunds = $this->spouseSalary ? self::MIN_ADULT_FUNDS * 2 : self::MIN_ADULT_FUNDS;
    $childFunds = $totalSalary - $minAdultFunds;
    if ($childFunds / $this->childrenCount < self::MIN_CHILD_FUNDS) {
        $this->addError('childrenCount', 'Your salary is not enough for children.');
    }
}

You can ignore $attribute parameter because validation is not related to just one attribute.

Adding errors ¶

Adding error in case of multiple attributes can vary depending on desired form design:

• Select the most relevant field in your opinion and add error to it’s attribute:

$this->addError('childrenCount', 'Your salary is not enough for children.');

• Select multiple important relevant attributes or all attributes and add the same error message to them. We can store
  message in separate variable before passing it to addError to keep code DRY.

$message = 'Your salary is not enough for children.';
$this->addError('personalSalary', $message);
$this->addError('wifeSalary', $message);
$this->addError('childrenCount', $message);

Or use a loop:

$attributes = ['personalSalary', 'wifeSalary', 'childrenCount'];
foreach ($attributes as $attribute) {
    $this->addError($attribute, 'Your salary is not enough for children.');
}

• Add a common error (not related to particular attribute). We can use the not existing attribute name for adding
  error, for example *, because attribute existence is not checked at that point.

$this->addError('*', 'Your salary is not enough for children.');

As a result, we will not see error message near form fields. To display it, we can include the error summary in view:

<?= $form->errorSummary($model) ?>

Note: Creating validator which validates multiple attributes at once is well described in the community cookbook.

Client-Side Validation ¶

Client-side validation based on JavaScript is desirable when end users provide inputs via HTML forms, because
it allows users to find out input errors faster and thus provides a better user experience. You may use or implement
a validator that supports client-side validation in addition to server-side validation.

Info: While client-side validation is desirable, it is not a must. Its main purpose is to provide users with a better
experience. Similar to input data coming from end users, you should never trust client-side validation. For this reason,
you should always perform server-side validation by calling yiibaseModel::validate(), as
described in the previous subsections.

Using Client-Side Validation ¶

Many core validators support client-side validation out-of-the-box. All you need to do
is just use yiiwidgetsActiveForm to build your HTML forms. For example, LoginForm below declares two
rules: one uses the required core validator which is supported on both
client and server-sides; the other uses the validatePassword inline validator which is only supported on the server
side.

namespace appmodels;

use yiibaseModel;
use appmodelsUser;

class LoginForm extends Model
{
    public $username;
    public $password;

    public function rules()
    {
        return [
            // username and password are both required
            [['username', 'password'], 'required'],

            // password is validated by validatePassword()
            ['password', 'validatePassword'],
        ];
    }

    public function validatePassword()
    {
        $user = User::findByUsername($this->username);

        if (!$user || !$user->validatePassword($this->password)) {
            $this->addError('password', 'Incorrect username or password.');
        }
    }
}

The HTML form built by the following code contains two input fields username and password.
If you submit the form without entering anything, you will find the error messages requiring you
to enter something appear right away without any communication with the server.

<?php $form = yiiwidgetsActiveForm::begin(); ?>
    <?= $form->field($model, 'username') ?>
    <?= $form->field($model, 'password')->passwordInput() ?>
    <?= Html::submitButton('Login') ?>
<?php yiiwidgetsActiveForm::end(); ?>

Behind the scene, yiiwidgetsActiveForm will read the validation rules declared in the model
and generate appropriate JavaScript code for validators that support client-side validation. When a user
changes the value of an input field or submit the form, the client-side validation JavaScript will be triggered.

If you want to turn off client-side validation completely, you may configure the
yiiwidgetsActiveForm::$enableClientValidation property to be false. You may also turn off client-side
validation of individual input fields by configuring their yiiwidgetsActiveField::$enableClientValidation
property to be false. When enableClientValidation is configured at both the input field level and the form level,
the former will take precedence.

Info: Since version 2.0.11 all validators extending from yiivalidatorsValidator receive client-side options
from separate method — yiivalidatorsValidator::getClientOptions(). You can use it:

• if you want to implement your own custom client-side validation but leave the synchronization with server-side
  validator options;
• to extend or customize to fit your specific needs:

public function getClientOptions($model, $attribute)
{
    $options = parent::getClientOptions($model, $attribute);
    // Modify $options here

    return $options;
}

Implementing Client-Side Validation ¶

To create a validator that supports client-side validation, you should implement the
yiivalidatorsValidator::clientValidateAttribute() method which returns a piece of JavaScript code
that performs the validation on the client-side. Within the JavaScript code, you may use the following
predefined variables:

• attribute: the name of the attribute being validated.
• value: the value being validated.
• messages: an array used to hold the validation error messages for the attribute.
• deferred: an array which deferred objects can be pushed into (explained in the next subsection).

In the following example, we create a StatusValidator which validates if an input is a valid status input
against the existing status data. The validator supports both server-side and client-side validation.

namespace appcomponents;

use yiivalidatorsValidator;
use appmodelsStatus;

class StatusValidator extends Validator
{
    public function init()
    {
        parent::init();
        $this->message = 'Invalid status input.';
    }

    public function validateAttribute($model, $attribute)
    {
        $value = $model->$attribute;
        if (!Status::find()->where(['id' => $value])->exists()) {
            $model->addError($attribute, $this->message);
        }
    }

    public function clientValidateAttribute($model, $attribute, $view)
    {
        $statuses = json_encode(Status::find()->select('id')->asArray()->column());
        $message = json_encode($this->message, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        return <<<JS
if ($.inArray(value, $statuses) === -1) {
    messages.push($message);
}
JS;
    }
}

Tip: The above code is given mainly to demonstrate how to support client-side validation. In practice,
you may use the in core validator to achieve the same goal. You may
write the validation rule like the following:

[
    ['status', 'in', 'range' => Status::find()->select('id')->asArray()->column()],
]

Tip: If you need to work with client validation manually i.e. dynamically add fields or do some custom UI logic, refer
to Working with ActiveForm via JavaScript
in Yii 2.0 Cookbook.

Deferred Validation ¶

If you need to perform asynchronous client-side validation, you can create Deferred objects.
For example, to perform a custom AJAX validation, you can use the following code:

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.push($.get("/check", {value: value}).done(function(data) {
            if ('' !== data) {
                messages.push(data);
            }
        }));
JS;
}

In the above, the deferred variable is provided by Yii, which is an array of Deferred objects. The $.get()
jQuery method creates a Deferred object which is pushed to the deferred array.

You can also explicitly create a Deferred object and call its resolve() method when the asynchronous callback
is hit. The following example shows how to validate the dimensions of an uploaded image file on the client-side.

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        var def = $.Deferred();
        var img = new Image();
        img.onload = function() {
            if (this.width > 150) {
                messages.push('Image too wide!!');
            }
            def.resolve();
        }
        var reader = new FileReader();
        reader.onloadend = function() {
            img.src = reader.result;
        }
        reader.readAsDataURL(file);

        deferred.push(def);
JS;
}

Note: The resolve() method must be called after the attribute has been validated. Otherwise the main form
validation will not complete.

For simplicity, the deferred array is equipped with a shortcut method add() which automatically creates a Deferred
object and adds it to the deferred array. Using this method, you can simplify the above example as follows,

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.add(function(def) {
            var img = new Image();
            img.onload = function() {
                if (this.width > 150) {
                    messages.push('Image too wide!!');
                }
                def.resolve();
            }
            var reader = new FileReader();
            reader.onloadend = function() {
                img.src = reader.result;
            }
            reader.readAsDataURL(file);
        });
JS;
}

AJAX Validation ¶

Some validations can only be done on the server-side, because only the server has the necessary information.
For example, to validate if a username is unique or not, it is necessary to check the user table on the server-side.
You can use AJAX-based validation in this case. It will trigger an AJAX request in the background to validate the
input while keeping the same user experience as the regular client-side validation.

To enable AJAX validation for a single input field, configure the enableAjaxValidation
property of that field to be true and specify a unique form id:

use yiiwidgetsActiveForm;

$form = ActiveForm::begin([
    'id' => 'registration-form',
]);

echo $form->field($model, 'username', ['enableAjaxValidation' => true]);

// ...

ActiveForm::end();

To enable AJAX validation for all inputs of the form, configure enableAjaxValidation
to be true at the form level:

$form = ActiveForm::begin([
    'id' => 'contact-form',
    'enableAjaxValidation' => true,
]);

Note: When the enableAjaxValidation property is configured at both the input field level and the form level,
the former will take precedence.

You also need to prepare the server so that it can handle the AJAX validation requests.
This can be achieved by a code snippet like the following in the controller actions:

if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}

The above code will check whether the current request is an AJAX. If yes, it will respond to
this request by running the validation and returning the errors in JSON format.

Info: You can also use Deferred Validation to perform AJAX validation.
However, the AJAX validation feature described here is more systematic and requires less coding effort.

When both enableClientValidation and enableAjaxValidation are set to true, AJAX validation request will be triggered
only after the successful client validation. Note that in case of validating a single field that happens if either
validateOnChange, validateOnBlur or validateOnType is set to true, AJAX request will be sent when the field in
question alone successfully passes client validation.

Validating Input

As a rule of thumb, you should never trust the data received from end users and should always validate it
before putting it to good use.

Given a model populated with user inputs, you can validate the inputs by calling the
[[yiibaseModel::validate()]] method. The method will return a boolean value indicating whether the validation
succeeded or not. If not, you may get the error messages from the [[yiibaseModel::errors]] property. For example,

$model = new appmodelsContactForm();

// populate model attributes with user inputs
$model->load(Yii::$app->request->post());
// which is equivalent to the following:
// $model->attributes = Yii::$app->request->post('ContactForm');

if ($model->validate()) {
    // all inputs are valid
} else {
    // validation failed: $errors is an array containing error messages
    $errors = $model->errors;
}

Declaring Rules

To make validate() really work, you should declare validation rules for the attributes you plan to validate.
This should be done by overriding the [[yiibaseModel::rules()]] method. The following example shows how
the validation rules for the ContactForm model are declared:

public function rules()
{
    return [
        // the name, email, subject and body attributes are required
        [['name', 'email', 'subject', 'body'], 'required'],

        // the email attribute should be a valid email address
        ['email', 'email'],
    ];
}

The [[yiibaseModel::rules()|rules()]] method should return an array of rules, each of which is an array
of the following format:

[
    // required, specifies which attributes should be validated by this rule.
    // For a single attribute, you can use the attribute name directly
    // without having it in an array
    ['attribute1', 'attribute2', ...],

    // required, specifies the type of this rule.
    // It can be a class name, validator alias, or a validation method name
    'validator',

    // optional, specifies in which scenario(s) this rule should be applied
    // if not given, it means the rule applies to all scenarios
    // You may also configure the "except" option if you want to apply the rule
    // to all scenarios except the listed ones
    'on' => ['scenario1', 'scenario2', ...],

    // optional, specifies additional configurations for the validator object
    'property1' => 'value1', 'property2' => 'value2', ...
]

For each rule you must specify at least which attributes the rule applies to and what is the type of the rule.
You can specify the rule type in one of the following forms:

• the alias of a core validator, such as required, in, date, etc. Please refer to
  the Core Validators for the complete list of core validators.
• the name of a validation method in the model class, or an anonymous function. Please refer to the
  Inline Validators subsection for more details.
• a fully qualified validator class name. Please refer to the Standalone Validators
  subsection for more details.

A rule can be used to validate one or multiple attributes, and an attribute may be validated by one or multiple rules.
A rule may be applied in certain scenarios only by specifying the on option.
If you do not specify an on option, it means the rule will be applied to all scenarios.

When the validate() method is called, it does the following steps to perform validation:

1. Determine which attributes should be validated by getting the attribute list from [[yiibaseModel::scenarios()]]
   using the current [[yiibaseModel::scenario|scenario]]. These attributes are called active attributes.
2. Determine which validation rules should be used by getting the rule list from [[yiibaseModel::rules()]]
   using the current [[yiibaseModel::scenario|scenario]]. These rules are called active rules.
3. Use each active rule to validate each active attribute which is associated with the rule.
   The validation rules are evaluated in the order they are listed.

According to the above validation steps, an attribute will be validated if and only if it is
an active attribute declared in scenarios() and is associated with one or multiple active rules
declared in rules().

Customizing Error Messages

Most validators have default error messages that will be added to the model being validated when its attributes
fail the validation. For example, the [[yiivalidatorsRequiredValidator|required]] validator will add
a message «Username cannot be blank.» to a model when the username attribute fails the rule using this validator.

You can customize the error message of a rule by specifying the message property when declaring the rule,
like the following,

public function rules()
{
    return [
        ['username', 'required', 'message' => 'Please choose a username.'],
    ];
}

Some validators may support additional error messages to more precisely describe different causes of
validation failures. For example, the [[yiivalidatorsNumberValidator|number]] validator supports
[[yiivalidatorsNumberValidator::tooBig|tooBig]] and [[yiivalidatorsNumberValidator::tooSmall|tooSmall]]
to describe the validation failure when the value being validated is too big and too small, respectively.
You may configure these error messages like configuring other properties of validators in a validation rule.

Validation Events

When [[yiibaseModel::validate()]] is called, it will call two methods that you may override to customize
the validation process:

• [[yiibaseModel::beforeValidate()]]: the default implementation will trigger a [[yiibaseModel::EVENT_BEFORE_VALIDATE]]
  event. You may either override this method or respond to this event to do some preprocessing work
  (e.g. normalizing data inputs) before the validation occurs. The method should return a boolean value indicating
  whether the validation should proceed or not.
• [[yiibaseModel::afterValidate()]]: the default implementation will trigger a [[yiibaseModel::EVENT_AFTER_VALIDATE]]
  event. You may either override this method or respond to this event to do some postprocessing work after
  the validation is completed.

Conditional Validation

To validate attributes only when certain conditions apply, e.g. the validation of one attribute depends
on the value of another attribute you can use the [[yiivalidatorsValidator::when|when]] property
to define such conditions. For example,

[
    ['state', 'required', 'when' => function($model) {
        return $model->country == 'USA';
    }],
]

The [[yiivalidatorsValidator::when|when]] property takes a PHP callable with the following signature:

/**
 * @param Model $model the model being validated
 * @param string $attribute the attribute being validated
 * @return boolean whether the rule should be applied
 */
function ($model, $attribute)

If you also need to support client-side conditional validation, you should configure
the [[yiivalidatorsValidator::whenClient|whenClient]] property which takes a string representing a JavaScript
function whose return value determines whether to apply the rule or not. For example,

[
    ['state', 'required', 'when' => function ($model) {
        return $model->country == 'USA';
    }, 'whenClient' => "function (attribute, value) {
        return $('#country').val() == 'USA';
    }"],
]

Data Filtering

User inputs often need to be filtered or preprocessed. For example, you may want to trim the spaces around the
username input. You may use validation rules to achieve this goal.

The following examples shows how to trim the spaces in the inputs and turn empty inputs into nulls by using
the trim and default core validators:

[
    [['username', 'email'], 'trim'],
    [['username', 'email'], 'default'],
]

You may also use the more general filter validator to perform more complex
data filtering.

As you can see, these validation rules do not really validate the inputs. Instead, they will process the values
and save them back to the attributes being validated.

Handling Empty Inputs

When input data are submitted from HTML forms, you often need to assign some default values to the inputs
if they are empty. You can do so by using the default validator. For example,

[
    // set "username" and "email" as null if they are empty
    [['username', 'email'], 'default'],

    // set "level" to be 1 if it is empty
    ['level', 'default', 'value' => 1],
]

By default, an input is considered empty if its value is an empty string, an empty array or a null.
You may customize the default empty detection logic by configuring the the [[yiivalidatorsValidator::isEmpty]] property
with a PHP callable. For example,

[
    ['agree', 'required', 'isEmpty' => function ($value) {
        return empty($value);
    }],
]

Note: Most validators do not handle empty inputs if their [[yiibaseValidator::skipOnEmpty]] property takes
the default value true. They will simply be skipped during validation if their associated attributes receive empty
inputs. Among the core validators, only the captcha, default, filter,
required, and trim validators will handle empty inputs.

Ad Hoc Validation

Sometimes you need to do ad hoc validation for values that are not bound to any model.

If you only need to perform one type of validation (e.g. validating email addresses), you may call
the [[yiivalidatorsValidator::validate()|validate()]] method of the desired validator, like the following:

$email = 'test@example.com';
$validator = new yiivalidatorsEmailValidator();

if ($validator->validate($email, $error)) {
    echo 'Email is valid.';
} else {
    echo $error;
}

Note: Not all validators support this type of validation. An example is the unique
core validator which is designed to work with a model only.

If you need to perform multiple validations against several values, you can use [[yiibaseDynamicModel]]
which supports declaring both attributes and rules on the fly. Its usage is like the following:

public function actionSearch($name, $email)
{
    $model = DynamicModel::validateData(compact('name', 'email'), [
        [['name', 'email'], 'string', 'max' => 128],
        ['email', 'email'],
    ]);

    if ($model->hasErrors()) {
        // validation fails
    } else {
        // validation succeeds
    }
}

The [[yiibaseDynamicModel::validateData()]] method creates an instance of DynamicModel, defines the attributes
using the given data (name and email in this example), and then calls [[yiibaseModel::validate()]]
with the given rules.

Alternatively, you may use the following more «classic» syntax to perform ad hoc data validation:

public function actionSearch($name, $email)
{
    $model = new DynamicModel(compact('name', 'email'));
    $model->addRule(['name', 'email'], 'string', ['max' => 128])
        ->addRule('email', 'email')
        ->validate();

    if ($model->hasErrors()) {
        // validation fails
    } else {
        // validation succeeds
    }
}

After validation, you can check if the validation succeeded or not by calling the
[[yiibaseDynamicModel::hasErrors()|hasErrors()]] method, and then get the validation errors from the
[[yiibaseDynamicModel::errors|errors]] property, like you do with a normal model.
You may also access the dynamic attributes defined through the model instance, e.g.,
$model->name and $model->email.

Creating Validators

Besides using the core validators included in the Yii releases, you may also
create your own validators. You may create inline validators or standalone validators.

Inline Validators

An inline validator is one defined in terms of a model method or an anonymous function. The signature of
the method/function is:

/**
 * @param string $attribute the attribute currently being validated
 * @param mixed $params the value of the "params" given in the rule
 */
function ($attribute, $params)

If an attribute fails the validation, the method/function should call [[yiibaseModel::addError()]] to save
the error message in the model so that it can be retrieved back later to present to end users.

Below are some examples:

use yiibaseModel;

class MyForm extends Model
{
    public $country;
    public $token;

    public function rules()
    {
        return [
            // an inline validator defined as the model method validateCountry()
            ['country', 'validateCountry'],

            // an inline validator defined as an anonymous function
            ['token', function ($attribute, $params) {
                if (!ctype_alnum($this->$attribute)) {
                    $this->addError($attribute, 'The token must contain letters or digits.');
                }
            }],
        ];
    }

    public function validateCountry($attribute, $params)
    {
        if (!in_array($this->$attribute, ['USA', 'Web'])) {
            $this->addError($attribute, 'The country must be either "USA" or "Web".');
        }
    }
}

Note: By default, inline validators will not be applied if their associated attributes receive empty inputs
or if they have already failed some validation rules. If you want to make sure a rule is always applied,
you may configure the [[yiivalidatorsValidator::skipOnEmpty|skipOnEmpty]] and/or [[yiivalidatorsValidator::skipOnError|skipOnError]]
properties to be false in the rule declarations. For example:

[
    ['country', 'validateCountry', 'skipOnEmpty' => false, 'skipOnError' => false],
]

Standalone Validators

A standalone validator is a class extending [[yiivalidatorsValidator]] or its child class. You may implement
its validation logic by overriding the [[yiivalidatorsValidator::validateAttribute()]] method. If an attribute
fails the validation, call [[yiibaseModel::addError()]] to save the error message in the model, like you do
with inline validators. For example,

namespace appcomponents;

use yiivalidatorsValidator;

class CountryValidator extends Validator
{
    public function validateAttribute($model, $attribute)
    {
        if (!in_array($model->$attribute, ['USA', 'Web'])) {
            $this->addError($model, $attribute, 'The country must be either "USA" or "Web".');
        }
    }
}

If you want your validator to support validating a value without a model, you should also override
[[yiivalidatorsValidator::validate()]]. You may also override [[yiivalidatorsValidator::validateValue()]]
instead of validateAttribute() and validate() because by default the latter two methods are implemented
by calling validateValue().

Client-Side Validation

Client-side validation based on JavaScript is desirable when end users provide inputs via HTML forms, because
it allows users to find out input errors faster and thus provides a better user experience. You may use or implement
a validator that supports client-side validation in addition to server-side validation.

Info: While client-side validation is desirable, it is not a must. Its main purpose is to provide users with a better
experience. Similar to input data coming from end users, you should never trust client-side validation. For this reason,
you should always perform server-side validation by calling [[yiibaseModel::validate()]], as
described in the previous subsections.

Using Client-Side Validation

Many core validators support client-side validation out-of-the-box. All you need to do
is just use [[yiiwidgetsActiveForm]] to build your HTML forms. For example, LoginForm below declares two
rules: one uses the required core validator which is supported on both
client and server sides; the other uses the validatePassword inline validator which is only supported on the server
side.

namespace appmodels;

use yiibaseModel;
use appmodelsUser;

class LoginForm extends Model
{
    public $username;
    public $password;

    public function rules()
    {
        return [
            // username and password are both required
            [['username', 'password'], 'required'],

            // password is validated by validatePassword()
            ['password', 'validatePassword'],
        ];
    }

    public function validatePassword()
    {
        $user = User::findByUsername($this->username);

        if (!$user || !$user->validatePassword($this->password)) {
            $this->addError('password', 'Incorrect username or password.');
        }
    }
}

The HTML form built by the following code contains two input fields username and password.
If you submit the form without entering anything, you will find the error messages requiring you
to enter something appear right away without any communication with the server.

<?php $form = yiiwidgetsActiveForm::begin(); ?>
    <?= $form->field($model, 'username') ?>
    <?= $form->field($model, 'password')->passwordInput() ?>
    <?= Html::submitButton('Login') ?>
<?php yiiwidgetsActiveForm::end(); ?>

Behind the scene, [[yiiwidgetsActiveForm]] will read the validation rules declared in the model
and generate appropriate JavaScript code for validators that support client-side validation. When a user
changes the value of an input field or submit the form, the client-side validation JavaScript will be triggered.

If you want to turn off client-side validation completely, you may configure the
[[yiiwidgetsActiveForm::enableClientValidation]] property to be false. You may also turn off client-side
validation of individual input fields by configuring their [[yiiwidgetsActiveField::enableClientValidation]]
property to be false. When enableClientValidation is configured at both the input field level and the form level,
the former will take precedence.

Implementing Client-Side Validation

To create a validator that supports client-side validation, you should implement the
[[yiivalidatorsValidator::clientValidateAttribute()]] method which returns a piece of JavaScript code
that performs the validation on the client side. Within the JavaScript code, you may use the following
predefined variables:

• attribute: the name of the attribute being validated.
• value: the value being validated.
• messages: an array used to hold the validation error messages for the attribute.
• deferred: an array which deferred objects can be pushed into (explained in the next subsection).

In the following example, we create a StatusValidator which validates if an input is a valid status input
against the existing status data. The validator supports both server side and client side validation.

namespace appcomponents;

use yiivalidatorsValidator;
use appmodelsStatus;

class StatusValidator extends Validator
{
    public function init()
    {
        parent::init();
        $this->message = 'Invalid status input.';
    }

    public function validateAttribute($model, $attribute)
    {
        $value = $model->$attribute;
        if (!Status::find()->where(['id' => $value])->exists()) {
            $model->addError($attribute, $this->message);
        }
    }

    public function clientValidateAttribute($model, $attribute, $view)
    {
        $statuses = json_encode(Status::find()->select('id')->asArray()->column());
        $message = json_encode($this->message, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        return <<<JS
if (!$.inArray(value, $statuses)) {
    messages.push($message);
}
JS;
    }
}

Tip: The above code is given mainly to demonstrate how to support client-side validation. In practice,
you may use the in core validator to achieve the same goal. You may
write the validation rule like the following:

[
    ['status', 'in', 'range' => Status::find()->select('id')->asArray()->column()],
]

Deferred Validation

If you need to perform asynchronous client-side validation, you can create Deferred objects.
For example, to perform a custom AJAX validation, you can use the following code:

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.push($.get("/check", {value: value}).done(function(data) {
            if ('' !== data) {
                messages.push(data);
            }
        }));
JS;
}

In the above, the deferred variable is provided by Yii, which is an array of Deferred objects. The $.get()
jQuery method creates a Deferred object which is pushed to the deferred array.

You can also explicitly create a Deferred object and call its resolve() method when the asynchronous callback
is hit. The following example shows how to validate the dimensions of an uploaded image file on the client side.

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        var def = $.Deferred();
        var img = new Image();
        img.onload = function() {
            if (this.width > 150) {
                messages.push('Image too wide!!');
            }
            def.resolve();
        }
        var reader = new FileReader();
        reader.onloadend = function() {
            img.src = reader.result;
        }
        reader.readAsDataURL(file);

        deferred.push(def);
JS;
}

Note: The resolve() method must be called after the attribute has been validated. Otherwise the main form
validation will not complete.

For simplicity, the deferred array is equipped with a shortcut method add() which automatically creates a Deferred
object and adds it to the deferred array. Using this method, you can simplify the above example as follows,

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.add(function(def) {
            var img = new Image();
            img.onload = function() {
                if (this.width > 150) {
                    messages.push('Image too wide!!');
                }
                def.resolve();
            }
            var reader = new FileReader();
            reader.onloadend = function() {
                img.src = reader.result;
            }
            reader.readAsDataURL(file);
        });
JS;
}

AJAX Validation

Some validations can only be done on the server side, because only the server has the necessary information.
For example, to validate if a username is unique or not, it is necessary to check the user table on the server side.
You can use AJAX-based validation in this case. It will trigger an AJAX request in the background to validate the
input while keeping the same user experience as the regular client-side validation.

To enable AJAX validation for a single input field, configure the [[yiiwidgetsActiveField::enableAjaxValidation|enableAjaxValidation]]
property of that field to be true and specify a unique form id:

use yiiwidgetsActiveForm;

$form = ActiveForm::begin([
    'id' => 'registration-form',
]);

echo $form->field($model, 'username', ['enableAjaxValidation' => true]);

// ...

ActiveForm::end();

To enable AJAX validation for the whole form, configure [[yiiwidgetsActiveForm::enableAjaxValidation|enableAjaxValidation]]
to be true at the form level:

$form = ActiveForm::begin([
    'id' => 'contact-form',
    'enableAjaxValidation' => true,
]);

Note: When the enableAjaxValidation property is configured at both the input field level and the form level,
the former will take precedence.

You also need to prepare the server so that it can handle the AJAX validation requests.
This can be achieved by a code snippet like the following in the controller actions:

if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}

The above code will check whether the current request is an AJAX. If yes, it will respond to
this request by running the validation and returning the errors in JSON format.

Info: You can also use Deferred Validation to perform AJAX validation.
However, the AJAX validation feature described here is more systematic and requires less coding effort.

Validating Input

As a rule of thumb, you should never trust the data received from end users and should always validate it
before putting it to good use.

Given a model populated with user inputs, you can validate the inputs by calling the
[[yiibaseModel::validate()]] method. The method will return a boolean value indicating whether the validation
succeeded or not. If not, you may get the error messages from the [[yiibaseModel::errors]] property. For example,

$model = new appmodelsContactForm();

// populate model attributes with user inputs
$model->load(Yii::$app->request->post());
// which is equivalent to the following:
// $model->attributes = Yii::$app->request->post('ContactForm');

if ($model->validate()) {
    // all inputs are valid
} else {
    // validation failed: $errors is an array containing error messages
    $errors = $model->errors;
}

Declaring Rules

To make validate() really work, you should declare validation rules for the attributes you plan to validate.
This should be done by overriding the [[yiibaseModel::rules()]] method. The following example shows how
the validation rules for the ContactForm model are declared:

public function rules()
{
    return [
        // the name, email, subject and body attributes are required
        [['name', 'email', 'subject', 'body'], 'required'],

        // the email attribute should be a valid email address
        ['email', 'email'],
    ];
}

The [[yiibaseModel::rules()|rules()]] method should return an array of rules, each of which is an array
of the following format:

[
    // required, specifies which attributes should be validated by this rule.
    // For a single attribute, you can use the attribute name directly
    // without having it in an array
    ['attribute1', 'attribute2', ...],

    // required, specifies the type of this rule.
    // It can be a class name, validator alias, or a validation method name
    'validator',

    // optional, specifies in which scenario(s) this rule should be applied
    // if not given, it means the rule applies to all scenarios
    // You may also configure the "except" option if you want to apply the rule
    // to all scenarios except the listed ones
    'on' => ['scenario1', 'scenario2', ...],

    // optional, specifies additional configurations for the validator object
    'property1' => 'value1', 'property2' => 'value2', ...
]

For each rule you must specify at least which attributes the rule applies to and what is the type of the rule.
You can specify the rule type in one of the following forms:

• the alias of a core validator, such as required, in, date, etc. Please refer to
  the Core Validators for the complete list of core validators.
• the name of a validation method in the model class, or an anonymous function. Please refer to the
  Inline Validators subsection for more details.
• a fully qualified validator class name. Please refer to the Standalone Validators
  subsection for more details.

A rule can be used to validate one or multiple attributes, and an attribute may be validated by one or multiple rules.
A rule may be applied in certain scenarios only by specifying the on option.
If you do not specify an on option, it means the rule will be applied to all scenarios.

When the validate() method is called, it does the following steps to perform validation:

1. Determine which attributes should be validated by getting the attribute list from [[yiibaseModel::scenarios()]]
   using the current [[yiibaseModel::scenario|scenario]]. These attributes are called active attributes.
2. Determine which validation rules should be used by getting the rule list from [[yiibaseModel::rules()]]
   using the current [[yiibaseModel::scenario|scenario]]. These rules are called active rules.
3. Use each active rule to validate each active attribute which is associated with the rule.
   The validation rules are evaluated in the order they are listed.

According to the above validation steps, an attribute will be validated if and only if it is
an active attribute declared in scenarios() and is associated with one or multiple active rules
declared in rules().

Customizing Error Messages

Most validators have default error messages that will be added to the model being validated when its attributes
fail the validation. For example, the [[yiivalidatorsRequiredValidator|required]] validator will add
a message «Username cannot be blank.» to a model when the username attribute fails the rule using this validator.

You can customize the error message of a rule by specifying the message property when declaring the rule,
like the following,

public function rules()
{
    return [
        ['username', 'required', 'message' => 'Please choose a username.'],
    ];
}

Some validators may support additional error messages to more precisely describe different causes of
validation failures. For example, the [[yiivalidatorsNumberValidator|number]] validator supports
[[yiivalidatorsNumberValidator::tooBig|tooBig]] and [[yiivalidatorsNumberValidator::tooSmall|tooSmall]]
to describe the validation failure when the value being validated is too big and too small, respectively.
You may configure these error messages like configuring other properties of validators in a validation rule.

Validation Events

When [[yiibaseModel::validate()]] is called, it will call two methods that you may override to customize
the validation process:

• [[yiibaseModel::beforeValidate()]]: the default implementation will trigger a [[yiibaseModel::EVENT_BEFORE_VALIDATE]]
  event. You may either override this method or respond to this event to do some preprocessing work
  (e.g. normalizing data inputs) before the validation occurs. The method should return a boolean value indicating
  whether the validation should proceed or not.
• [[yiibaseModel::afterValidate()]]: the default implementation will trigger a [[yiibaseModel::EVENT_AFTER_VALIDATE]]
  event. You may either override this method or respond to this event to do some postprocessing work after
  the validation is completed.

Conditional Validation

To validate attributes only when certain conditions apply, e.g. the validation of one attribute depends
on the value of another attribute you can use the [[yiivalidatorsValidator::when|when]] property
to define such conditions. For example,

[
    ['state', 'required', 'when' => function($model) {
        return $model->country == 'USA';
    }],
]

The [[yiivalidatorsValidator::when|when]] property takes a PHP callable with the following signature:

/**
 * @param Model $model the model being validated
 * @param string $attribute the attribute being validated
 * @return boolean whether the rule should be applied
 */
function ($model, $attribute)

If you also need to support client-side conditional validation, you should configure
the [[yiivalidatorsValidator::whenClient|whenClient]] property which takes a string representing a JavaScript
function whose return value determines whether to apply the rule or not. For example,

[
    ['state', 'required', 'when' => function ($model) {
        return $model->country == 'USA';
    }, 'whenClient' => "function (attribute, value) {
        return $('#country').val() == 'USA';
    }"],
]

Data Filtering

User inputs often need to be filtered or preprocessed. For example, you may want to trim the spaces around the
username input. You may use validation rules to achieve this goal.

The following examples shows how to trim the spaces in the inputs and turn empty inputs into nulls by using
the trim and default core validators:

[
    [['username', 'email'], 'trim'],
    [['username', 'email'], 'default'],
]

You may also use the more general filter validator to perform more complex
data filtering.

As you can see, these validation rules do not really validate the inputs. Instead, they will process the values
and save them back to the attributes being validated.

Handling Empty Inputs

When input data are submitted from HTML forms, you often need to assign some default values to the inputs
if they are empty. You can do so by using the default validator. For example,

[
    // set "username" and "email" as null if they are empty
    [['username', 'email'], 'default'],

    // set "level" to be 1 if it is empty
    ['level', 'default', 'value' => 1],
]

By default, an input is considered empty if its value is an empty string, an empty array or a null.
You may customize the default empty detection logic by configuring the the [[yiivalidatorsValidator::isEmpty]] property
with a PHP callable. For example,

[
    ['agree', 'required', 'isEmpty' => function ($value) {
        return empty($value);
    }],
]

Note: Most validators do not handle empty inputs if their [[yiibaseValidator::skipOnEmpty]] property takes
the default value true. They will simply be skipped during validation if their associated attributes receive empty
inputs. Among the core validators, only the captcha, default, filter,
required, and trim validators will handle empty inputs.

Ad Hoc Validation

Sometimes you need to do ad hoc validation for values that are not bound to any model.

If you only need to perform one type of validation (e.g. validating email addresses), you may call
the [[yiivalidatorsValidator::validate()|validate()]] method of the desired validator, like the following:

$email = 'test@example.com';
$validator = new yiivalidatorsEmailValidator();

if ($validator->validate($email, $error)) {
    echo 'Email is valid.';
} else {
    echo $error;
}

Note: Not all validators support this type of validation. An example is the unique
core validator which is designed to work with a model only.

If you need to perform multiple validations against several values, you can use [[yiibaseDynamicModel]]
which supports declaring both attributes and rules on the fly. Its usage is like the following:

public function actionSearch($name, $email)
{
    $model = DynamicModel::validateData(compact('name', 'email'), [
        [['name', 'email'], 'string', 'max' => 128],
        ['email', 'email'],
    ]);

    if ($model->hasErrors()) {
        // validation fails
    } else {
        // validation succeeds
    }
}

The [[yiibaseDynamicModel::validateData()]] method creates an instance of DynamicModel, defines the attributes
using the given data (name and email in this example), and then calls [[yiibaseModel::validate()]]
with the given rules.

Alternatively, you may use the following more «classic» syntax to perform ad hoc data validation:

public function actionSearch($name, $email)
{
    $model = new DynamicModel(compact('name', 'email'));
    $model->addRule(['name', 'email'], 'string', ['max' => 128])
        ->addRule('email', 'email')
        ->validate();

    if ($model->hasErrors()) {
        // validation fails
    } else {
        // validation succeeds
    }
}

After validation, you can check if the validation succeeded or not by calling the
[[yiibaseDynamicModel::hasErrors()|hasErrors()]] method, and then get the validation errors from the
[[yiibaseDynamicModel::errors|errors]] property, like you do with a normal model.
You may also access the dynamic attributes defined through the model instance, e.g.,
$model->name and $model->email.

Creating Validators

Besides using the core validators included in the Yii releases, you may also
create your own validators. You may create inline validators or standalone validators.

Inline Validators

An inline validator is one defined in terms of a model method or an anonymous function. The signature of
the method/function is:

/**
 * @param string $attribute the attribute currently being validated
 * @param mixed $params the value of the "params" given in the rule
 */
function ($attribute, $params)

If an attribute fails the validation, the method/function should call [[yiibaseModel::addError()]] to save
the error message in the model so that it can be retrieved back later to present to end users.

Below are some examples:

use yiibaseModel;

class MyForm extends Model
{
    public $country;
    public $token;

    public function rules()
    {
        return [
            // an inline validator defined as the model method validateCountry()
            ['country', 'validateCountry'],

            // an inline validator defined as an anonymous function
            ['token', function ($attribute, $params) {
                if (!ctype_alnum($this->$attribute)) {
                    $this->addError($attribute, 'The token must contain letters or digits.');
                }
            }],
        ];
    }

    public function validateCountry($attribute, $params)
    {
        if (!in_array($this->$attribute, ['USA', 'Web'])) {
            $this->addError($attribute, 'The country must be either "USA" or "Web".');
        }
    }
}

Note: By default, inline validators will not be applied if their associated attributes receive empty inputs
or if they have already failed some validation rules. If you want to make sure a rule is always applied,
you may configure the [[yiivalidatorsValidator::skipOnEmpty|skipOnEmpty]] and/or [[yiivalidatorsValidator::skipOnError|skipOnError]]
properties to be false in the rule declarations. For example:

[
    ['country', 'validateCountry', 'skipOnEmpty' => false, 'skipOnError' => false],
]

Standalone Validators

A standalone validator is a class extending [[yiivalidatorsValidator]] or its child class. You may implement
its validation logic by overriding the [[yiivalidatorsValidator::validateAttribute()]] method. If an attribute
fails the validation, call [[yiibaseModel::addError()]] to save the error message in the model, like you do
with inline validators. For example,

namespace appcomponents;

use yiivalidatorsValidator;

class CountryValidator extends Validator
{
    public function validateAttribute($model, $attribute)
    {
        if (!in_array($model->$attribute, ['USA', 'Web'])) {
            $this->addError($model, $attribute, 'The country must be either "USA" or "Web".');
        }
    }
}

If you want your validator to support validating a value without a model, you should also override
[[yiivalidatorsValidator::validate()]]. You may also override [[yiivalidatorsValidator::validateValue()]]
instead of validateAttribute() and validate() because by default the latter two methods are implemented
by calling validateValue().

Client-Side Validation

Client-side validation based on JavaScript is desirable when end users provide inputs via HTML forms, because
it allows users to find out input errors faster and thus provides a better user experience. You may use or implement
a validator that supports client-side validation in addition to server-side validation.

Info: While client-side validation is desirable, it is not a must. Its main purpose is to provide users with a better
experience. Similar to input data coming from end users, you should never trust client-side validation. For this reason,
you should always perform server-side validation by calling [[yiibaseModel::validate()]], as
described in the previous subsections.

Using Client-Side Validation

Many core validators support client-side validation out-of-the-box. All you need to do
is just use [[yiiwidgetsActiveForm]] to build your HTML forms. For example, LoginForm below declares two
rules: one uses the required core validator which is supported on both
client and server sides; the other uses the validatePassword inline validator which is only supported on the server
side.

namespace appmodels;

use yiibaseModel;
use appmodelsUser;

class LoginForm extends Model
{
    public $username;
    public $password;

    public function rules()
    {
        return [
            // username and password are both required
            [['username', 'password'], 'required'],

            // password is validated by validatePassword()
            ['password', 'validatePassword'],
        ];
    }

    public function validatePassword()
    {
        $user = User::findByUsername($this->username);

        if (!$user || !$user->validatePassword($this->password)) {
            $this->addError('password', 'Incorrect username or password.');
        }
    }
}

The HTML form built by the following code contains two input fields username and password.
If you submit the form without entering anything, you will find the error messages requiring you
to enter something appear right away without any communication with the server.

<?php $form = yiiwidgetsActiveForm::begin(); ?>
    <?= $form->field($model, 'username') ?>
    <?= $form->field($model, 'password')->passwordInput() ?>
    <?= Html::submitButton('Login') ?>
<?php yiiwidgetsActiveForm::end(); ?>

Behind the scene, [[yiiwidgetsActiveForm]] will read the validation rules declared in the model
and generate appropriate JavaScript code for validators that support client-side validation. When a user
changes the value of an input field or submit the form, the client-side validation JavaScript will be triggered.

If you want to turn off client-side validation completely, you may configure the
[[yiiwidgetsActiveForm::enableClientValidation]] property to be false. You may also turn off client-side
validation of individual input fields by configuring their [[yiiwidgetsActiveField::enableClientValidation]]
property to be false. When enableClientValidation is configured at both the input field level and the form level,
the former will take precedence.

Implementing Client-Side Validation

To create a validator that supports client-side validation, you should implement the
[[yiivalidatorsValidator::clientValidateAttribute()]] method which returns a piece of JavaScript code
that performs the validation on the client side. Within the JavaScript code, you may use the following
predefined variables:

• attribute: the name of the attribute being validated.
• value: the value being validated.
• messages: an array used to hold the validation error messages for the attribute.
• deferred: an array which deferred objects can be pushed into (explained in the next subsection).

In the following example, we create a StatusValidator which validates if an input is a valid status input
against the existing status data. The validator supports both server side and client side validation.

namespace appcomponents;

use yiivalidatorsValidator;
use appmodelsStatus;

class StatusValidator extends Validator
{
    public function init()
    {
        parent::init();
        $this->message = 'Invalid status input.';
    }

    public function validateAttribute($model, $attribute)
    {
        $value = $model->$attribute;
        if (!Status::find()->where(['id' => $value])->exists()) {
            $model->addError($attribute, $this->message);
        }
    }

    public function clientValidateAttribute($model, $attribute, $view)
    {
        $statuses = json_encode(Status::find()->select('id')->asArray()->column());
        $message = json_encode($this->message, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        return <<<JS
if (!$.inArray(value, $statuses)) {
    messages.push($message);
}
JS;
    }
}

Tip: The above code is given mainly to demonstrate how to support client-side validation. In practice,
you may use the in core validator to achieve the same goal. You may
write the validation rule like the following:

[
    ['status', 'in', 'range' => Status::find()->select('id')->asArray()->column()],
]

Deferred Validation

If you need to perform asynchronous client-side validation, you can create Deferred objects.
For example, to perform a custom AJAX validation, you can use the following code:

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.push($.get("/check", {value: value}).done(function(data) {
            if ('' !== data) {
                messages.push(data);
            }
        }));
JS;
}

In the above, the deferred variable is provided by Yii, which is an array of Deferred objects. The $.get()
jQuery method creates a Deferred object which is pushed to the deferred array.

You can also explicitly create a Deferred object and call its resolve() method when the asynchronous callback
is hit. The following example shows how to validate the dimensions of an uploaded image file on the client side.

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        var def = $.Deferred();
        var img = new Image();
        img.onload = function() {
            if (this.width > 150) {
                messages.push('Image too wide!!');
            }
            def.resolve();
        }
        var reader = new FileReader();
        reader.onloadend = function() {
            img.src = reader.result;
        }
        reader.readAsDataURL(file);

        deferred.push(def);
JS;
}

Note: The resolve() method must be called after the attribute has been validated. Otherwise the main form
validation will not complete.

For simplicity, the deferred array is equipped with a shortcut method add() which automatically creates a Deferred
object and adds it to the deferred array. Using this method, you can simplify the above example as follows,

public function clientValidateAttribute($model, $attribute, $view)
{
    return <<<JS
        deferred.add(function(def) {
            var img = new Image();
            img.onload = function() {
                if (this.width > 150) {
                    messages.push('Image too wide!!');
                }
                def.resolve();
            }
            var reader = new FileReader();
            reader.onloadend = function() {
                img.src = reader.result;
            }
            reader.readAsDataURL(file);
        });
JS;
}

AJAX Validation

Some validations can only be done on the server side, because only the server has the necessary information.
For example, to validate if a username is unique or not, it is necessary to check the user table on the server side.
You can use AJAX-based validation in this case. It will trigger an AJAX request in the background to validate the
input while keeping the same user experience as the regular client-side validation.

To enable AJAX validation for a single input field, configure the [[yiiwidgetsActiveField::enableAjaxValidation|enableAjaxValidation]]
property of that field to be true and specify a unique form id:

use yiiwidgetsActiveForm;

$form = ActiveForm::begin([
    'id' => 'registration-form',
]);

echo $form->field($model, 'username', ['enableAjaxValidation' => true]);

// ...

ActiveForm::end();

To enable AJAX validation for the whole form, configure [[yiiwidgetsActiveForm::enableAjaxValidation|enableAjaxValidation]]
to be true at the form level:

$form = ActiveForm::begin([
    'id' => 'contact-form',
    'enableAjaxValidation' => true,
]);

Note: When the enableAjaxValidation property is configured at both the input field level and the form level,
the former will take precedence.

You also need to prepare the server so that it can handle the AJAX validation requests.
This can be achieved by a code snippet like the following in the controller actions:

if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}

The above code will check whether the current request is an AJAX. If yes, it will respond to
this request by running the validation and returning the errors in JSON format.

Info: You can also use Deferred Validation to perform AJAX validation.
However, the AJAX validation feature described here is more systematic and requires less coding effort.