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-функция проверки, описанная здесь более интегрированная и требует меньше усилий к написанию кода.

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

// Вывести ошибки можно как по ходу исполнения кода, так и в любом другом месте формы или перед ней
if(!$model->save())
print_r($model->errors);

// Или
print_r($model->getErrors());

// Или
foreach ($model->errors as $key => $value) {
  print_r($key.': '.$value[0]);
}

// Или
// Данный метод используется внутри формы
<?= $form->errorSummary($model); ?>

Перейти к содержимому

<?php
use yiihelpersHtml;
use yiiwidgetsActiveForm;

/* @var $this yiiwebView */
/* @var $model frontendmodelsUser */
/* @var $form yiiwidgetsActiveForm */
?>

<div class="participant-form">
<?php $form = ActiveForm::begin(); ?>

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

...

Вывод ошибок валидации формы

public function actionMyaction() {
    $model = $this->account_data;
    if (isset($_POST['Account'])) {
      $model->attributes = $_POST['Account'];
      $model->save();
    }
    var_dump($model->getErrors());
    $this->render('my-view', array(
      'model' => $model,
    ));
  }

<?php
  /** @var BootActiveForm $form */
  $form = $this->beginWidget('bootstrap.widgets.TbActiveForm', array(
    'id' => 'myform',
  ));
  ?>
  <?php echo $form->errorSummary($model); ?>
  <?php echo $form->passwordFieldRow($model, 'old_password', array('class' => 'span3')); ?>
  <?php echo $form->passwordFieldRow($model, 'new_password', array('class' => 'span3')); ?>
  <?php echo $form->passwordFieldRow($model, 'password_repeat', array('class' => 'span3')); ?>
  <div class="form-actions">
    <?php $this->widget('bootstrap.widgets.TbButton', array('buttonType' => 'submit', 'label' => 'Изменить пароль', 'htmlOptions' => array('name' => 'change-password'))); ?>
  </div>
  <?php $this->endWidget(); ?>

array('old_password, new_password, password_repeat', 'required'),

if (isset($_POST['ajax']) && $_POST['ajax']==='Account')
 {
      echo CActiveForm::validate($model);
      Yii::app()->end();
    }
