Проверка ввода

Основы использования

Laravel поставляется с простой, удобной системой проверки ввода и получения сообщений об ошибках — классом PHPValidation.

Простейший пример проверки ввода

$validator = Validator::make(
  array('name' => 'Дейл'),
  array('name' => 'required|min:5')
);

Первый параметр, передаваемый методу PHPValidator::make() — данные для проверки. Второй параметр — правила, которые к ним должны быть применены.

Использование массивов для указания правил

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

$validator = Validator::make(
  array('name' => 'Дейл'),
  array('name' => array('required', 'min:5'))
);

Проверка нескольких полей

$validator = Validator::make(
  array(
    'name' => 'Дейл',
    'password' => 'плохойпароль',
    'email' => 'email@example.com'
  ),
  array(
    'name' => 'required',
    'password' => 'required|min:8',
    'email' => 'required|email|unique:users'
  )
);

Как только был создан экземпляр PHPValidator, метод PHPfails() (или PHPpasses()) может быть использован для проведения проверки.

if ($validator->fails()) {
  // Переданные данные не прошли проверку.
}

Если PHPValidator нашёл ошибки, вы можете получить его сообщения таким образом:

$messages = $validator->messages();

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

$failed = $validator->failed();

Проверка файлов

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

Работа с сообщениями об ошибках

После вызова метода PHPValidator::messages() вы получите объект PHPMessageBag, который имеет набор полезных методов для доступа к сообщеням об ошибках.

Получение первого сообщения для поля

echo $messages->first('email');

Получение всех сообщений для одного поля

foreach ($messages->get('email') as $message) {
  //
}

Получение всех сообщений для всех полей

foreach ($messages->all() as $message) {
  //
}

Проверка на наличие сообщения для поля

if ($messages->has('email')) {
  //
}

Получение ошибки в заданном формате

echo $messages->first('email', '<p>:message</p>');

По умолчанию сообщения форматируются в вид, который подходит для Bootstrap.

Получение всех сообщений в заданном формате

foreach ($messages->all('<li>:message</li>') as $message) {
  //
}

Ошибки и шаблоны

Как только вы провели проверку вам понадобиться простой способ, чтобы передать ошибки обратно в шаблон. Laravel позволяет удобно сделать это. Представьте, что у нас есть такие правила:

Route::get('register', function () {
  return View::make('user.register');
});

Route::post('register', function () {
  $rules = array(...);

  $validator = Validator::make(Input::all(), $rules);

  if ($validator->fails()) {
    return Redirect::to('register')->withErrors($validator);
  }
});

Заметьте, что когда проверки не пройдены, мы передаём объект PHPValidator объекту переадресации PHPRedirect с помощью метода PHPwithErrors(). Этот метод сохранит сообщения об ошибках в одноразовых переменных сессии, таким образом делая их доступными для следующего запроса.

Однако мы не всегда должны явно передавать сообщения об ошибках в наших GET-маршрутах. Laravel проверяет данные сессии на наличие сообщений и автоматически привязывает их к шаблону, если они доступны. Таким образом, важно помнить, что переменная PHP$errors будет доступна для всех ваших шаблонов всегда, при любом запросе. Это позволяет вам считать, что переменная PHP$errors всегда определена и может безопасно использоваться. Переменная PHP$errors — экземпляр класса PHPMessageBag.

Таким образом, после переадресации вы можете прибегнуть к автоматически установленной в шаблоне переменной PHP$errors:

<?php echo $errors->first('email'); ?>

return Redirect::to('register')->withErrors($validator, 'login');

<?php echo $errors->login->first('email'); ?>

Доступные правила проверки

accepted

Поле должно быть в значении yes, on или 1. Это полезно для проверки принятия правил и лицензий.

active_url

Поле должно быть корректным URL, доступным через функцию checkdnsrr.

after:date

Поле должно быть датой, более поздней, чем date. Строки приводятся к датам функцией strtotime.

alpha

Поле должно содержать только латинские символы.

alpha_dash

Поле должно содержать только латинские символы, цифры, знаки подчёркивания (_) и дефисы (-).

alpha_num

Поле должно содержать только латинские символы и цифры.

before:date

Поле должно быть датой, более ранней, чем date. Строки приводятся к датам функцией strtotime.

between:min,max

Поле должно быть числом в диапазоне от min до max. Строки, числа и файлы трактуются аналогично правилу size.

confirmed

Значение поля должно соответствовать значению поля с этим именем, плюс _confirmation. Например, если проверяется поле password, то на вход должно быть передано совпадающее по значению поле password_confirmation.

date

Поле должно быть правильной датой в соответствии с функцией strtotime.

date_format:format

Поле должно подходить под формату даты format в соответствии с функцией date_parse_from_format.

different:field

Значение проверяемого поля должно отличаться от значения поля field.

email

Поле должно быть корректным адресом e-mail.

exists:table,column

Поле должно существовать в заданной таблице базы данных.

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

'state' => 'exists:states'

Указание имени поля в таблице

'state' => 'exists:states,abbreviation'

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

'email' => 'exists:staff,email,account_id,1'

'email' => 'exists:staff,email,deleted_at,NULL'

image

Загруженный файл должен быть изображением в формате JPEG, PNG, BMP или GIF.

in:foo,bar,…

Значение поля должно быть одним из перечисленных (foo, bar и т.д.).

integer

Поле должно иметь корректное целочисленное значение.

ip

Поле должно быть корректным IP-адресом.

max:value

Значение поля должно быть меньше или равно value. Строки, числа и файлы трактуются аналогично правилу size.

mimes:foo,bar,…

MIME-тип загруженного файла должен быть одним из перечисленных.

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

'photo' => 'mimes:jpeg,bmp,png'

min:value

Значение поля должно быть более value. Строки, числа и файлы трактуются аналогично правилу size.

not_in:foo,bar,…

Значение поля не должно быть одним из перечисленных (foo, bar и т.д.).

numeric

Поле должно иметь корректное числовое или дробное значение.

regex:pattern

Поле должно соответствовать заданному регулярному выражению.

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

required

Проверяемое поле должно иметь непустое значение.

required_if:field,value,…

Проверяемое поле должно иметь непустое значение, если другое поле field имеет любое значение value (начиная с версии 4.2 можно передать больше одного value через запятую — прим. пер.).

required_with:foo,bar,…

Проверяемое поле должно иметь непустое значение, но только если присутствует любое из перечисленных полей (foo, bar и т.д.).

required_without:foo,bar,…

Проверяемое поле должно иметь непустое значение, но только если не присутствует любое из перечисленных полей (foo, bar и т.д.).

same:field

Поле должно иметь то же значение, что и поле field.

size:value

Поле должно иметь совпадающий с value размер. Для строк это обозначает длину, для чисел — число, для файлов — размер в килобайтах.

unique:table,column,except,idColumn

Значение поля должно быть уникальным в заданной таблице базы данных. Если column не указано, то будет использовано имя поля.

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

'email' => 'unique:users'

Указание имени поля в таблице

'email' => 'unique:users,email_address'

Игнорирование определённого ID

'email' => 'unique:users,email_address,10'

Добавление дополнительных условий

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

'email' => 'unique:users,email_address,NULL,id,account_id,1'

В правиле выше только строки с account_id равном 1 будут включены в проверку.

url

Поле должно быть корректным URL.

Эта функция использует PHP-метод PHPfilter_var().

Условные правила

$v = Validator::make($data, array(
  'email' => 'sometimes|required|email',
));

Сложные условные проверки

Иногда вам может быть нужно, чтобы поле имело какое-либо значение только если другое поле имеет значение, скажем, больше 100. Или вы можете требовать наличия двух полей только, когда также указано третье. Это легко достигается условными правилами. Сперва создайте объект PHPValidator с набором статичных правил, которые никогда не изменяются:

$v = Validator::make($data, array(
  'email' => 'required|email',
  'games' => 'required|numeric',
));

Теперь предположим, что ваше приложения написано для коллекционеров игр. Если регистрируется коллекционер с более, чем 100 играми, то мы хотим их спросить, зачем им такое количество. Например, у них может быть магазин или может им просто нравится их собирать. Итак, для добавления такого условного правила мы используем метод PHPValidator::sometimes():