if(isset($_POST[Account']))
            {
                $model->attributes=$_POST['Account'];
                if($model->validate()) {
                    $model->save();
                }
            }

//      array('old_password, new_password, password_repeat', 'required', 'on' => 'edit-password'),
//      array('new_password', 'compare', 'compareAttribute' => 'password_repeat', 'on' => 'edit-password'),
      array('old_password, new_password, password_repeat', 'required'),
      array('new_password', 'compare', 'compareAttribute' => 'password_repeat'), 

$model= new Account('Сценарий');
if(isset($_POST['Account'])){
$model->attributes = $_POST['Account'];
}
 

 public function actionChangepassword() {
//    $model = $this->account_data;
//    $model = GeneralAccount::model()->findByPk(Yii::app()->user->id);
    $model = new GeneralAccount('editpassword');
    $model->setScenario('editpassword');
    if (isset($_POST['GeneralAccount'])) {
      $model->attributes = $_POST['GeneralAccount'];
      $model->validate();
      $model->addError('old_password', 'test');
      $errors = $model->errors;
    }
//    d($errors);
    $this->render('change-password', array(
      'model' => $model,
      'errors' => $errors,
    ));
  }
 

<?php
  $form = $this->beginWidget('bootstrap.widgets.TbActiveForm', array(
    'id' => 'horizontalForm',
    'type' => 'horizontal',
    'enableClientValidation' => false,
    'clientOptions' => array(
      'validateOnSubmit' => true,
      'hideErrorMessage' => false,
    ),
  ));
  ?>
<? d($model->errors); ?>
<? d($errors); ?>
  <?= $form->errorSummary($model); ?>
  <?= $form->textField($model, 'old_password') ?>
  <?= $form->textField($model, 'new_password') ?>
  <?= $form->textField($model, 'password_repeat') ?>

  <div class="form-actions">
    <?php echo CHtml::submitButton('Save Changes'); ?>
  </div>
  <?php $this->endWidget(); ?>

I would like to do custom validation in yii2 but this doesnt work.

What i would like is to validate whenever truck status is not 17 or 18 that is if eg its 12 this error should be returned, but the error is always displayed

  public function validateRegno()
{
    $truck = TblTrucks::find()->where(["reg_no"=>$this->reg_no])->all();

    if ($truck) {
        if(!$truck->truck_status ==18 || !$truck->truck_status ==17){
            $this->addError('reg_no', 'The truck is not yet cleared by customer service');
        }


    }
}

These are the model rules

public function rules()
{
    return [
        [['reg_no', 'truck_category', 'added_by', 'truck_status', 'driver_name'], 'required'],
        [['truck_category', 'added_by', 'truck_status', 'is_normal'], 'integer'],
        [['added_on'], 'safe'],
        [['reg_no'], 'string', 'max' => 50],

        ['reg_no', 'validateRegno','on' => 'create'],

}

This is my form

  <?php $form = ActiveForm::begin(['id' => $model->formName(),
        'enableAjaxValidation' => true,
        //'enableClientValidation' => true,
        'validationUrl' => ['truck/validate'],

    ]); ?>

In the controller

(truck/validate)
  public function actionValidate(){
    $model = new TblTrucks();
    $model->scenario = 'create';
    if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {

        if (!$model->validate()) {
            Yii::$app->response->format='json';
            return ActiveForm::validate($model);
        }
    }
}

/06 Tips /How to Display Form Errors (the ErrorSummary)

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

Простой вариант

Класс модели:

<?php
namespace appmodels;
use yiibaseModel;

/**
 * Модель для формы обратной связи
 */
class FeedbackForm extends Model
{
    public $name, $email, $body;

    public function attributeLabels() {
        return [
            'name' => 'Ваше имя',
            'email' => 'Ваш email',
            'body' => 'Сообщение',
        ];
    }

    public function rules() {
        return [
            // удалить пробелы для полей name и email
            [['name', 'email'], 'trim'],
            // поле name обязательно для заполнения
            ['name', 'required', 'message' => 'Поле «Ваше имя» обязательно для заполнения'],
            // поле email обязательно для заполнения
            ['email', 'required', 'message' => 'Поле «Ваш email» обязательно для заполнения'],
            // поле email должно быть корректным адресом почты
            ['email', 'email', 'message' => 'Поле «Ваш email» должно быть адресом почты'],
            /*
             * Поле формы обязательно должно проходить валидацию, даже если оно не обязательное.
             * В противном случае, поле не пройдет валидацию, независимо от того, пустое оно или
             * нет. Здесь мы просто говорим, что поле безопасное (safe). Можно было вместо safe
             * использовать trim или default — главное, чтобы хоть какой-нибудь валидатор был
             * использован.
             */
            ['body', 'safe']
        ];
    }
}

Класс контроллера:

<?php
namespace appcontrollers;

use Yii;
use yiiwebController;
use appmodelsFeedbackForm;

class PageController extends Controller {
    public function actionIndex() {
        return $this->render('index');
    }

    public function actionFeedback() {
        $model = new FeedbackForm();
        // если пришли post-данные, загружаем их в модель...
        if ($model->load(Yii::$app->request->post())) {
            // ...и проверяем эти данные
            if ($model->validate()) {
                // данные прошли валидацию, отмечаем этот факт
                Yii::$app->session->setFlash(
                    'validate',
                    true
                );
                // перезагружаем страницу, чтобы избежать повторной отправки формы
                return $this->refresh();
            } else {
                // данные не прошли валидацию, отмечаем этот факт
                Yii::$app->session->setFlash(
                    'validate',
                    false
                );
                // не перезагружаем страницу, чтобы сохранить пользовательские данные
            }
        }
        return $this->render('feedback', ['model' => $model]);
    }
}

Шаблон формы:

<?php
/* @var $this yiiwebView */

use yiiwidgetsActiveForm;
use yiihelpersHtml;

$this->title = 'Обратная связь';
?>

<?php if (Yii::$app->session->hasFlash('validate')): ?>
    <?php if (Yii::$app->session->getFlash('validate')): ?>
        <p>Данные формы прошли валидацию</p>
    <?php else: ?>
        <p>Данные формы не прошли валидацию</p>
    <?php endif; ?>
<?php endif; ?>

<div class="site-feedback">
    <h1><?= Html::encode($this->title) ?></h1>

    <?php $form = ActiveForm::begin(['id' => 'feedback-form', 'options' => ['novalidate' => '']]); ?>
        <?= $form->field($model, 'name')->textInput(); ?>
        <?= $form->field($model, 'email')->textInput(); ?>
        <?= $form->field($model, 'body')->textarea(['rows' => 5]); ?>
        <?= Html::submitButton('Отправить', ['class' => 'btn btn-primary']); ?>
    <?php ActiveForm::end(); ?>
</div>

Чтобы ошибки валидации на стороне клиента не мешали тестированию, есть смысл отключить в браузере поддержку JavaScript.

<div class="alert alert-warning alert-dismissible" role="alert">
    <?= Html::errorSummary($model); ?>
</div>

<?php $form = ActiveForm::begin(); ?>
    <?= $form->errorSummary($model); ?>
    ..........
    <?= Html::submitButton('Отправить'); ?>
<?php ActiveForm::end(); ?>

Вариант посложнее

Класс модели:

<?php
namespace appmodels;
use yiibaseModel;

/**
 * Модель для формы обратной связи
 */
class FeedbackForm extends Model
{
    public $name, $email, $body;

    public function attributeLabels() {
        return [
            'name' => 'Ваше имя',
            'email' => 'Ваш email',
            'body' => 'Сообщение',
        ];
    }

    public function rules() {
        return [
            // удалить пробелы для полей name и email
            [['name', 'email'], 'trim'],
            // поле name обязательно для заполнения
            ['name', 'required', 'message' => 'Поле «Ваше имя» обязательно для заполнения'],
            // поле email обязательно для заполнения
            ['email', 'required', 'message' => 'Поле «Ваш email» обязательно для заполнения'],
            // поле email должно быть корректным адресом почты
            ['email', 'email', 'message' => 'Поле «Ваш email» должно быть адресом почты'],
            // поле body не проверяем
            ['body', 'safe'],
        ];
    }
}

Класс контроллера:

<?php
namespace appcontrollers;

use Yii;
use yiiwebController;
use appmodelsFeedbackForm;

class PageController extends Controller {
    public function actionIndex() {
        return $this->render('index');
    }

    public function actionFeedback() {
        $model = new FeedbackForm();
        // если пришли post-данные, загружаем их в модель...
        if ($model->load(Yii::$app->request->post())) {
            // ...и проверяем эти данные
            if ( ! $model->validate()) {
                // данные не прошли валидацию, отмечаем этот факт
                Yii::$app->session->setFlash(
                    'validate',
                    false
                );
                // сохраняем в сессии введенные пользователем данные
                Yii::$app->session->setFlash(
                    'form-data',
                    [
                        'name' => $model->name,
                        'email' => $model->email,
                        'body' => $model->body
                    ]
                );
                /* 
                 * Сохраняем в сессии массив сообщений об ошибках. Массив имеет вид
                 * [
                 *     'name' => [
                 *         'Поле «Ваше имя» обязательно для заполнения',
                 *     ],
                 *     'email' => [
                 *         'Поле «Ваш email» обязательно для заполнения',
                 *         'Поле «Ваш email» должно быть адресом почты'
                 *     ]
                 * ]
                 */
                Yii::$app->session->setFlash(
                    'form-errors',
                    $model->getErrors()
                );
            } else {
                // данные прошли валидацию, отмечаем этот факт
                Yii::$app->session->setFlash(
                    'validate',
                    true
                );
            }
            // выполняем редирект, чтобы избежать повторной отправки формы
            return $this->refresh();
        }
        return $this->render('feedback', ['model' => $model]);
    }
}

Шаблон формы:

<?php
/* @var $this yiiwebView */

use yiiwidgetsActiveForm;
use yiihelpersHtml;

$this->title = 'Обратная связь';

// Если форма не прошла проверку на сервере, мы должны снова показать форму,
// заполненную введенными ранее данными, не заставляя вводить их повторно
$data = [
    'name' => '',
    'email' => '',
    'body' => '',
];
?>

<?php if (Yii::$app->session->hasFlash('validate')): /* данные формы были отправлены? */ ?>
    <?php if ( ! Yii::$app->session->getFlash('validate')): /* форма не прошла валидацию */ ?>
        <?php
        // Если данные не прошли валидацию, получаем из сессии сохраненные данные, чтобы
        // заполнить ими поля формы, не заставляя пользователя заполнять форму повторно
        if (Yii::$app->session->hasFlash('form-data')) {
            $data['name'] = Html::encode(Yii::$app->session->getFlash('form-data')['name']);
            $data['email'] = Html::encode(Yii::$app->session->getFlash('form-data')['email']);
            $data['body'] = Html::encode(Yii::$app->session->getFlash('form-data')['body']);
        }
        ?>
        <div class="alert alert-warning alert-dismissible" role="alert">
            <button type="button" class="close" data-dismiss="alert" aria-label="Закрыть">
                <span aria-hidden="true">&times;</span>
            </button>
            <p>При заполнении формы допущены ошибки</p>
            <?php if (Yii::$app->session->hasFlash('form-errors')): /* ошибки */ ?>
                <?php $allErrors = Yii::$app->session->getFlash('form-errors'); ?>
                <ul>
                <?php foreach ($allErrors as $errors): ?>
                    <?php foreach ($errors as $error): ?>
                        <li><?= $error; ?></li>
                    <?php endforeach; ?>
                <?php endforeach; ?>
                </ul>
            <?php endif; ?>
        </div>
    <?php else: /* форма прошла валидацию */ ?>
        <div class="alert alert-success alert-dismissible" role="alert">
            <button type="button" class="close" data-dismiss="alert" aria-label="Закрыть">
                <span aria-hidden="true">&times;</span>
            </button>
            <p>Данные формы прошли валидацию.</p>
        </div>
    <?php endif; ?>
<?php endif; ?>

<div class="site-feedback">
    <h1><?= Html::encode($this->title) ?></h1>

    <?php $form = ActiveForm::begin(['id' => 'feedback-form', 'options' => ['novalidate' => '']]); ?>
        <?= $form->field($model, 'name')->textInput(['value' => $data['name']]); ?>
        <?= $form->field($model, 'email')->textInput(['value' => $data['email']]); ?>
        <?= $form->field($model, 'body')->textarea(['rows' => 5, 'value' => $data['body']]); ?>
        <?= Html::submitButton('Отправить', ['class' => 'btn btn-primary']); ?>
    <?php ActiveForm::end(); ?>
</div>

Что мы делаем в контроллере:

1. Если данные формы были отправлены, вызываем метод validate() модели
2. Записываем в сессию результат проверки данных формы с ключом validate
3. Если форма не прошла проверку, записываем в сессию массив сообщений об ошибках
4. Если форма не прошла проверку, записываем в сессию массив значений полей формы
5. В любом случае, после POST-запроса делаем редирект

Что мы делаем в шаблоне:

1. Если все поля формы прошли валидацию, просто показываем пользователю сообщение об этом
2. Если поля формы не прошли валидацию, показываем список ошибок, которые были допущены
3. Если поля формы не прошли валидацию, заполняем поля формы введенными ранее данными

Поиск:
PHP • POST • Web-разработка • Yii2 • Форма • Form • Framework • Фреймворк • Validate • Валидация

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

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

Учитывая модель данных которые должен заполнить пользователь, можно проверить эти данные на валидность воспользовавшись методом [[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;
}

• Правила проверки
  • Настройка сообщений об ошибках
  • События валидации
  • Условные валидации
  • Фильтрация данных
  • Обработка пустых входных данных
• Специальная валидация
• Создание Валидаторов
  • Встроенные Валидаторы
  • Автономные валидаторы
• Валидация на стороне клиента
  • Использование валидации на стороне клиента
  • Реализация проверки на стороне клиента
  • Отложенная валидация
  • AJAX валидация

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

Для того, чтобы 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 = '[email protected]';
$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-функция проверки, описанная здесь более интегрированная и требует меньше усилий к написанию кода.

Заберите ссылку на статью к себе, чтобы потом легко её найти!
Выберите, то, чем пользуетесь чаще всего:

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

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

$model = new appmodelsContactForm();


$model->load(Yii::$app->request->post());



if ($model->validate()) {
    
} else {
    
    $errors = $model->errors;
}

Declaring Rules

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

public function rules()
{
    return [
        
        [['name', 'email', 'subject', 'body'], 'required'],

        
        ['email', 'email'],
    ];
}

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

[
    
    
    
    ['attribute1', 'attribute2', ...],

    
    
    'validator',

    
    
    
    
    'on' => ['scenario1', 'scenario2', ...],

    
    'property1' => 'value1', 'property2' => 'value2', ...
]

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

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

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

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

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

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

Примечание: удобно давать названия правилам, т.е.

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

Вы можете использовать его в детской модели:

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

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

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

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

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

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

Validation Events

Когда вызывается yii base Model :: validate () , он вызывает два метода, которые вы можете переопределить для настройки процесса проверки:

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

Conditional Validation

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

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

Свойство when принимает вызываемый PHP-объект со следующей подписью:

function ($model, $attribute)

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

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

Data Filtering

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

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

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

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

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

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

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

Приведенный выше код выполнит следующие операции на входе:

1. Обрежьте пробелы от входного значения.
2. Убедитесь, что пустой ввод хранится в базе данных как null ; мы различаем значение «не установлено» и фактическое значение 0 . Если null не разрешен, вы можете установить здесь другое значение по умолчанию.
3. Убедитесь, что значение является целым числом больше 0, если оно не пустое. В обычных валидаторах для $ skipOnEmpty установлено значение true .
4. Убедитесь, что значение имеет целочисленный тип, например преобразование строки '42' в целое число 42 . Здесь мы устанавливаем для $ skipOnEmpty значение true , которое по умолчанию на валидаторе фильтра равно false .

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

Когда входные данные отправляются из 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);
    }]

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

Yii

2.0

• Получение данных для нескольких моделей

• Сбор табличного ввода

• Ad Hoc Validation

• Client-Side Validation