$v->sometimes('reason', 'required|max:500', function ($input) {
  return $input->games >= 100;
});

Первый параметр этого метода — имя поля, которое мы проверяем. Второй параметр — правило, которое мы хотим добавить, если переданная функция-замыкание (третий параметр) вернёт PHPtrue. Этот метод позволяет легко создавать сложные правила проверки ввода. Вы можете даже добавлять одни и те же условные правила для нескольких полей одновременно:

$v->sometimes(array('reason', 'cost'), 'required', function ($input) {
  return $input->games >= 100;
});

Параметр PHP$input, передаваемый замыканию — объект PHPIlluminate\Support\Fluent и может использоваться для чтения проверяемого ввода и файлов.

Собственные сообщения об ошибках

Вы можете передать собственные сообщения об ошибках вместо используемых по умолчанию. Есть несколько способов это сделать.

Передача своих сообщений в PHPValidator

$messages = array(
  'required' => 'Поле :attribute должно быть заполнено.',
);

$validator = Validator::make($input, $rules, $messages);

Строка :attribute будет заменена на имя проверяемого поля. Вы также можете использовать и другие строки-переменные.

Использование других переменных-строк

$messages = array(
  'same'    => 'Значения :attribute и :other должны совпадать.',
  'size'    => 'Поле :attribute должно быть ровно exactly :size.',
  'between' => 'Значение :attribute должно быть от :min и до :max.',
  'in'      => 'Поле :attribute должно иметь одно из следующих значений: :values',
);

Указание собственного сообщения для отдельного поля

Иногда вам может потребоваться указать своё сообщение для отдельного поля:

$messages = array(
  'email.required' => 'Нам нужно знать ваш e-mail адрес!',
);

Указание собственных сообщений в языковом файле

Может быть также полезно определять эти сообщения в языковом файле вместо того, чтобы передавать их в PHPValidator напрямую. Для этого добавьте сообщения в массив custom языкового файла app/lang/xx/validation.php.

'custom' => array(
  'email' => array(
    'required' => 'Нам нужно знать ваш e-mail адрес!',
  ),
),

Собственные правила проверки

Регистрация собственного правила

Laravel изначально содержит множество полезных правил, однако вам может понадобиться создать собственные. Одним из способов зарегистрировать произвольное правило — через метод PHPValidator::extend():

Validator::extend('foo', function ($attribute, $value, $parameters) {
  return $value == 'foo';
});

Переданная функция-замыкание получает три параметра: имя проверяемого поля PHP$attribute, значение поля PHP$value и массив параметров PHP$parameters, переданных правилу.

Вместо замыкания в метод PHPextend() также можно передать ссылку на метод класса:

Validator::extend('foo', 'FooValidator@validate');

Обратите внимание, что вам также понадобиться определить сообщение об ошибке для нового правила. Вы можете сделать это либо передавая его в виде массива строк в PHPValidator, либо вписав в языковой файл.

Расширение класса PHPValidator

Вместо использования функций-замыканий для расширения набора доступных правил вы можете расширить сам класс PHPValidator. Для этого создайте класс, который наследует PHPIlluminate\Validation\Validator. Вы можете добавить новые методы проверок, начав их имя с validate:

<?php

  class CustomValidator extends Illuminate\Validation\Validator {

    public function validateFoo($attribute, $value, $parameters)
    {
      return $value == 'значение';
    }

  }

Регистрация нового класса PHPValidator

Затем вам нужно зарегистрировать собственное расширение:

Validator::resolver(function ($translator, $data, $rules, $messages) {
  return new CustomValidator($translator, $data, $rules, $messages);
});

Иногда при создании своего класса вам может понадобиться определить собственные строки-переменные для замены в сообщениях об ошибках. Это делается путём создания класса, как было описано выше, и добавлением функций с именами вида PHPreplaceXXX().

protected function replaceFoo ($message, $attribute, $rule, $parameters) {
  return str_replace(':foo', $parameters[0], $message);
}

Validator::replacer('rule', function($message, $attribute, $rule, $parameters)
{
  //
});