Валидация
- Введение
-
Быстрый старт
- Определение маршрутов
- Создание контроллера
- Написание логики валидации
- Отображение ошибок валидации
- Повторное заполнение форм
- Примечание о необязательных полях
-
Валидация запроса формы
- Создание запросов формы
- Авторизация запросов
- Корректировка сообщений об ошибках
- Подготовка входящих данных для валидации
-
Создание валидатора по требованию
- Автоматическое перенаправление
- Именованные коллекции ошибок
- Корректировка сообщений об ошибках
- Хук валидатора After
- Работа с проверенными данными
-
Работа с сообщениями об ошибках
- Указание пользовательских сообщений в языковых файлах
- Указание атрибутов в языковых файлах
- Указание пользовательских имен для атрибутов в языковых файлах
- Доступные правила валидации
- Условное добавление правил
-
Валидация массивов
- Исключение непроверенных ключей массива
- Проверка входных данных вложенного массива
- Валидация паролей
-
Пользовательские правила валидации
- Использование класса Rule
- Использование замыканий
- Неявные правила
Введение
Laravel предлагает несколько подходов для проверки входящих данных вашего приложения. Например, метод validate
, доступен для всех входящих HTTP-запросов. Однако мы обсудим и другие подходы к валидации.
Laravel содержит удобные правила валидации, применяемые к данным, включая валидацию на уникальность значения в конкретной таблице базы данных. Мы подробно рассмотрим каждое из этих правил валидации, чтобы вы были знакомы со всеми особенностями валидации Laravel.
Быстрый старт
Чтобы узнать о мощных функциях валидации Laravel, давайте рассмотрим полный пример валидации формы и отображения сообщений об ошибках конечному пользователю. Прочитав этот общий обзор, вы сможете получить представление о том, как проверять данные входящего запроса с помощью Laravel:
Определение маршрутов
Во-первых, предположим, что в нашем файле routes/web.php
определены следующие маршруты:
use App\Http\Controllers\PostController;
Route::get('/post/create', [PostController::class, 'create']);
Route::post('/post', [PostController::class, 'store']);
Маршрут GET
отобразит форму для пользователя для создания нового сообщения в блоге, а маршрут POST
сохранит новое сообщение в базе данных.
Создание контроллера
Теперь давайте взглянем на простой контроллер, который обрабатывает запросы, входящие на эти маршруты. Пока оставим метод store
пустым:
<?php
namespace App\Http\Controllers;
use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
class PostController extends Controller
{
/**
* Показать форму для создания нового сообщения в блоге.
*
* @return \Illuminate\View\View
*/
public function create()
{
return view('post.create');
}
/**
* Сохранить новую запись в блоге.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/
public function store(Request $request)
{
// Выполнить валидацию и сохранить сообщение в блоге ...
}
}
Написание логики валидации
Теперь мы готовы заполнить наш метод store
логикой для валидации нового сообщения в блоге. Для этого мы будем использовать метод validate
, предоставляемый объектом Illuminate\Http\Request
. Если правила валидации будут пройдены, то ваш код продолжит нормально выполняться; однако, если проверка не пройдена, то будет создано исключение Illuminate\Validation\ValidationException
и соответствующий ответ об ошибке будет автоматически отправлен обратно пользователю.
Если валидации не пройдена во время традиционного HTTP-запроса, то будет сгенерирован ответ-перенаправление на предыдущий URL-адрес. Если входящий запрос является XHR-запросом, то будет возвращен JSON-ответ, содержащий сообщения об ошибках валидации.
Чтобы лучше понять метод validate
, давайте вернемся к методу store
:
/**
* Сохранить новую запись в блоге.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/
public function store(Request $request)
{
$validated = $request->validate([
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
// Запись блога корректна ...
}
Как видите, правила валидации передаются в метод validate
. Не волнуйтесь – все доступные правила валидации задокументированы. Опять же, если проверка не пройдена, то будет автоматически сгенерирован корректный ответ. Если проверка пройдет успешно, то наш контроллер продолжит нормальную работу.
В качестве альтернативы правила валидации могут быть указаны как массивы правил вместо одной строки с разделителями |
:
$validatedData = $request->validate([
'title' => ['required', 'unique:posts', 'max:255'],
'body' => ['required'],
]);
Кроме того, вы можете использовать метод validateWithBag
для валидации запроса и сохранения любых сообщений об ошибках в именованную коллекцию ошибок:
$validatedData = $request->validateWithBag('post', [
'title' => ['required', 'unique:posts', 'max:255'],
'body' => ['required'],
]);
Прекращение валидации при возникновении первой ошибки
По желанию можно прекратить выполнение правил валидации для атрибута после первой ошибки. Для этого присвойте атрибуту правило bail
:
$request->validate([
'title' => 'bail|required|unique:posts|max:255',
'body' => 'required',
]);
В этом примере, если правило unique
для атрибута title
не будет пройдено, то правило max
не будет выполняться. Правила будут проверяться в порядке их назначения.
Примечание о вложенных атрибутах
Если входящий HTTP-запрос содержит данные «вложенных» полей, то вы можете указать эти поля в своих правилах валидации, используя «точечную нотацию»:
$request->validate([
'title' => 'required|unique:posts|max:255',
'author.name' => 'required',
'author.description' => 'required',
]);
С другой стороны, если имя вашего поля буквально содержит точку, то вы можете явно запретить ее интерпретацию как часть «точечной нотации», экранировав точку с помощью обратной косой черты:
$request->validate([
'title' => 'required|unique:posts|max:255',
'v1\.0' => 'required',
]);
Отображение ошибок валидации
Итак, что, если поля входящего запроса не проходят указанные правила валидации? Как упоминалось ранее, Laravel автоматически перенаправит пользователя обратно в его предыдущее местоположение. Кроме того, все ошибки валидации и входящие данные запроса будут автоматически записаны в сессию.
Переменная $errors
используется во всех шаблонах вашего приложения благодаря посреднику Illuminate\View\Middleware\ShareErrorsFromSession
, который включен в группу посредников web
. Пока применяется этот посредник, в ваших шаблонах всегда будет доступна переменная $errors
, что позволяет вам предполагать, что переменная $errors
всегда определена и может безопасно использоваться. Переменная $errors
будет экземпляром Illuminate\Support\MessageBag
. Для получения дополнительной информации о работе с этим объектом ознакомьтесь с его документацией.
Итак, в нашем примере пользователь будет перенаправлен на метод нашего контроллера create
, в случае, если валидация завершится неудачно, что позволит нам отобразить сообщения об ошибках в шаблоне:
<!-- /resources/views/post/create.blade.php -->
<h1>Создание поста блога</h1>
@if ($errors->any())
<div class="alert alert-danger">
<ul>
@foreach ($errors->all() as $error)
<li>{{ $error }}</li>
@endforeach
</ul>
</div>
@endif
<!-- Форма для создания поста блога -->
Корректировка сообщений об ошибках
Каждое встроенное правило валидации Laravel содержит сообщение об ошибке, которое находится в файле resources/lang/en/validation.php
вашего приложения. В этом файле вы найдете запись о переводе для каждого правила валидации. Вы можете изменять или модифицировать эти сообщения в зависимости от потребностей вашего приложения.
Кроме того, вы можете скопировать этот файл в каталог перевода другого языка, чтобы перевести сообщения на язык вашего приложения. Чтобы узнать больше о локализации Laravel, ознакомьтесь с полной документацией по локализации.
XHR-запросы и валидация
В этом примере мы использовали традиционную форму для отправки данных в приложение. Однако, многие приложения получают запросы XHR с фронтенда с использованием JavaScript. При использовании метода validate
, во время выполнения XHR-запроса, Laravel не будет генерировать ответ-перенаправление. Вместо этого Laravel генерирует JSON-ответ, содержащий все ошибки валидации. Этот ответ JSON будет отправлен с кодом 422 состояния HTTP.
Директива @error
Вы можете использовать директиву @error
Blade, чтобы быстро определить, существуют ли сообщения об ошибках валидации для конкретного атрибута, включая сообщения об ошибках в именованной коллекции ошибок. В директиве @error
вы можете вывести содержимое переменной $message
для отображения сообщения об ошибке:
<!-- /resources/views/post/create.blade.php -->
<label for="title">Post Title</label>
<input id="title" type="text" name="title" class="@error('title') is-invalid @enderror">
@error('title')
<div class="alert alert-danger">{{ $message }}</div>
@enderror
Если вы используете именованные коллекции ошибок, вы можете передать имя коллекции ошибок в качестве второго аргумента директивы @error
:
<input ... class="@error('title', 'post') is-invalid @enderror">
Повторное заполнение форм
Когда Laravel генерирует ответ-перенаправление из-за ошибки валидации, фреймворк автоматически краткосрочно записывает все входные данные запроса в сессию. Это сделано для того, чтобы вы могли удобно получить доступ к входным данным во время следующего запроса и повторно заполнить форму, которую пользователь попытался отправить.
Чтобы получить входные данные предыдущего запроса, вызовите метод old
экземпляра Illuminate\Http\Request
. Метод old
извлечет ранее записанные входные данные из сессии:
$title = $request->old('title');
Laravel также содержит глобального помощника old
. Если вы показываете входные данные прошлого запроса в шаблоне Blade, то удобнее использовать помощник old
для повторного заполнения формы. Если для какого-то поля не были предоставлены данные в прошлом запросе, то будет возвращен null
:
<input type="text" name="title" value="{{ old('title') }}">
Примечание о необязательных полях
По умолчанию Laravel содержит посредников App\Http\Middleware\TrimStrings
и App\Http\Middleware\ConvertEmptyStringsToNull
в глобальном стеке посредников вашего приложения. Эти посредники перечислены в классе App\Http\Kernel
. Первый из упомянутых посредников будет автоматически обрезать все входящие строковые поля запроса, а второй – конвертировать любые пустые строковые поля в null
. Из-за этого вам часто нужно будет помечать ваши «необязательные» поля запроса как nullable
, если вы не хотите, чтобы валидатор не считал такие поля недействительными. Например:
$request->validate([
'title' => 'required|unique:posts|max:255',
'body' => 'required',
'publish_at' => 'nullable|date',
]);
В этом примере мы указываем, что поле publish_at
может быть либо null
, либо допустимым представлением даты. Если модификатор nullable
не добавлен в определение правила, валидатор сочтет null
недопустимой датой.
Валидация запроса формы
Создание запросов формы
Для более сложных сценариев валидации вы можете создать «запрос формы». Запрос формы – это ваш класс запроса, который инкапсулирует свою собственную логику валидации и авторизации. Чтобы сгенерировать новый запрос формы, используйте команду make:request
Artisan:
php artisan make:request StorePostRequest
Эта команда поместит новый класс запроса формы в каталог app/Http/Requests
вашего приложения. Если этот каталог не существует в вашем приложении, то Laravel предварительно создаст его, когда вы запустите команду make:request
. Каждый запрос формы, созданный Laravel, имеет два метода: authorize
и rules
.
Как вы могли догадаться, метод authorize
проверяет, может ли текущий аутентифицированный пользователь выполнить действие, представленное запросом, а метод rules
возвращает правила валидации, которые должны применяться к данным запроса:
/**
* Получить массив правил валидации, которые будут применены к запросу.
*
* @return array
*/
public function rules()
{
return [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
];
}
Вы можете объявить любые зависимости, которые вам нужны, в сигнатуре метода
rules
. Они будут автоматически извлечены через контейнер служб Laravel.
Итак, как анализируются правила валидации? Все, что вам нужно сделать, это объявить зависимость от запроса в методе вашего контроллера. Входящий запрос формы проверяется до вызова метода контроллера, что означает, что вам не нужно загромождать контроллер какой-либо логикой валидации:
/**
* Сохранить новую запись в блоге.
*
* @param \App\Http\Requests\StorePostRequest $request
* @return Illuminate\Http\Response
*/
public function store(StorePostRequest $request)
{
// Входящий запрос прошел валидацию...
// Получить проверенные входные данные...
$validated = $request->validated();
// Получить часть проверенных входных данных...
$validated = $request->safe()->only(['name', 'email']);
$validated = $request->safe()->except(['name', 'email']);
}
При неуспешной валидации будет сгенерирован ответ-перенаправление, чтобы отправить пользователя обратно в его предыдущее местоположение. Ошибки также будут краткосрочно записаны в сессию, чтобы они были доступны для отображения. Если запрос был XHR-запросом, то пользователю будет возвращен HTTP-ответ с кодом состояния 422, включая JSON-представление ошибок валидации.
Добавление хуков after
для запросов форм
Если вы хотите добавить хук валидации after
для запроса формы, то вы можете использовать метод withValidator
. Этот метод получает полностью инициированный валидатор, что позволяет вам вызвать любой из его методов до того, как правила валидации будут фактически проанализированы:
/**
* Надстройка экземпляра валидатора.
*
* @param \Illuminate\Validation\Validator $validator
* @return void
*/
public function withValidator($validator)
{
$validator->after(function ($validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add('field', 'Что-то не так с этим полем!');
}
});
}
Прекращение валидации после первой неуспешной проверки
Добавив свойство $stopOnFirstFailure
вашему классу запроса, вы можете сообщить валидатору, что он должен прекратить валидацию всех атрибутов после возникновения первой ошибки валидации:
/**
* Остановить валидацию после первой неуспешной проверки.
*
* @var bool
*/
protected $stopOnFirstFailure = true;
Настройка ответа-перенаправления
Как обсуждалось ранее, будет сгенерирован ответ-перенаправление, чтобы отправить пользователя обратно в его предыдущее местоположение, когда проверка формы запроса не удалась. Однако вы можете настроить это поведение. Для этого определите свойство $redirect
в вашем классе запроса:
/**
* URI, на который следует перенаправлять пользователей в случае сбоя проверки.
*
* @var string
*/
protected $redirect = '/dashboard';
Или, если вы хотите перенаправить пользователей на именованный маршрут, вы можете вместо этого определить свойство $redirectRoute
:
/**
* Маршрут, на который следует перенаправлять пользователей в случае сбоя проверки.
*
* @var string
*/
protected $redirectRoute = 'dashboard';
Авторизация запросов
Класс запроса формы также содержит метод authorize
. В рамках этого метода вы можете определить, действительно ли аутентифицированный пользователь имеет право изменять текущий ресурс. Например, вы можете определить, действительно ли пользователь владеет комментарием в блоге, который он пытается обновить. Скорее всего, вы будете взаимодействовать с вашими шлюзами и политиками авторизации в этом методе:
use App\Models\Comment;
/**
* Определить, уполномочен ли пользователь выполнить этот запрос.
*
* @return bool
*/
public function authorize()
{
$comment = Comment::find($this->route('comment'));
return $comment && $this->user()->can('update', $comment);
}
Поскольку все запросы формы расширяют базовый класс запросов Laravel, мы можем использовать метод user
для доступа к текущему аутентифицированному пользователю. Также обратите внимание на вызов метода route
в приведенном выше примере. Этот метод обеспечивает вам доступ к параметрам URI, определенным для вызываемого маршрута, таким как параметр {comment}
в приведенном ниже примере:
Route::post('/comment/{comment}');
Поэтому, если ваше приложение использует привязку модели к маршруту, ваш код можно сделать еще более кратким, обратившись к разрешенной модели в качестве свойства запроса:
return $this->user()->can('update', $this->comment);
Если метод authorize
возвращает false
, то будет автоматически возвращен HTTP-ответ с кодом состояния 403, и метод вашего контроллера не будет выполнен.
Если вы планируете обрабатывать логику авторизации для запроса в другой части вашего приложения, то вы можете просто вернуть true
из метода authorize
:
/**
* Определить, уполномочен ли пользователь выполнить этот запрос.
*
* @return bool
*/
public function authorize()
{
return true;
}
Вы можете объявить любые зависимости, которые вам нужны, в сигнатуре метода
authorize
. Они будут автоматически извлечены через контейнер служб Laravel.
Корректировка сообщений об ошибках
Вы можете изменить сообщения об ошибках, используемые в запросе формы, переопределив метод messages
. Этот метод должен возвращать массив пар атрибут / правило и соответствующие им сообщения об ошибках:
/**
* Получить сообщения об ошибках для определенных правил валидации.
*
* @return array
*/
public function messages()
{
return [
'title.required' => 'A title is required',
'body.required' => 'A message is required',
];
}
Корректировка атрибутов валидации
Многие сообщения об ошибках встроенных правил валидации Laravel содержат заполнитель :attribute
. Если вы хотите, чтобы заполнитель :attribute
вашего сообщения валидации был заменен другим именем атрибута, то вы можете указать собственные имена, переопределив метод attributes
. Этот метод должен возвращать массив пар атрибут / имя:
/**
* Получить пользовательские имена атрибутов для формирования ошибок валидатора.
*
* @return array
*/
public function attributes()
{
return [
'email' => 'email address',
];
}
Подготовка входящих данных для валидации
Если вам необходимо подготовить или обработать какие-либо данные из запроса перед применением правил валидации, то вы можете использовать метод prepareForValidation
:
use Illuminate\Support\Str;
/**
* Подготовить данные для валидации.
*
* @return void
*/
protected function prepareForValidation()
{
$this->merge([
'slug' => Str::slug($this->slug),
]);
}
Создание валидатора по требованию
Если вы не хотите использовать метод validate
запроса, то вы можете создать экземпляр валидатора вручную, используя фасад Validator
. Метод make
фасада генерирует новый экземпляр валидатора:
<?php
namespace App\Http\Controllers;
use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
class PostController extends Controller
{
/**
* Сохранить новую запись в блоге.
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$validator = Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
if ($validator->fails()) {
return redirect('post/create')
->withErrors($validator)
->withInput();
}
// Получить проверенные данные...
$validated = $validator->validated();
// Получить часть проверенных данных...
$validated = $validator->safe()->only(['name', 'email']);
$validated = $validator->safe()->except(['name', 'email']);
// Сохранить сообщение блога ...
}
}
Первым аргументом, переданным методу make
, являются проверяемые данные. Второй аргумент – это массив правил валидации, которые должны применяться к данным.
После определения того, что запрос не прошел валидацию с помощью метода fails
, вы можете использовать метод withErrors
для передачи сообщений об ошибках в сессию. При использовании этого метода переменная $errors
будет автоматически передана вашим шаблонам после перенаправления, что позволит вам легко отобразить их обратно пользователю. Метод withErrors
принимает экземпляр валидатора, экземпляр MessageBag
или обычный массив PHP.
Прекращение валидации после первой неуспешной проверки
Метод stopOnFirstFailure
проинформирует валидатор о том, что он должен прекратить валидацию всех атрибутов после возникновения первой ошибки валидации:
if ($validator->stopOnFirstFailure()->fails()) {
// ...
}
Автоматическое перенаправление
Если вы хотите создать экземпляр валидатора вручную, но по-прежнему воспользоваться преимуществами автоматического перенаправления, предлагаемого методом validate
HTTP-запроса, вы можете вызвать метод validate
созданного экземпляра валидатора. Пользователь будет автоматически перенаправлен или, в случае запроса XHR, будет возвращен ответ JSON, если валидация будет не успешной:
Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
])->validate();
Вы можете использовать метод validateWithBag
для сохранения сообщений об ошибках в именованной коллекции ошибок, если валидация будет не успешной:
Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
])->validateWithBag('post');
Именованные коллекции ошибок
Если у вас есть несколько форм на одной странице, то вы можете задать имя экземпляру MessageBag
, содержащий ошибки валидации, что позволит вам получать сообщения об ошибках для конкретной формы. Чтобы добиться этого, передайте имя в качестве второго аргумента в метод withErrors
:
return redirect('register')->withErrors($validator, 'login');
Затем, вы можете получить доступ к именованному экземпляру MessageBag
из переменной $errors
:
{{ $errors->login->first('email') }}
Корректировка сообщений об ошибках
При необходимости вы можете предоставить собственные сообщения об ошибках, которые должен использовать экземпляр валидатора вместо сообщений об ошибках по умолчанию, предоставляемых Laravel. Есть несколько способов указать собственные сообщения. Во-первых, вы можете передать собственные сообщения в качестве третьего аргумента методу Validator::make
:
$validator = Validator::make($input, $rules, $messages = [
'required' => 'The :attribute field is required.',
]);
В этом примере заполнитель :attribute
будет заменен фактическим именем проверяемого поля. Вы также можете использовать другие заполнители в сообщениях валидатора. Например:
$messages = [
'same' => 'The :attribute and :other must match.',
'size' => 'The :attribute must be exactly :size.',
'between' => 'The :attribute value :input is not between :min - :max.',
'in' => 'The :attribute must be one of the following types: :values',
];
Указание пользовательского сообщения для конкретного атрибута
По желанию можно указать собственное сообщение об ошибке только для определенного атрибута. Вы можете сделать это, используя «точечную нотацию». Сначала укажите имя атрибута, а затем правило:
$messages = [
'email.required' => 'We need to know your email address!',
];
Указание пользовательских имен для атрибутов
Многие сообщения об ошибках встроенных правил валидации Laravel содержат заполнитель :attribute
, который заменяется именем проверяемого поля или атрибута. Чтобы указать собственные значения, используемые для замены этих заполнителей для конкретных полей, вы можете передать массив ваших атрибутов в качестве четвертого аргумента методу Validator::make
:
$validator = Validator::make($input, $rules, $messages, [
'email' => 'email address',
]);
Хук валидатора After
Вы также можете определить замыкания, которые будут запускаться после завершения валидации. Это позволяет легко выполнять дальнейшую валидацию и даже добавлять сообщения об ошибках в коллекцию сообщений. Вызовите метод after
на экземпляре валидатора:
$validator = Validator::make(...);
$validator->after(function ($validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add(
'field', 'Something is wrong with this field!'
);
}
});
if ($validator->fails()) {
//
}
Работа с проверенными данными
После проверки данных входящего запроса с помощью запроса формы или вручную созданного экземпляра валидатора вы можете получить данные входящего запроса, которые действительно прошли проверку. Этого можно добиться несколькими способами. Во-первых, вы можете вызвать метод validated
в запросе формы или экземпляре валидатора. Этот метод возвращает массив данных, которые были проверены:
$validated = $request->validated();
$validated = $validator->validated();
В качестве альтернативы вы можете вызвать метод safe
в запросе формы или экземпляре валидатора. Этот метод возвращает экземпляр Illuminate\Support\ValidatedInput
. Этот объект предоставляет методы only
, except
, и all
для получения подмножества проверенных данных или всего массива проверенных данных:
$validated = $request->safe()->only(['name', 'email']);
$validated = $request->safe()->except(['name', 'email']);
$validated = $request->safe()->all();
Кроме того, экземпляр Illuminate\Support\ValidatedInput
может быть проитерирован и доступен как массив:
// Validated data may be iterated...
foreach ($request->safe() as $key => $value) {
//
}
// Validated data may be accessed as an array...
$validated = $request->safe();
$email = $validated['email'];
Если вы хотите добавить дополнительные поля к проверенным данным, вы можете вызвать метод merge
:
$validated = $request->safe()->merge(['name' => 'Taylor Otwell']);
Если вы хотите получить проверенные данные в виде экземпляра collection вы можете вызвать метод collect
:
$collection = $request->safe()->collect();
Работа с сообщениями об ошибках
После вызова метода errors
экземпляр Validator
, вы получите экземпляр Illuminate\Support\MessageBag
, который имеет множество удобных методов для работы с сообщениями об ошибках. Переменная $errors
, которая автоматически становится доступной для всех шаблонов, также является экземпляром класса MessageBag
.
Получение первого сообщения об ошибке для поля
Чтобы получить первое сообщение об ошибке для указанного поля, используйте метод first
:
$errors = $validator->errors();
echo $errors->first('email');
Получение всех сообщений об ошибках для поля
Если вам нужно получить массив всех сообщений для указанного поля, используйте метод get
:
foreach ($errors->get('email') as $message) {
//
}
Если вы проверяете массив полей формы, то вы можете получить все сообщения для каждого из элементов массива, используя символ *
:
foreach ($errors->get('attachments.*') as $message) {
//
}
Получение всех сообщений об ошибках для всех полей
Чтобы получить массив всех сообщений для всех полей, используйте метод all
:
foreach ($errors->all() as $message) {
//
}
Определение наличия сообщений для поля
Метод has
используется для определения наличия сообщений об ошибках для указанного поля:
if ($errors->has('email')) {
//
}
Указание пользовательских сообщений в языковых файлах
Каждое встроенное правило валидации Laravel содержит сообщение об ошибке, которое находится в файле resources/lang/en/validation.php
вашего приложения. В этом файле вы найдете запись о переводе для каждого правила валидации. Вы можете изменять или модифицировать эти сообщения в зависимости от потребностей вашего приложения.
Кроме того, вы можете скопировать этот файл в каталог перевода другого языка, чтобы перевести сообщения на язык вашего приложения. Чтобы узнать больше о локализации Laravel, ознакомьтесь с полной документацией по локализации.
Указание пользовательского сообщения для конкретного атрибута
Вы можете изменить сообщения об ошибках, используемые для указанных комбинаций атрибутов и правил в языковых файлах валидации вашего приложения. Для этого добавьте собственные сообщения в массив custom
языкового файла resources/lang/xx/validation.php
вашего приложения:
'custom' => [
'email' => [
'required' => 'We need to know your email address!',
'max' => 'Your email address is too long!'
],
],
Указание атрибутов в языковых файлах
Многие сообщения об ошибках встроенных правил валидации Laravel содержат заполнитель :attribute
, который заменяется именем проверяемого поля или атрибута. Если вы хотите, чтобы часть :attribute
вашего сообщения валидации была заменена собственным значением, то вы можете указать имя настраиваемого атрибута в массиве attributes
вашего языкового файла resources/lang/xx/validation.php
:
'attributes' => [
'email' => 'email address',
],
Указание пользовательских имен для атрибутов в языковых файлах
Некоторые сообщения об ошибках встроенных правил валидации Laravel содержат заполнитель :value
, который заменяется текущим значением атрибута запроса. Однако, иногда вам может понадобиться заменить часть :value
вашего сообщения валидации на собственное значение. Например, рассмотрим следующее правило, которое указывает, что номер кредитной карты требуется обязательно, если для параметра payment_type
установлено значение cc
:
Validator::make($request->all(), [
'credit_card_number' => 'required_if:payment_type,cc'
]);
Если это правило валидации не будет пройдено, то будет выдано следующее сообщение об ошибке:
The credit card number field is required when payment type is cc.
Вместо того чтобы отображать cc
в качестве значения типа платежа, вы можете указать более удобное для пользователя представление значения в вашем языковом файле resources/lang/xx/validation.php
, определив массив values
:
'values' => [
'payment_type' => [
'cc' => 'credit card'
],
],
После определения этого значения правило валидации выдаст следующее сообщение об ошибке:
The credit card number field is required when payment type is credit card.
Доступные правила валидации
Ниже приведен список всех доступных правил валидации и их функций:
- Accepted
- Accepted If
- Active URL
- After (Date)
- After Or Equal (Date)
- Alpha
- Alpha Dash
- Alpha Numeric
- Array
- Bail
- Before (Date)
- Before Or Equal (Date)
- Between
- Boolean
- Confirmed
- Current Password
- Date
- Date Equals
- Date Format
- Declined
- Declined If
- Different
- Digits
- Digits Between
- Dimensions (Image Files)
- Distinct
- Ends With
- Enum
- Exclude
- Exclude If
- Exclude Unless
- Exclude Without
- Exists (Database)
- File
- Filled
- Greater Than
- Greater Than Or Equal
- Image (File)
- In
- In Array
- Integer
- IP Address
- MAC Address
- JSON
- Less Than
- Less Than Or Equal
- Max
- MIME Types
- MIME Type By File Extension
- Min
- Multiple Of
- Not In
- Not Regex
- Nullable
- Numeric
- Password
- Present
- Prohibited
- Prohibited If
- Prohibited Unless
- Prohibits
- Regex (regular expression)
- Required
- Required If
- Required Unless
- Required With
- Required With All
- Required Without
- Required Without All
- Same
- Size
- Sometimes
- Sometimes
- Starts With
- String
- Timezone
- Unique (Database)
- URL
- UUID
accepted
Проверяемое поле должно иметь значение "yes"
, "on"
, 1
, или true
. Применяется для валидации принятия «Условий использования» или аналогичных полей.
accepted_if:anotherfield,value,…
Проверяемое поле должно иметь значение "yes"
, "on"
, 1
, или true
, если другое проверяемое поле равно указанному значению. Это полезно для валидации принятия «Условий использования» или аналогичных полей.
active_url
Проверяемое поле должно иметь допустимую запись A или AAAA в соответствии с функцией dns_get_record
PHP. Имя хоста указанного URL извлекается с помощью PHP-функции parse_url
перед передачей в dns_get_record
.
after:date
Проверяемое поле должно иметь значение после указанной даты. Даты будут переданы в функцию strtotime
PHP для преобразования в действительный экземпляр DateTime
:
'start_date' => 'required|date|after:tomorrow'
Вместо передачи строки даты, которая будет проанализирована с помощью strtotime
, вы можете указать другое поле для сравнения с датой:
'finish_date' => 'required|date|after:start_date'
after_or_equal:date
Проверяемое поле должно иметь значение после указанной даты или равное ей. Для получения дополнительной информации см. правило after.
alpha
Проверяемое поле должно состоять полностью из букв.
alpha_dash
Проверяемое поле может содержать буквенно-цифровые символы, а также дефисы и подчеркивания.
alpha_num
Проверяемое поле должно состоять полностью из буквенно-цифровых символов.
array
Проверяемое поле должно быть массивом PHP.
Когда для правила array
предоставляются дополнительные значения, каждый ключ во входном массиве должен присутствовать в списке значений, предоставленных правилу. В следующем примере ключ admin
во входном массиве недействителен, поскольку он не содержится в списке значений, предоставленных правилу array
:
use Illuminate\Support\Facades\Validator;
$input = [
'user' => [
'name' => 'Taylor Otwell',
'username' => 'taylorotwell',
'admin' => true,
],
];
Validator::make($input, [
'user' => 'array:username,locale',
]);
В общем, вы всегда должны указывать ключи массива, которые могут присутствовать в вашем массиве. В противном случае методы валидатора validate
и validated
вернут все проверенные данные, включая массив и все его ключи, даже если эти ключи не были проверены другими правилами проверки вложенных массивов.
Если вы хотите, вы можете указать валидатору Laravel никогда не включать непроверенные ключи массива в «проверенные» данные, которые он возвращает, даже если вы используете правило array
без указания списка разрешенных ключей. Для этого вы можете вызвать метод валидатора excludeUnvalidatedArrayKeys
в методе boot
класса AppServiceProvider
вашего приложения. После этого валидатор будет включать ключи массива в «проверенные» данные, которые он возвращает, только если эти ключи были специально проверены с помощью правил вложенных массивов:
use Illuminate\Support\Facades\Validator;
/**
* Register any application services.
*
* @return void
*/
public function boot()
{
Validator::excludeUnvalidatedArrayKeys();
}
bail
Остановить дальнейшее применение правил валидации атрибута после первой неуспешной проверки.
В отличие от правила bail
, которое прекращает дальнейшую валидацию только конкретного поля, метод stopOnFirstFailure
сообщит валидатору, что он должен прекратить дальнейшую валидацию всех атрибутов при возникновении первой ошибке:
if ($validator->stopOnFirstFailure()->fails()) {
// ...
}
before:date
Проверяемое поле должно быть значением, предшествующим указанной дате. Даты будут переданы в функцию PHP strtotime
для преобразования в действительный экземпляр DateTime
. Кроме того, как и в правиле after
, имя другого проверяемого поля может быть указано в качестве значения date
.
before_or_equal:date
Проверяемое поле должно иметь значение, предшествующее указанной дате или равное ей. Даты будут переданы в функцию PHP strtotime
для преобразования в действительный экземпляр DateTime
. Кроме того, как и в правиле after
, имя другого проверяемого поля может быть указано в качестве значения date
.
between:min,max
Проверяемое поле должно иметь размер между указанными min и max. Строки, числа, массивы и файлы оцениваются так же, как и в правиле size
.
boolean
Проверяемое поле должно иметь возможность преобразования в логическое значение. Допустимые значения: true
, false
, 1
, 0
, "1"
, и "0"
.
confirmed
Проверяемое поле должно иметь совпадающее поле {field}_confirmation
. Например, если проверяемое поле – password
, то поле password_confirmation
также должно присутствовать во входящих данных.
current_password
Проверяемое поле должно соответствовать паролю аутентифицированного пользователя. Вы можете указать охранника аутентификации используя первый параметр правила:
'password' => 'current_password:api'
date
Проверяемое поле должно быть действительной, не относительной датой в соответствии с функцией strtotime
PHP.
date_equals:date
Проверяемое поле должно быть равно указанной дате. Даты будут переданы в функцию strtotime
PHP для преобразования в действительный экземпляр DateTime
.
date_format:format
Проверяемое поле должно соответствовать переданному format. При валидации поля следует использовать либо date
, либо date_format
, а не то и другое вместе. Это правило валидации поддерживает все форматы, поддерживаемые классом DateTime
PHP.
declined
Проверяемое поле должно иметь значение"no"
, "off"
, 0
, или false
.
declined_if:anotherfield,value,…
Проверяемое поле должно иметь значение"no"
, "off"
, 0
, or false
, если другое проверяемое поле равно указанному значению.
different:field
Проверяемое поле должно иметь значение, отличное от field.
digits:value
Проверяемое поле должно быть числовым и иметь точную длину value.
digits_between:min,max
Проверяемое поле должно быть числовым и иметь длину между переданными min и max.
dimensions
Проверяемый файл должен быть изображением, отвечающим ограничениям размеров, указанным в параметрах правила:
'avatar' => 'dimensions:min_width=100,min_height=200'
Доступные ограничения: min_width, max_width, min_height, max_height, width, height, ratio.
Ограничение ratio должно быть представлено как ширина, разделенная на высоту. Это может быть указано дробью вроде 3/2
или числом с плавающей запятой, например 1.5
:
'avatar' => 'dimensions:ratio=3/2'
Поскольку это правило требует нескольких аргументов, вы можете использовать метод Rule::dimensions
для гибкости составления правила:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'avatar' => [
'required',
Rule::dimensions()->maxWidth(1000)->maxHeight(500)->ratio(3 / 2),
],
]);
distinct
При валидации массивов проверяемое поле не должно иметь повторяющихся значений:
'foo.*.id' => 'distinct'
По умолчанию правило distinct
использует гибкое сравнение переменных. Чтобы использовать жесткое сравнение, вы можете добавить параметр strict
в определение правила валидации:
'foo.*.id' => 'distinct:strict'
Вы можете добавить ignore_case
к аргументам правила валидации, чтобы правило игнорировало различия в использовании регистра букв:
'foo.*.id' => 'distinct:ignore_case'
Проверяемое поле должно быть отформатировано как адрес электронной почты. Это правило валидации использует пакет egulias/email-validator
для проверки адреса электронной почты. По умолчанию применяется валидатор RFCValidation
, но вы также можете применить другие стили валидации:
'email' => 'email:rfc,dns'
В приведенном выше примере будут применяться проверки RFCValidation
и DNSCheckValidation
. Вот полный список стилей проверки, которые вы можете применить:
-
rfc
:RFCValidation
-
strict
:NoRFCWarningsValidation
-
dns
:DNSCheckValidation
-
spoof
:SpoofCheckValidation
-
filter
:FilterEmailValidation
Валидатор filter
, который использует функцию filter_var
PHP, поставляется с Laravel и применялся по умолчанию до Laravel версии 5.8.
Валидаторы
dns
иspoof
требуют расширенияintl
PHP.
ends_with:foo,bar,…
Проверяемое поле должно заканчиваться одним из указанных значений.
enum
Правило Enum
это правило на основе класса, которое проверяет, содержит ли проверяемое поле допустимое значение перечисления. Правило Enum
принимает имя перечисления как единственный аргумент конструктора:
use App\Enums\ServerStatus;
use Illuminate\Validation\Rules\Enum;
$request->validate([
'status' => [new Enum(ServerStatus::class)],
]);
Перечисления доступны только в PHP 8.1+.
exclude
Проверяемое поле будет исключено из данных запроса, возвращаемых методамиvalidate
и validated
.
exclude_if:anotherfield,value
Проверяемое поле будет исключено из данных запроса, возвращаемых методами validate
и validated
, если поле anotherfield равно value.
exclude_unless:anotherfield,value
Проверяемое поле будет исключено из данных запроса, возвращаемых методами validate
и validated
, если поле anotherfield не равно value. При value равном null
(exclude_unless: name, null
) проверяемое поле будет исключено, если поле сравнения либо не равно null
, либо отсутствует в данных запроса.
exclude_without:anotherfield
Проверяемое поле будет исключено из данных запроса, возвращаемых методами validate
и validated
если поле anotherfield отсутствует.
exists:table,column
Проверяемое поле должно существовать в указанной таблице базы данных.
Основы использования правила Exists
'state' => 'exists:states'
Если параметр column
не указан, будет использоваться имя поля. Таким образом, в этом случае правило будет проверять, что таблица базы данных states
содержит запись со значением столбца state
, равным значению атрибута запроса state
.
Указание пользовательского имени столбца
Вы можете явно указать имя столбца базы данных, которое должно использоваться правилом валидации, поместив его после имени таблицы базы данных:
'state' => 'exists:states,abbreviation'
Иногда требуется указать конкретное соединение с базой данных, которое будет использоваться для запроса exists
. Вы можете сделать это, добавив имя подключения к имени таблицы:
'email' => 'exists:connection.staff,email'
Вместо того чтобы указывать имя таблицы напрямую, вы можете указать модель Eloquent, которая должна использоваться для определения имени таблицы:
'user_id' => 'exists:App\Models\User,id'
Если вы хотите использовать свой запрос, выполняемый правилом валидации, то вы можете использовать класс Rule
для гибкости определения правила. В этом примере мы также укажем правила валидации в виде массива вместо использования символа |
для их разделения:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'email' => [
'required',
Rule::exists('staff')->where(function ($query) {
return $query->where('account_id', 1);
}),
],
]);
file
Проверяемое поле должно быть успешно загруженным на сервер файлом.
filled
Проверяемое поле не должно быть пустым, если оно присутствует.
gt:field
Проверяемое поле должно быть больше указанного field. Два поля должны быть одного типа. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и в правиле size
.
gte:field
Проверяемое поле должно быть больше или равно указанному field. Два поля должны быть одного типа. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и в правиле size
.
image
Проверяемый файл должен быть изображением (jpg, jpeg, png, bmp, gif, svg или webp).
in:foo,bar,…
Проверяемое поле должно быть включено в указанный список значений. Поскольку это правило часто требует, чтобы вы «объединяли» массив, то метод Rule::in
можно использовать для гибкого построения правила:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'zones' => [
'required',
Rule::in(['first-zone', 'second-zone']),
],
]);
Когда правилоin
комбинируется с правилом array
каждое значение во входном массиве должно присутствовать в списке значений, предоставленных правилу in
. В следующем примере код аэропорта LAS
во входном массиве недействителен, так как он не содержится в списке аэропортов, предоставленном правилу in
:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
$input = [
'airports' => ['NYC', 'LAS'],
];
Validator::make($input, [
'airports' => [
'required',
'array',
Rule::in(['NYC', 'LIT']),
],
]);
in_array:anotherfield.*
Проверяемое поле должно существовать в значениях anotherfield.
integer
Проверяемое поле должно быть целым числом.
Это правило валидации не проверяет, что значение поля относится к типу переменной
integer
, а только что значение поля относится к типу, принятому правиломFILTER_VALIDATE_INT
PHP. Если вам нужно проверить значение поля в качестве числа, используйте это правило в сочетании с правилом валидацииnumeric
.
ip
Проверяемое поле должно быть IP-адресом.
ipv4
Проверяемое поле должно быть адресом IPv4.
ipv6
Проверяемое поле должно быть адресом IPv6.
mac_address
Проверяемое поле должно быть MAC-адресом.
json
Проверяемое поле должно быть допустимой строкой JSON.
lt:field
Проверяемое поле должно быть меньше переданного field. Два поля должны быть одного типа. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и в правиле size
.
lte:field
Проверяемое поле должно быть меньше или равно переданному field. Два поля должны быть одного типа. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и в правиле size
.
max:value
Проверяемое поле должно быть меньше или равно максимальному value. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и в правиле size
.
mimetypes:text/plain,…
Проверяемый файл должен соответствовать одному из указанных MIME-типов:
'video' => 'mimetypes:video/avi,video/mpeg,video/quicktime'
Чтобы определить MIME-тип загруженного файла, содержимое файла будет прочитано, и фреймворк попытается угадать MIME-тип, который может отличаться от типа, предоставленного клиентом.
mimes:foo,bar,…
Проверяемый файл должен иметь MIME-тип, соответствующий одному из перечисленных расширений.
Основы использования правила MIME
'photo' => 'mimes:jpg,bmp,png'
Несмотря на то, что вам нужно только указать расширения, это правило фактически проверяет MIME-тип файла, читая содержимое файла и угадывая его MIME-тип. Полный список типов MIME и соответствующих им расширений можно найти по следующему адресу:
https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
min:value
Проверяемое поле должно иметь минимальное значение value. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и в правиле size
.
multiple_of:value
Проверяемое поле должно быть кратным value.
Расширение PHP
bcmath
требуется для использования правилаmultiple_of
.
not_in:foo,bar,…
Проверяемое поле не должно быть включено в переданный список значений. Метод Rule::notIn
используется для гибкого построения правила:
use Illuminate\Validation\Rule;
Validator::make($data, [
'toppings' => [
'required',
Rule::notIn(['sprinkles', 'cherries']),
],
]);
not_regex:pattern
Проверяемое поле не должно соответствовать переданному регулярному выражению.
Под капотом это правило использует функцию preg_match
, поэтому указанный шаблон должен подчиняться требованиям, предъявляемым к ней, а также включать допустимые разделители. Например: 'email' => 'not_regex:/^.+$/i'
.
При использовании шаблонов
regex
/not_regex
может потребоваться указать ваши правила валидации с использованием массива вместо использования разделителей|
, особенно если регулярное выражение содержит символ|
.
nullable
Проверяемое поле может быть null
.
numeric
Проверяемое поле должно быть числовым.
password
Проверяемое поле должно соответствовать паролю аутентифицированного пользователя.
Это правило было переименовано в
current_password
с намерением удалить его в Laravel 9. Пожалуйста, используйте вместо него правило Current Password.
present
Проверяемое поле должно присутствовать во входных данных, но может быть пустым.
prohibited
Проверяемое поле должно быть пустым или отсутствовать.
prohibited_if:anotherfield,value,…
Проверяемое поле должно быть пустым или отсутствовать, если поле anotherfield равно любому value.
prohibited_unless:anotherfield,value,…
Проверяемое поле должно быть пустым или отсутствовать, если поле anotherfield не равно какому-либо value.
prohibits:anotherfield,…
Если проверяемое поле присутствует, никакие поля в anotherfield не могут присутствовать, даже если они пустые.
regex:pattern
Проверяемое поле должно соответствовать переданному регулярному выражению.
Под капотом это правило использует функцию preg_match
, поэтому указанный шаблон должен подчиняться требованиям, предъявляемым к ней, а также включать допустимые разделители. Например: 'email' => 'regex:/^.+@.+$/i'
.
При использовании шаблонов
regex
/not_regex
может потребоваться указать ваши правила валидации с использованием массива вместо использования разделителей|
, особенно если регулярное выражение содержит символ|
.
required
Проверяемое поле должно присутствовать во входных данных и не быть пустым. Поле считается «пустым», если выполняется одно из следующих условий:
- Значение поля равно
null
. - Значение поля – пустая строка.
- Значение поля представляет собой пустой массив или пустой объект, реализующий интерфейс
Countable
. - Значение поля – загружаемый файл, но без пути.
required_if:anotherfield,value,…
Проверяемое поле должно присутствовать и не быть пустым, если поле anotherfield равно любому value.
Если вы хотите создать более сложное условие для правила required_if
, вы можете использовать метод Rule::requiredIf
. Этот метод принимает логическое значение или замыкание. При выполнении замыкания оно должно возвращать true
или false
, чтобы указать, обязательно ли проверяемое поле:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($request->all(), [
'role_id' => Rule::requiredIf($request->user()->is_admin),
]);
Validator::make($request->all(), [
'role_id' => Rule::requiredIf(function () use ($request) {
return $request->user()->is_admin;
}),
]);
required_unless:anotherfield,value,…
Проверяемое поле должно присутствовать и не быть пустым, если поле anotherfield не равно какому-либо value. Это также означает, что в данных запроса должно присутствовать anotherfield, если value не имеет значения null
. Если value равно null
(required_unless: name, null
), проверяемое поле будет обязательным, если поле сравнения не равно null
или поле сравнения отсутствует в данных запроса.
required_with:foo,bar,…
Проверяемое поле должно присутствовать и не быть пустым, только если любое из других указанных полей присутствует и не является пустым.
required_with_all:foo,bar,…
Проверяемое поле должно присутствовать и не быть пустым, только если все другие указанные поля присутствуют и не являются пустыми.
required_without:foo,bar,…
Проверяемое поле должно присутствовать и не быть пустым, только когда любое из других указанных полей является пустым или отсутствует.
required_without_all:foo,bar,…
Проверяемое поле должно присутствовать и не быть пустым, только когда все другие указанные поля являются пустыми или отсутствуют.
same:field
Переданное field должно соответствовать проверяемому полю.
size:value
Проверяемое поле должно иметь размер, соответствующий переданному value. Для строковых данных value соответствует количеству символов. Для числовых данных value соответствует переданному целочисленному значению (атрибут также должен иметь правило numeric
или integer
). Для массива size соответствует count
массива. Для файлов size соответствует размеру файла в килобайтах. Давайте посмотрим на несколько примеров:
// Проверяем, что строка содержит ровно 12 символов ...
'title' => 'size:12';
// Проверяем, что передано целое число, равно 10 ...
'seats' => 'integer|size:10';
// Проверяем, что в массиве ровно 5 элементов ...
'tags' => 'array|size:5';
// Проверяем, что размер загружаемого файла составляет ровно 512 килобайт ...
'image' => 'file|size:512';
starts_with:foo,bar,…
Проверяемое поле должно начинаться с одного из указанных значений.
string
Проверяемое поле должно быть строкой. Если вы хотите, чтобы поле также могло быть null
, вы должны назначить этому полю правило nullable
.
timezone
Проверяемое поле должно быть допустимым идентификатором часового пояса в соответствии с функцией timezone_identifiers_list
PHP.
unique:table,column
Проверяемое поле не должно существовать в указанной таблице базы данных.
Указание пользовательского имени таблицы / имени столбца:
Вместо того чтобы указывать имя таблицы напрямую, вы можете указать модель Eloquent, которая должна использоваться для определения имени таблицы:
'email' => 'unique:App\Models\User,email_address'
Параметр column
используется для указания соответствующего столбца базы данных поля. Если опция column
не указана, будет использоваться имя проверяемого поля.
'email' => 'unique:users,email_address'
Указание пользовательского соединения базы данных
Иногда требуется указать конкретное соединение для запросов к базе данных, выполняемых валидатором. Для этого вы можете добавить имя подключения к имени таблицы:
'email' => 'unique:connection.users,email_address'
Принудительное игнорирование правилом Unique конкретного идентификатора:
Иногда вы можете проигнорировать конкретный идентификатор во время валидации unique
. Например, рассмотрим страницу «Обновления профиля», которая включает имя пользователя, адрес электронной почты и местоположение. Вероятно, вы захотите убедиться, что адрес электронной почты уникален. Однако, если пользователь изменяет только поле имени, а не поле электронной почты, то вы не захотите, чтобы выдавалась ошибка валидация, поскольку пользователь уже является владельцем рассматриваемого адреса электронной почты.
Чтобы указать валидатору игнорировать идентификатор пользователя, мы воспользуемся классом Rule
для гибкого определения правила. В этом примере мы также укажем правила валидации в виде массива вместо использования символа |
для их разделения:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'email' => [
'required',
Rule::unique('users')->ignore($user->id),
],
]);
Вы никогда не должны передавать какое-либо введенное пользователем значение из запроса в метод
ignore
. Вместо этого вы должны передавать только сгенерированный системой уникальный идентификатор, такой как автоинкрементный идентификатор или UUID экземпляра модели Eloquent. В противном случае ваше приложение будет уязвимо для атаки с использованием SQL-инъекции.
Вместо того чтобы передавать значение ключа модели методу ignore
, вы также можете передать весь экземпляр модели. Laravel автоматически извлечет ключ из модели:
Rule::unique('users')->ignore($user)
Если ваша таблица использует имя столбца с первичным ключом, отличное от id
, то вы можете указать имя столбца при вызове метода ignore
:
Rule::unique('users')->ignore($user->id, 'user_id')
По умолчанию правило unique
проверяет уникальность столбца, совпадающего с именем проверяемого атрибута. Однако вы можете передать другое имя столбца в качестве второго аргумента метода unique
:
Rule::unique('users', 'email_address')->ignore($user->id),
Добавление дополнительных выражений Where:
Вы можете указать дополнительные условия запроса, изменив запрос с помощью метода where
. Например, давайте добавим условие запроса, ограничивающее область запроса только поиском записями, у которых значение столбца account_id
равно 1
:
'email' => Rule::unique('users')->where(function ($query) {
return $query->where('account_id', 1);
})
url
Проверяемое поле должно быть действительным URL.
uuid
Проверяемое поле должно быть действительным универсальным уникальным идентификатором (UUID) RFC 4122 (версии 1, 3, 4 или 5).
Условное добавление правил
Пропуск валидации при определенных значениях полей
По желанию можно не проверять конкретное поле, если другое поле имеет указанное значение. Вы можете сделать это, используя правило валидации exclude_if
. В этом примере поля appointment_date
и doctor_name
не будут проверяться, если поле has_appointment
имеет значение false
:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($data, [
'has_appointment' => 'required|boolean',
'appointment_date' => 'exclude_if:has_appointment,false|required|date',
'doctor_name' => 'exclude_if:has_appointment,false|required|string',
]);
В качестве альтернативы вы можете использовать правило exclude_unless
, чтобы не проверять конкретное поле, если другое поле не имеет указанного значения:
$validator = Validator::make($data, [
'has_appointment' => 'required|boolean',
'appointment_date' => 'exclude_unless:has_appointment,true|required|date',
'doctor_name' => 'exclude_unless:has_appointment,true|required|string',
]);
Валидация при условии наличия
По желанию можно выполнить валидацию поля, только если это поле присутствует в проверяемых данных. Чтобы этого добиться, добавьте правило sometimes
в свой список правил:
$v = Validator::make($data, [
'email' => 'sometimes|required|email',
]);
В приведенном выше примере поле email
будет проверено, только если оно присутствует в массиве $request->all()
.
Если вы пытаетесь проверить поле, которое всегда должно присутствовать, но может быть пустым, ознакомьтесь с этим примечанием о необязательных полях.
Комплексная условная проверка
Иногда вы можете добавить правила валидации, основанные на более сложной условной логике. Например, вы можете потребовать обязательного присутствия переданного поля только в том случае, если другое поле имеет значение больше 100. Или вам может потребоваться, чтобы два поля имели указанное значение только при наличии другого поля. Добавление этих правил валидации не должно вызывать затруднений. Сначала создайте экземпляр Validator
со своими статическими правилами, которые будут неизменными:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($request->all(), [
'email' => 'required|email',
'games' => 'required|numeric',
]);
Предположим, что наше веб-приложение предназначено для коллекционеров игр. Если коллекционер игр регистрируется в нашем приложении и у него есть более 100 игр, мы хотим, чтобы он объяснил, почему у него так много игр. Например, возможно, они владеют магазином по перепродаже игр или, может быть, им просто нравится коллекционировать игры. Чтобы условно добавить это требование, мы можем использовать метод sometimes
экземпляра Validator
:
$validator->sometimes('reason', 'required|max:500', function ($input) {
return $input->games >= 100;
});
Первый аргумент, переданный методу sometimes
– это имя поля, которое мы условно проверяем. Второй аргумент – это список правил, которые мы хотим добавить. Если замыкание, переданное в качестве третьего аргумента, возвращает true
, то правила будут добавлены. Этот метод упрощает создание сложных условных проверок. Вы даже можете добавить условные проверки сразу для нескольких полей:
$validator->sometimes(['reason', 'cost'], 'required', function ($input) {
return $input->games >= 100;
});
Параметр
$input
, переданный вашему замыканию, будет экземпляромIlluminate\Support\Fluent
и может использоваться при валидации для доступа к вашим входящим данным и файлам запроса.
Комплексная условная проверка массива
Иногда вам может потребоваться проверить поле на основе другого поля в том же вложенном массиве, индекс которого вам неизвестен. В этих ситуациях вы можете позволить вашему замыканию получить второй аргумент, который будет текущим отдельным элементом в проверяемом массиве:
$input = [
'channels' => [
[
'type' => 'email',
'address' => 'abigail@example.com',
],
[
'type' => 'url',
'address' => 'https://example.com',
],
],
];
$validator->sometimes('channels.*.address', 'email', function ($input, $item) {
return $item->type === 'email';
});
$validator->sometimes('channels.*.address', 'url', function ($input, $item) {
return $item->type !== 'email';
});
Подобно переданному в замыкание параметру $input
, параметр $item
является экземпляром Illuminate\Support\Fluent
, когда значение атрибута является массивом; в противном случае это строка.
Валидация массивов
Правило array
, как это уже обсуждалось выше, принимает список разрешенных ключей массива. Если в массиве присутствуют какие-либо дополнительные ключи, проверка не удастся:
use Illuminate\Support\Facades\Validator;
$input = [
'user' => [
'name' => 'Taylor Otwell',
'username' => 'taylorotwell',
'admin' => true,
],
];
Validator::make($input, [
'user' => 'array:username,locale',
]);
В общем, вы всегда должны указывать ключи массива, которые могут присутствовать в вашем массиве. В противном случае методы валидатора validate
и validated
вернут все проверенные данные, включая массив и все его ключи, даже если эти ключи не были проверены другими правилами проверки вложенных массивов.
Исключение непроверенных ключей массива
Если вы хотите, вы можете указать валидатору Laravel никогда не включать непроверенные ключи массива в «проверенные» данные, которые он возвращает, даже если вы используете правило array
без указания списка разрешенных ключей. Для этого вы можете вызвать метод валидатора excludeUnvalidatedArrayKeys
в методе boot
класса AppServiceProvider
вашего приложения. После этого валидатор будет включать ключи массива в «проверенные» данные, которые он возвращает, только если эти ключи были специально проверены с помощью правил вложенных массивов:
use Illuminate\Support\Facades\Validator;
/**
* Register any application services.
*
* @return void
*/
public function boot()
{
Validator::excludeUnvalidatedArrayKeys();
}
Проверка входных данных вложенного массива
Проверка полей ввода формы на основе массива не должна быть проблемой. Вы можете использовать «точечную нотацию» для валидации атрибутов в массиве. Например, если входящий HTTP-запрос содержит поле photos[profile]
, вы можете проверить его следующим образом:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($request->all(), [
'photos.profile' => 'required|image',
]);
Вы также можете проверить каждый элемент массива. Например, чтобы убедиться, что каждое электронное письмо в переданном поле ввода массива уникально, вы можете сделать следующее:
$validator = Validator::make($request->all(), [
'person.*.email' => 'email|unique:users',
'person.*.first_name' => 'required_with:person.*.last_name',
]);
Точно так же вы можете использовать символ *
при указании пользовательских сообщений в ваших языковых файлах, что упрощает использование одного сообщения валидации для полей на основе массива:
'custom' => [
'person.*.email' => [
'unique' => 'Each person must have a unique email address',
]
],
Валидация паролей
Чтобы гарантировать, что пароли имеют достаточный уровень сложности, вы можете использовать объект правила laravel Password
:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\Password;
$validator = Validator::make($request->all(), [
'password' => ['required', 'confirmed', Password::min(8)],
]);
Объект правила Password
позволяет вам легко настроить требования к сложности пароля для вашего приложения, например указать, что для паролей требуется хотя бы одна буква, цифра, символ или символы со смешанным регистром:
// Требуется не менее 8 символов ...
Password::min(8)
// Требуется хотя бы одна буква ...
Password::min(8)->letters()
// Требуется хотя бы одна заглавная и одна строчная буква...
Password::min(8)->mixedCase()
// Требовать хотя бы одна цифра...
Password::min(8)->numbers()
// Требуется хотя бы один символ...
Password::min(8)->symbols()
Кроме того, вы можете убедиться, что пароль не был скомпрометирован в результате утечки данных публичного пароля, используя метод uncompromised
:
Password::min(8)->uncompromised()
Объект правила Password
использует модель k-Anonymity, чтобы определить, не произошла ли утечка пароля через haveibeenpwned.com без ущерба для конфиденциальности или безопасности пользователя.
По умолчанию, если пароль появляется хотя бы один раз при утечке данных, он считается скомпрометированным. Вы можете настроить этот порог, используя первый аргумент метода uncompromised
:
// Убедитесь, что пароль появляется не реже 3 раз в одной и той же утечке данных....
Password::min(8)->uncompromised(3);
Конечно, вы можете связать все методы в приведенных выше примерах:
Password::min(8)
->letters()
->mixedCase()
->numbers()
->symbols()
->uncompromised()
Определение правил паролей по умолчанию
Возможно, вам будет удобно указать правила проверки паролей по умолчанию в одном месте вашего приложения. Вы можете легко сделать это, используя метод Password::defaults
, который принимает замыкание. Замыкание, данное методу defaults
, должно вернуть конфигурацию правила пароля по умолчанию. Чаще всего, правило defaults
следует вызывать в методе boot
одного из поставщиков услуг вашего приложения:
use Illuminate\Validation\Rules\Password;
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
Password::defaults(function () {
$rule = Password::min(8);
return $this->app->isProduction()
? $rule->mixedCase()->uncompromised()
: $rule;
});
}
Затем, когда вы хотите применить правила по умолчанию к конкретному паролю, проходящему проверку, вы можете вызвать метод defaults
без аргументов:
'password' => ['required', Password::defaults()],
Иногда вы можете захотеть добавить дополнительные правила проверки к правилам проверки пароля по умолчанию. Для этого вы можете использовать метод rules
:
use App\Rules\ZxcvbnRule;
Password::defaults(function () {
$rule = Password::min(8)->rules([new ZxcvbnRule]);
// ...
});
Пользовательские правила валидации
Использование класса Rule
Laravel предлагает множество полезных правил валидации; однако вы можете указать свои собственные. Один из методов регистрации собственных правил валидации – использование объектов правил. Чтобы сгенерировать новый объект правила, вы можете использовать команду make:rule
Artisan. Давайте воспользуемся этой командой, чтобы сгенерировать правило, которое проверяет, что строка состоит из прописных букв. Laravel поместит новый класс правила в каталог app/Rules
вашего приложения. Если этот каталог не существует в вашем приложении, то Laravel предварительно создаст его, когда вы выполните команду Artisan для создания своего правила:
php artisan make:rule Uppercase
Как только правило создано, мы готовы определить его поведение. Объект правила содержит два метода: passes
и message
. Метод passes
получает значение и имя атрибута и должен возвращать true
или false
в зависимости от того, является ли значение атрибута допустимым или нет. Метод message
должен возвращать сообщение об ошибке валидации, которое следует использовать, если проверка оказалась не успешной:
<?php
namespace App\Rules;
use Illuminate\Contracts\Validation\Rule;
class Uppercase implements Rule
{
/**
* Определить, пройдено ли правило валидации.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
public function passes($attribute, $value)
{
return strtoupper($value) === $value;
}
/**
* Получить сообщение об ошибке валидации.
*
* @return string
*/
public function message()
{
return 'The :attribute must be uppercase.';
}
}
Вы можете вызвать помощник trans
в методе message
, если хотите вернуть сообщение об ошибке из ваших файлов перевода:
/**
* Получить сообщение об ошибке валидации.
*
* @return string
*/
public function message()
{
return trans('validation.uppercase');
}
После определения правила вы можете отправить его валидатору, передав экземпляр объекта правила с другими вашими правилами валидации:
use App\Rules\Uppercase;
$request->validate([
'name' => ['required', 'string', new Uppercase],
]);
Доступ к дополнительным данным
Если вашему пользовательскому классу правил проверки требуется доступ ко всем другим данным, проходящим проверку, ваш класс правил может реализовать интерфейс Illuminate\Contracts\Validation\DataAwareRule
. Этот интерфейс требует, чтобы ваш класс определил метод setData
. Этот метод будет автоматически вызван Laravel (до того, как начнется проверка) со всеми проверяемыми данными:
<?php
namespace App\Rules;
use Illuminate\Contracts\Validation\Rule;
use Illuminate\Contracts\Validation\DataAwareRule;
class Uppercase implements Rule, DataAwareRule
{
/**
* All of the data under validation.
*
* @var array
*/
protected $data = [];
// ...
/**
* Set the data under validation.
*
* @param array $data
* @return $this
*/
public function setData($data)
{
$this->data = $data;
return $this;
}
}
Или, если ваше правило проверки требует доступа к экземпляру валидатора, выполняющему проверку, вы можете реализовать интерфейс ValidatorAwareRule
:
<?php
namespace App\Rules;
use Illuminate\Contracts\Validation\Rule;
use Illuminate\Contracts\Validation\ValidatorAwareRule;
class Uppercase implements Rule, ValidatorAwareRule
{
/**
* The validator instance.
*
* @var \Illuminate\Validation\Validator
*/
protected $validator;
// ...
/**
* Set the current validator.
*
* @param \Illuminate\Validation\Validator $validator
* @return $this
*/
public function setValidator($validator)
{
$this->validator = $validator;
return $this;
}
}
Использование замыканий
Если вам нужна функциональность собственного правила только один раз во всем приложении, то вы можете использовать анонимное правило вместо объекта правила. Анонимное правило получит имя атрибута, значение атрибута и замыкание $fail
, которое будет выполнено в случае провала проверки:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($request->all(), [
'title' => [
'required',
'max:255',
function ($attribute, $value, $fail) {
if ($value === 'foo') {
$fail('The '.$attribute.' is invalid.');
}
},
],
]);
Неявные правила
По умолчанию, правила валидации, включая созданные вами, не применяются, если проверяемый атрибут отсутствует или содержит пустую строку. Например, правило unique
не будет выполнено для пустой строки:
use Illuminate\Support\Facades\Validator;
$rules = ['name' => 'unique:users,name'];
$input = ['name' => ''];
Validator::make($input, $rules)->passes(); // true
Чтобы ваше правило было применено, даже если атрибут пуст, то правило должно подразумевать, что атрибут является обязательным. Чтобы создать «неявное» правило, реализуйте интерфейс Illuminate\Contracts\Validation\ImplicitRule
. Это «маркерный интерфейс» для валидатора; следовательно, он не содержит никаких дополнительных методов, которые вам нужно реализовать, помимо методов, требуемых типичным интерфейсом Rule
.
Чтобы сгенерировать новый объект неявного правила, вы можете использовать Artisan-команду make:rule
с параметром --implicit
:
php artisan make:rule Uppercase --implicit
«Неявное» правило только подразумевает, что атрибут является обязательным к валидации. В действительности решать только вам, будет ли пустой или отсутствующий атрибут считаться невалидным.
- 1. Введение
-
2. Краткое руководство по проверке ввода
- 2.1. Определение маршрутов
-
3. Создание контроллера
- 3.1. Написание логики проверки ввода
- 3.2. Вывод ошибок
-
4. Проверка запроса формы
- 4.1. Создание запроса формы
- 4.2. Авторизация запроса формы
- 4.3. Настройка формата ошибок
- 4.4. Настройка сообщений об ошибках
-
5. Создание валидаторов вручную
- 5.1. Автоматическая переадресация
- 5.2. Именованные наборы ошибок
- 5.3. Вебхук после проверки
-
6. Работа с сообщениями об ошибках
- 6.1. Изменение сообщений об ошибках
-
7. Доступные правила проверки
- 7.1. accepted
- 7.2. active_url
- 7.3. after:date
- 7.4. alpha
- 7.5. alpha_dash
- 7.6. alpha_num
- 7.7. array
- 7.8. before:date
- 7.9. between:min,max
- 7.10. boolean
- 7.11. confirmed
- 7.12. date
- 7.13. date_format:format
- 7.14. different:field
- 7.15. digits:value
- 7.16. digits_between:min,max
- 7.17. dimensions
- 7.18. distinct
- 7.19. email
- 7.20. exists:table,column
- 7.21. file
- 7.22. filled
- 7.23. image
- 7.24. in:foo,bar,…
- 7.25. in_array:anotherfield
- 7.26. integer
- 7.27. ip
- 7.28. json
- 7.29. max:value
- 7.30. mimetypes:text/plain,…
- 7.31. mimes:foo,bar,…
- 7.32. min:value
- 7.33. nullable
- 7.34. not_in:foo,bar,…
- 7.35. numeric
- 7.36. present
- 7.37. regex:pattern
- 7.38. required
- 7.39. required_if:anotherfield,value,…
- 7.40. required_unless:anotherfield,value,…
- 7.41. required_with:foo,bar,…
- 7.42. required_with_all:foo,bar,…
- 7.43. required_without:foo,bar,…
- 7.44. required_without_all:foo,bar,…
- 7.45. same:field
- 7.46. size:value
- 7.47. string
- 7.48. timezone
- 7.49. unique:table,column,except,idColumn
- 7.50. url
- 8. Условные правила
- 9. Проверка ввода массивов
- 10. Собственные правила проверки
Введение
Laravel предоставляет несколько разных подходов к проверке входящих в ваше приложение данных. По умолчанию базовый класс контроллера использует типаж ValidatesRequests, который предоставляет удобный метод проверки входящего HTTP-запроса с помощью различных мощных правил проверки.
Краткое руководство по проверке ввода
Для изучения мощных возможностей проверки ввода в Laravel, давайте рассмотрим полный пример проверки ввода через форму и вывода сообщений об ошибках.
Определение маршрутов
Сначала давайте предположим, что у нас есть следующие маршруты, определённые в файле routes/web.php:
PHP
Route::get('post/create', 'PostController@create');Route::post('post', 'PostController@store');
Очевидно, маршрут GET выведет пользователю форму для написания новой статьи, а маршрут POST сохранит её в БД.
Создание контроллера
Теперь давайте посмотрим на простой контроллер, который обрабатывает эти маршруты. Метод PHPstore()
мы пока оставим пустым:
PHP
<?phpnamespace App\Http\Controllers;use
Illuminate\Http\Request;
use App\Http\Controllers\Controller;class
PostController extends Controller
{
/**
* Вывод формы написания статьи.
*
* @return Response
*/
public function create()
{
return view('post.create');
}/**
* Сохранение новой статьи.
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
// Проверка и сохранение новой статьи.
}
}
Написание логики проверки ввода
Теперь мы готовы наполнить метод PHPstore()
логикой для проверки новой статьи. Если вы посмотрите в базовый класс контроллера приложения (App\Http\Controllers\Controller), то увидите, что в нём используется типаж ValidatesRequests. Этот типаж предоставляет удобный метод PHPvalidate()
всем вашим контроллерам.
Метод PHPvalidate()
принимает входящий HTTP-запрос и набор правил для проверки. Если проверка успешна, ваш код продолжит нормально выполняться. Но если проверка провалится, возникнет исключение, и пользователю будет автоматически отправлен отклик с соответствующей ошибкой. Для обычных HTTP-запросов будет сгенерирован отклик-переадресация, а для AJAX-запросов — JSON-отклик.
Для лучшего понимания метода PHPvalidate()
давайте вернёмся к методу PHPstore()
:
PHP
/**
* Сохранение новой статьи.
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$this->validate($request, [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);// Статья прошла проверку, сохранение в БД...
}
Как видите, мы просто передали входящий HTTP-запрос и требуемые правила проверки в метод PHPvalidate()
. Если проверка провалится, будет сгенерирован соответствующий отклик. Если проверка успешна, ваш контроллер продолжит нормально выполняться.
+
5.2
добавлено в
5.2
()
Остановка после первой ошибки ввода
Иногда надо остановить выполнение правил проверки ввода для атрибута после первой ошибки. Для этого назначьте на атрибут правило bail:
PHP
$this->validate($request, [
'title' => 'bail|required|unique:posts|max:255',
'body' => 'required',
]);
Если правило required на атрибуте title не выполнится, то правило unique не будет проверяться. Правила будут проверены в порядке их назначения.
Замечание о вложенных атрибутах
Если ваш HTTP-запрос содержит «вложенные» параметры, вы можете указать их в правилах проверки с помощью «точечной» записи:
PHP
$this->validate($request, [
'title' => 'required|unique:posts|max:255',
'author.name' => 'required',
'author.description' => 'required',
]);
Вывод ошибок
Что будет, если параметры входящего запроса не пройдут проверку? Как уже было сказано, Laravel автоматически перенаправит пользователя на предыдущую страницу. Вдобавок, все ошибки будут автоматически отправлены в сессию.
Заметьте, мы не привязывали сообщения об ошибках к представлению в нашем маршруте GET. Потому что Laravel проверяет наличие ошибок в данных сессии и автоматически привязывает их к представлению, если они доступны. Поэтому важно помнить, что переменная PHP$errors
будет всегда доступна во всех ваших представлениях при каждом запросе, позволяя вам всегда рассчитывать на то, что она определена и может быть безопасно использована. Переменная PHP$errors
будет экземпляром Illuminate\Support\MessageBag. Более подробно о работе с этим объектом читайте в его документации.
Переменная PHP$errors
привязывается к представлению посредником Illuminate\View\Middleware\ShareErrorsFromSession, который входит в состав группы посредников web.
Итак, в нашем примере при неудачной проверке пользователь будет перенаправлен в метод PHPcreate()
нашего контроллера, позволяя нам вывести сообщения об ошибках в представлении:
PHP
<!-- /resources/views/post/create.blade.php --><
h1>Написать статью</h1>@if (
count($errors) > 0)
<div class="alert alert-danger">
<ul>
@foreach ($errors->all() as $error)
<li>{{ $error }}</li>
@endforeach
</ul>
</div>
@endif<!--
Форма написания статьи -->
Настройка формата передачи ошибок
Чтобы настроить формат ошибок проверки, передаваемых в сессию при их возникновении, переопределите formatValidationErrors в базовом контроллере. Не забудьте импортировать класс Illuminate\Contracts\Validation\Validator (для Laravel 5.0 Illuminate\Validation\Validator) в начале файла:
PHP
<?phpnamespace App\Http\Controllers;use
Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Foundation\Validation\ValidatesRequests;abstract class
Controller extends BaseController
{
use DispatchesJobs, ValidatesRequests;/**
* {@inheritdoc}
*/
protected function formatValidationErrors(Validator $validator)
{
return $validator->errors()->all();
}
}
AJAX-запросы и проверка ввода
В этом примере мы использовали обычную форму для отправки данных в приложение. Но многие приложения используют AJAX-запросы. При использовании метода PHPvalidate()
для AJAX-запросов Laravel не создаёт отклик-переадресацию. Вместо этого Laravel создаёт JSON-отклик, содержащий все возникшие при проверке ошибки. Этот JSON-отклик будет отправлен с HTTP-кодом состояния 422.
Проверка запроса формы
Создание запроса формы
Для более сложных сценариев проверки вам может понадобиться «запрос формы». Запросы формы — изменённые классы запросов, содержащие логику проверки. Для создания класса запроса формы используйте Artisan-команду shmake:request
:
shphp artisan make:request StoreBlogPost
Сгенерированный класс будет помещён в папку app/Http/Requests. Если такой папки нет, она будет создана при запуске команды shmake:request
. Давайте добавим несколько правил проверки в метод PHPrules()
:
PHP
/**
* Получить правила проверки для применения к запросу.
*
* @return array
*/
public function rules()
{
return [
'title' => 'required|unique|max:255',
'body' => 'required',
];
}
А как же запускаются правила проверки? Надо просто указать тип запроса в методе контроллера. Входящий запрос формы проверяется до вызова метода контроллера, это значит, что вам не надо захламлять ваш контроллер логикой проверки:
PHP
/**
* Сохранить входящую статью.
*
* @param StoreBlogPost $request
* @return Response
*/
public function store(StoreBlogPost $request)
{
// Входящий запрос прошёл проверку...
}
Если проверка неуспешна, будет сгенерирован отклик-переадресация для перенаправления пользователя на предыдущую страницу. Также в сессию будут переданы ошибки, и их можно будет отобразить. Если запрос был AJAX-запросом, то пользователю будет возвращён HTTP-отклик с кодом состояния 422, содержащий JSON-представление ошибок проверки.
Авторизация запроса формы
Класс запроса формы также содержит метод PHPauthorize()
. Этим методом вы можете проверить, действительно ли у авторизованного пользователя есть право на изменение данного ресурса. Например, вы можете определить, является ли пользователь владельцем комментария, который он пытается изменить:
PHP
/**
* Определить, авторизован ли пользователь для этого запроса.
*
* @return bool
*/
public function authorize()
{
$comment = Comment::find($this->route('comment')); return
$comment && $this->user()->can('update', $comment);
}
Поскольку все запросы форм наследуют базовый класс запроса Laravel, мы можем использовать метод PHPuser()
для получения текущего аутентифицированного пользователя. Также обратите внимание на вызов метода PHProute()
в этом примере. Этот метод даёт вам доступ к параметрам URI, определённым в вызванном маршруте, таким как параметр PHP{comment}
в примере ниже:
PHP
Route::post('comment/{comment}');
Если метод PHPauthorize()
возвращает false, то будет автоматически возвращён HTTP-ответ с кодом состояния 403, и метод вашего контроллера не будет выполнен.
Если вы планируете разместить логику авторизации в другой части приложения, просто верните true из метода PHPauthorize()
:
PHP
/**
* Определить, авторизован ли пользователь для этого запроса.
*
* @return bool
*/
public function authorize()
{
return true;
}
Настройка формата ошибок
Если хотите настроить формат сообщений об ошибках ввода, передаваемых в сессию при их возникновении, переопределите PHPformatErrors()
в вашем базовом запросе (App\Http\Requests\Request). Не забудьте импортировать класс Illuminate\Contracts\Validation\Validator в начале файла:
PHP
/**
* {@inheritdoc}
*/
protected function formatErrors(Validator $validator)
{
return $validator->errors()->all();
}
Настройка сообщений об ошибках
Для настройки сообщений об ошибках, используемых запросом формы, переопределите метод PHPmessages()
. Этот метод должен возвращать массив пар атрибут/правило и соответствующие им сообщения об ошибках:
PHP
/**
* Получить сообщения об ошибках для определённых правил проверки.
*
* @return array
*/
public function messages()
{
return [
'title.required' => 'Необходимо указать заголовок',
'body.required' => 'Необходимо написать статью',
];
}
Создание валидаторов вручную
Если вы не хотите использовать метод PHPvalidate()
типажа ValidatesRequests, вы можете создать экземпляр валидатора вручную с помощью фасада Validator. Метод PHPmake()
этого фасада создаёт новый экземпляр валидатора:
PHP
<?phpnamespace App\Http\Controllers;use
Validator;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;class
PostController extends Controller
{
/**
* Сохранить новую статью.
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$validator = Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]); if (
$validator->fails()) {
return redirect('post/create')
->withErrors($validator)
->withInput();
}// Сохранить статью...
}
}
Первый аргумент метода PHPmake()
— данные для проверки. Второй — правила, которые должны быть применены к этим данным.
Если запрос не пройдёт проверку, вы можете использовать метод PHPwithErrors()
, чтобы передать сообщения об ошибках в сессию. При использовании этого метода переменная PHP$errors
автоматически станет общей для ваших представлений после переадресации, позволяя вам легко выводить их пользователю. Метод PHPwithErrors()
принимает валидатор, MessageBag или PHP-массив.
+
5.3
добавлено в
5.3
()
Автоматическая переадресация
Если вы хотите создать экземпляр валидатора вручную, но при этом иметь возможность автоматической переадресации, предлагаемой типажом ValidatesRequest, то можете вызвать метод PHPvalidate()
на существующем экземпляре валидатора. Если при проверке обнаружатся ошибки, пользователь будет автоматически переадресован, а в случае AJAX-запроса будет возвращён JSON-отклик:
PHP
Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
])->validate();
+
5.0
добавлено в
5.0
()
Использование массивов для указания правил
Несколько правил могут быть разделены либо прямой чертой (|), либо быть отдельными элементами массива.
PHP
$validator = Validator::make(
['name' => 'Ваня'],
['name' => ['required', 'min:5']]
);
Проверка нескольких полей
PHP
$validator = Validator::make(
[
'name' => 'Ваня',
'password' => 'плохойпароль',
'email' => 'email@example.com'
],
[
'name' => 'required',
'password' => 'required|min:8',
'email' => 'required|email|unique:users'
]
);
Когда создан экземпляр PHPValidator
, метод PHPfails()
(или PHPpasses()
) может быть использован для проведения проверки.
PHP
if ($validator->fails()) {
// Переданные данные не прошли проверку
}
Если валидатор нашёл ошибки, вы можете получить его сообщения таким образом:
PHP
$messages = $validator->messages();
Вы также можете получить массив правил, по которым данные не прошли проверку, без самих сообщений — с помощью метода PHPfailed()
:
PHP
$failed = $validator->failed();
Именованные наборы ошибок
Если у вас несколько форм на одной странице, вы можете дать имена наборам ошибок MessageBag, и получать сообщения об ошибках для конкретной формы. Просто передайте имя вторым аргументом метода PHPwithErrors()
:
PHP
return redirect('register')
->withErrors($validator, 'login');
Теперь вы можете обращаться к экземпляру MessageBag из переменной PHP$errors
:
PHP
{{ $errors->login->first('email') }}
Вебхук после проверки
Валидатор также позволяет прикрепить обратные вызовы, которые будут запущены после завершения проверки. Это позволяет легко выполнять последующие проверки, а также добавлять сообщения об ошибках в коллекцию сообщений. Для начала используйте метод PHPafter()
на экземпляре класса PHPValidator
:
PHP
$validator = Validator::make(...);$validator->after(function($validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add('field', 'В этом поле что-то не так!');
}
});if (
$validator->fails()) {
//
}
Работа с сообщениями об ошибках
После вызова метода PHPerrors()
(для Laravel 5.0 PHPmessages()
) на экземпляре Validator вы получите объект PHPIlluminate\Support\MessageBag
, который имеет набор полезных методов для работы с сообщениями об ошибках. Переменная PHP$errors
, которая автоматически становится доступной всем представлениям, также является экземпляром класса MessageBag.
Получение первого сообщения для поля
Для получения первого сообщения об ошибке для данного поля используйте метод PHPfirst()
:
PHP
$errors = $validator->errors();echo
$errors->first('email');
Получение всех сообщений для одного поля
Для получения массива всех сообщений для данного поля используйте метод PHPget()
:
PHP
foreach ($errors->get('email') as $message) {
//
}
+
5.3
добавлено в
5.3
()
При проверке массива из поля вы можете получить все сообщения по каждому элементу массива с помощью символа PHP*
:
PHP
foreach ($errors->get('attachments.*') as $message) {
//
}
Получение всех сообщений для всех полей
Для получения массива всех сообщения для всех полей используйте метод PHPall()
:
PHP
foreach ($errors->all() as $message) {
//
}
Проверка наличия сообщения для поля
Для определения наличия сообщений об ошибках для определённого поля служит метод PHPhas()
:
PHP
if ($messages->has('email')) {
//
}
+
5.2 5.1 5.0
добавлено в
5.2
()
5.1
()
5.0
()
Получение ошибки в заданном формате
PHP
echo $messages->first('email', '<p>:message</p>');
По умолчанию сообщения форматируются в вид, который подходит для Bootstrap.
Получение всех сообщений в заданном формате
PHP
foreach ($messages->all('<li>:message</li>') as $message) {
//
}
Изменение сообщений об ошибках
При необходимости вы можете задать свои сообщения об ошибках проверки ввода вместо изначальных. Для этого есть несколько способов. Во-первых, вы можете передать свои сообщения третьим аргументом метода PHPValidator::make()
:
PHP
$messages = [
'required' => 'Необходимо указать :attribute.',
];$validator = Validator::make($input, $rules, $messages);
В этом примере обозначение :attribute будет заменено именем проверяемого поля. Вы можете использовать и другие обозначения. Например:
PHP
$messages = [
'same' => ':attribute и :other должны совпадать.',
'size' => ':attribute должен быть равен :size.',
'between' => ':attribute должен быть между :min и :max.',
'in' => ':attribute должен иметь один из следующих типов: :values',
];
Указание своего сообщения для конкретного атрибута
Иногда вам может понадобиться указать своё сообщения только для конкретного поля. Вы можете сделать это с помощью «точечной» записи. Сначала укажите имя атрибута, а затем правило:
PHP
$messages = [
'email.required' => 'Нам надо знать ваш e-mail!',
];
Указание своих сообщений в языковых файлах
В большинстве случаев вы будете указывать свои сообщения в языковом файле, а не передавать их напрямую в Validator. Для этого добавьте свои сообщения в массив custom в языковом файле resources/lang/xx/validation.php:
PHP
'custom' => [
'email' => [
'required' => 'Нам надо знать ваш e-mail!',
],
],
+
5.3
добавлено в
5.3
()
Указание своих атрибутов в языковых файлах
Если вы хотите заменить часть PHP:attribute
в своём сообщении о проверке ввода на своё имя атрибута, вы можете указать своё имя в массиве attributes в языковом файле resources/lang/xx/validation.php:
PHP
'attributes' => [
'email' => 'email address',
],
Доступные правила проверки
accepted
Поле должно быть в значении yes, on, 1 или true. Это полезно для проверки принятия правил и лицензий.
active_url
after:date
Поле должно быть датой, более поздней, чем date. Строки приводятся к датам функцией strtotime:
PHP
'start_date' => 'required|date|after:tomorrow'
Вместо того, чтобы передавать строку-дату в strtotime, вы можете указать другое поле для сравнения с датой:
PHP
'finish_date' => 'required|date|after:start_date'
alpha
Поле должно содержать только латинские символы.
alpha_dash
Поле должно содержать только латинские символы, цифры, знаки подчёркивания (_) и дефисы (-).
alpha_num
Поле должно содержать только латинские символы и цифры.
array
Поле должно быть PHP-массивом (тип array).
before:date
Поле должно быть датой, более ранней, чем date. Строки приводятся к датам функцией strtotime.
between:min,max
Поле должно быть числом в диапазоне от min до max. Строки, числа и файлы трактуются аналогично правилу PHPsize
.
boolean
Поле должно соответствовать логическому типу. Доступные значения: true, false, 1, 0, "1" и "0".
confirmed
Значение поля должно соответствовать значению поля с этим именем, плюс _confirmation. Например, если проверяется поле password, то на вход должно быть передано совпадающее по значению поле password_confirmation.
date
Поле должно быть правильной датой в соответствии с PHP-функцией strtotime.
date_format:format
Поле должно подходить под заданный формат. При проверке поля вы должны использовать либо date, либо date_format, но не оба сразу.
different:field
Значение проверяемого поля должно отличаться от значения поля field.
digits:value
Поле должно быть числовым и иметь длину, равную value.
digits_between:min,max
Поле должно иметь длину в диапазоне между min и max.
+
5.3 5.2
добавлено в
5.3
()
5.2
()
dimensions
Файл должен быть изображением с подходящими под ограничения размерами, которые указаны в параметрах правила:
PHP
'avatar' => 'dimensions:min_width=100,min_height=200'
Доступные ограничения: min_width, max_width, min_height, max_height, width, height, ratio.
Ограничение ratio должно быть задано в виде ширины, поделённой на высоту. Это можно указать выражением вида PHP3/2
или в виде нецелого числа PHP1.5
:
PHP
'avatar' => 'dimensions:ratio=3/2'
distinct
При работе с массивами поле не должно содержать дублирующих значений.
PHP
'foo.*.id' => 'distinct'
email
Поле должно быть корректным адресом e-mail.
exists:table,column
Поле должно существовать в заданной таблице базы данных.
Простое использование
PHP
'state' => 'exists:states'
Указание имени поля в таблице
PHP
'state' => 'exists:states,abbreviation'
+
5.2
добавлено в
5.2
()
Вы также можете указать больше условий, которые будут добавлены к запросу WHERE:
PHP
'email' => 'exists:staff,email,account_id,1'
Это условие можно обратить с помощью знака ! :
PHP
'email' => 'exists:staff,email,role,!admin'
Если передать значение NULL/NOT_NULL в запрос WHERE, то это добавит проверку значения БД на совпадение с NULL/NOT_NULL:
PHP
'email' => 'exists:staff,email,deleted_at,NULL''email'
=> 'exists:staff,email,deleted_at,NOT_NULL'
+
5.3 5.2
добавлено в
5.3
()
5.2
()
Иногда бывает необходимо указать конкретное подключение к базе данных для запроса PHPexists
. Это можно сделать, подставив имя подключения перед именем таблицы с помощью «точечного» синтаксиса:
PHP
'email' => 'exists:connection.staff,email'
+
5.3
добавлено в
5.3
()
Если вы хотите изменить запрос, выполняемый правилом проверки, то можете использовать класс Rule, чтобы задать правило гибко. В этом примере мы также укажем правила проверки в виде массива, вместо использования символа PHP|
для разделения правил:
PHP
use Illuminate\Validation\Rule;Validator::make($data, [
'email' => [
'required',
Rule::exists('staff')->where(function ($query) {
$query->where('account_id', 1);
}),
],
]);
file
Поле должно быть успешно загруженным файлом.
filled
Поле не должно быть пустым, если оно есть.
image
Загруженный файл должен быть изображением в формате JPEG, PNG, BMP, GIF или SVG.
in:foo,bar,…
Значение поля должно быть одним из перечисленных (foo, bar и т.д.).
+
5.2
добавлено в
5.2
()
in_array:anotherfield
Значение в поле должно быть одним из значений поля anotherfield.
integer
Поле должно иметь корректное целочисленное значение.
ip
Поле должно быть корректным IP-адресом.
json
Поле должно быть JSON-строкой.
max:value
Значение поля должно быть меньше или равно value. Строки, числа и файлы трактуются аналогично правилу PHPsize
.
+
5.2
добавлено в
5.2
()
mimetypes:text/plain,…
Файл должен быть одного из перечисленных MIME-типов:
PHP
'video' => 'mimetypes:video/avi,video/mpeg,video/quicktime'
Для определения MIME-типа загруженного файла фреймворк прочитает его содержимое и попытается определить MIME-тип, который может отличаться от указанного клиентом.
mimes:foo,bar,…
MIME-тип загруженного файла должен быть одним из перечисленных.
Простое использование
PHP
'photo' => 'mimes:jpeg,bmp,png'
Несмотря на то, что вы просто указываете расширение файла, это правило проверяет MIME-тип файла, обращаясь к его содержимому и распознавая его MIME-тип.
Полный список MIME-типов и соответствующих им расширений можно найти по ссылке [https://svn.apache.org].
min:value
Значение поля должно быть более или равно value. Строки, числа и файлы трактуются аналогично правилу PHPsize
.
+
5.3
добавлено в
5.3
()
nullable
Поле может иметь значение PHPnull
. Это особенно полезно при проверке таких примитивов, как строки и числа, которые могут содержать значения PHPnull
.
not_in:foo,bar,…
Значение поля не должно быть одним из перечисленных (foo, bar и т.д.).
numeric
Поле должно иметь корректное числовое или дробное значение.
+
5.2
добавлено в
5.2
()
present
Поле должно быть в данных ввода, но может быть пустым.
regex:pattern
Поле должно соответствовать заданному регулярному выражению.
При использовании этого правила может быть необходимо указать другие правила в виде элементов массива, вместо разделения их с помощью символа вертикальной черты, особенно если выражение содержит этот символ вертикальной черты (|).
required
Проверяемое поле должно иметь непустое значение. Поле считается «пустым», при выполнении одного из следующих условий:
- Значение поля — NULL
- Значение поля — пустая строка
- Значение поля — пустой массив или пустой Countable-объект
- Значение поля — файл для загрузки без пути
required_if:anotherfield,value,…
Проверяемое поле должно иметь непустое значение, если другое поле anotherfield имеет любое значение value.
required_unless:anotherfield,value,…
Проверяемое поле должно иметь непустое значение, если другое поле anotherfield не имеет значение value.
required_with:foo,bar,…
Проверяемое поле должно иметь непустое значение, но только если присутствует любое из перечисленных полей (foo, bar и т.д.).
required_with_all:foo,bar,…
Проверяемое поле должно иметь непустое значение, но только если присутствуют все перечисленные поля (foo, bar и т.д.).
required_without:foo,bar,…
Проверяемое поле должно иметь непустое значение, но только если не присутствует любое из перечисленных полей (foo, bar и т.д.).
required_without_all:foo,bar,…
Проверяемое поле должно иметь непустое значение, но только если не присутствуют все перечисленные поля (foo, bar и т.д.).
same:field
Поле должно иметь то же значение, что и поле field.
size:value
Поле должно иметь совпадающий с value размер. Для строк это обозначает длину, для чисел — число, для массивов — число элементов массива, для файлов — размер в килобайтах.
string
Поле должно быть строкового типа. Если вы хотите разрешить для поля значение PHPnull
, назначьте на поле правило PHPnullable
.
timezone
Поле должно содержать корректный идентификатор временной зоны в соответствии с PHP-функцией PHPtimezone_identifiers_list
.
unique:table,column,except,idColumn
Значение поля должно быть уникальным в заданной таблице базы данных. Если column не указано, то будет использовано имя поля.
Указание имени столбца в таблице
PHP
'email' => 'unique:users,email_address'
Указание соединения с БД
Иногда вам может потребоваться задать собственное соединение для запросов к базе данных от PHPValidator
. Как видно выше, правило проверки PHPunique:users
будет использовать соединение с базой данных по умолчанию для запроса к базе данных. Чтобы изменить это, укажите соединение и имя таблицы, используя «точечную» запись:
PHP
'email' => 'unique:connection.users,email_address'
+
5.0
добавлено в
5.0
()
PHP
$verifier = App::make('validation.presence');$verifier->setConnection('connectionName');$validator = Validator::make($input, [
'name' => 'required',
'password' => 'required|min:8',
'email' => 'required|email|unique:users',
]);$validator->setPresenceVerifier($verifier);
Игнорирование определённого ID
Иногда бывает необходимо игнорировать конкретный ID при проверке на уникальность. Например, представим экран «изменения профиля», который содержит имя пользователя, адрес e-mail и местоположение. Разумеется, вы захотите проверить уникальность e-mail. Но если пользователь изменит только поле с именем, и не изменит e-mail, вам надо избежать возникновения ошибки из-за того, что пользователь сам уже является владельцем этого e-mail.
+
5.3
добавлено в
5.3
()
Чтобы валидатор игнорировал ID пользователя, мы используем класс Rule для гибкого задания правила. В этом примере мы также укажем правила проверки в виде массива, вместо использования символа PHP|
для разделения правил:
PHP
use Illuminate\Validation\Rule;Validator::make($data, [
'email' => [
'required',
Rule::unique('users')->ignore($user->id),
],
]);
Если в вашей таблице используется первичный ключ с именем, отличающимся от id, укажите его при вызове метода PHPignore()
:
PHP
'email' => Rule::unique('users')->ignore($user->id, 'user_id')
+
5.2 5.1 5.0
добавлено в
5.2
()
5.1
()
5.0
()
Вам надо, чтобы ошибка возникла только в том случае, когда пользователь укажет e-mail, который уже был использован другим пользователем. Чтобы правило проверки на уникальность игнорировало ID пользователя, передайте ID третьим параметром:
PHP
'email' => 'unique:users,email_address,'.$user->id
Если в вашей таблице используется первичный ключ с именем, отличающимся от id, укажите его четвёртым параметром:
PHP
'email' => 'unique:users,email_address,'.$user->id.',user_id'
Добавление дополнительных условий
+
5.3
добавлено в
5.3
()
Вы также можете указать дополнительные условия запроса, изменив запрос методом PHPwhere()
. Например, давайте добавим условие, которое проверяет, что PHPaccount_id
равно PHP1
:
PHP
'email' => Rule::unique('users')->where(function ($query) {
$query->where('account_id', 1);
})
+
5.2 5.1 5.0
добавлено в
5.2
()
5.1
()
5.0
()
Вы также можете указать больше условий, которые будут добавлены к запросу WHERE:
PHP
'email' => 'unique:users,email_address,NULL,id,account_id,1'
В правиле выше только строки с account_id равным 1 будут включены в проверку.
url
Поле должно быть корректным URL.
Условные правила
Проверять при наличии
В некоторых случаях вам нужно запускать проверки поля, только если оно есть во входном массиве. Чтобы быстро это сделать, добавьте правило sometimes в ваш список правил:
PHP
$v = Validator::make($data, [
'email' => 'sometimes|required|email',
]);
В этом примере поле email будет проверено, только если оно есть в массиве $data.
Сложные условные проверки
Иногда вам может быть нужно, чтобы поле имело какое-либо значение, только если другое поле имеет значение, скажем, больше 100. Или вы можете требовать наличия двух полей, только когда также указано третье. Это легко достигается условными правилами. Сперва создайте объект PHPValidator
с набором статичных правил, которые никогда не изменяются:
PHP
$v = Validator::make($data, [
'email' => 'required|email',
'games' => 'required|numeric',
]);
Теперь предположим, что ваше приложения написано для коллекционеров игр. Если регистрируется коллекционер с более, чем 100 играми, то мы хотим его спросить, зачем ему такое количество. Например, у него может быть магазин игр, или может ему просто нравится их собирать. Итак, для добавления такого условного правила мы используем метод PHPsometimes()
на экземпляре PHPValidator
:
PHP
$v->sometimes('reason', 'required|max:500', function ($input) {
return $input->games >= 100;
});
Первый аргумент этого метода — имя поля, которое мы проверяем. Второй аргумент — правило, которое мы хотим добавить, если переданная функция-замыкание (третий аргумент) вернёт true. Этот метод позволяет легко создавать сложные правила проверки ввода. Вы можете даже добавлять условные правила для нескольких полей одновременно:
PHP
$v->sometimes(['reason', 'cost'], 'required', function ($input) {
return $input->games >= 100;
});
Параметр PHP$input
, передаваемый замыканию — объект Illuminate\Support\Fluent и может использоваться для чтения проверяемого ввода и файлов.
+
5.3 5.2
добавлено в
5.3
()
5.2
()
Проверка ввода массивов
Проверка ввода массива из полей ввода не должна быть сложной. Например, чтобы проверить, что каждый e-mail в данном поле ввода массива уникален, можно сделать так:
PHP
$validator = Validator::make($request->all(), [
'person.*.email' => 'email|unique:users',
'person.*.first_name' => 'required_with:person.*.last_name',
]);
Также вы можете использовать символ * при задании сообщений об ошибках ввода в языковых файлах, что позволяет легко использовать одно сообщение для полей на основе массивов:
PHP
'custom' => [
'person.*.email' => [
'unique' => 'Каждый пользователь должен иметь уникальный адрес e-mail',
]
],
Собственные правила проверки
Laravel содержит множество полезных правил, однако вам может понадобиться создать собственные. Один из способов зарегистрировать произвольное правило — через метод PHPValidator::extend()
. Давайте используем этот метод в сервис-провайдере для регистрации своего правила:
PHP
<?phpnamespace App\Providers;use
Illuminate\Support\Facades\Validator;
//для версии 5.2 и ранее:
//use Validator;
use Illuminate\Support\ServiceProvider;class
AppServiceProvider extends ServiceProvider
{
/**
* Загрузка любых сервисов приложения.
*
* @return void
*/
public function boot()
{
Validator::extend('foo', function ($attribute, $value, $parameters, $validator) {
return $value == 'foo';
});
}/**
* Регистрация сервис-провайдера.
*
* @return void
*/
public function register()
{
//
}
}
Переданная функция-замыкание получает четыре аргумента: имя проверяемого поля PHP$attribute
, значение поля PHP$value
, массив параметров PHP$parameters
, переданных правилу, и объект Validator.
Вместо замыкания в метод PHPextend()
также можно передать метод класса:
PHP
Validator::extend('foo', 'FooValidator@validate');
Определение сообщения об ошибке
Вам также понадобится определить сообщение об ошибке для нового правила. Вы можете сделать это либо передавая его в виде массива строк в PHPValidator
, либо вписав в языковой файл. Это сообщение необходимо поместить на первом уровне массива, а не в массив custom, который используется только для сообщений по конкретным полям:
PHP
"foo" => "Your input was invalid!","accepted" => "The :attribute must be accepted.",// Остальные сообщения об ошибках...
+
5.0
добавлено в
5.0
()
Расширение класса PHPValidator
Вместо использования функций-замыканий для расширения набора доступных правил вы можете расширить сам класс PHPValidator
. Для этого создайте класс, который наследует Illuminate\Validation\Validator. Вы можете добавить новые методы проверок, начав их имя с validate:
PHP
<?phpclass CustomValidator extends \Illuminate\Validation\Validatorpublic function validateFoo($attribute, $value, $parameters)
{
return $value == 'foo';
}}
Регистрация нового класса PHPValidator
Затем вам нужно зарегистрировать собственное расширение:
PHP
Validator::resolver(function($translator, $data, $rules, $messages)
{
return new CustomValidator($translator, $data, $rules, $messages);
});
Иногда при создании своего правила вам может понадобиться определить собственные строки-переменные для замены в сообщениях об ошибках. Это делается путём создания класса, как было описано выше, и вызовом метода PHPValidator::replacer()
. Это можно сделать в методе PHPboot()
сервис-провайдера:
PHP
/**
* Загрузка любых сервисов приложения.
*
* @return void
*/
public function boot()
{
Validator::extend(...);Validator::replacer('foo', function ($message, $attribute, $rule, $parameters) {
return str_replace(...);
});
}
+
5.0
добавлено в
5.0
()
Это делается путём создания класса, как было описано выше, и добавлением функций с именами вида PHPreplaceXXX()
.
PHP
protected function replaceFoo($message, $attribute, $rule, $parameters)
{
return str_replace(':foo', $parameters[0], $message);
}
Неявное наследование
По умолчанию, если проверяемое поле отсутствует или имеет пустое значение по правилу required, обычные правила не запускаются, в том числе собственные правила. Например, правило unique не будет запущено для значения null:
PHP
$rules = ['name' => 'unique'];$input = ['name' => null];Validator::make($input, $rules)->passes(); // true
Чтобы применять правило даже для пустых полей, правило должно считать, что поле обязательное. Для создания такого «неявного» наследования используйте метод PHPValidator::extendImplicit()
:
PHP
Validator::extendImplicit('foo', function ($attribute, $value, $parameters, $validator) {
return $value == 'foo';
});
«Неявное» наследование только указывает на обязательность поля. А будет ли правило пропускать пустое или отсутствующее поле или нет, зависит от вас.
Version
Validation
- Introduction
-
Validation Quickstart
- Defining The Routes
- Creating The Controller
- Writing The Validation Logic
- Displaying The Validation Errors
- Repopulating Forms
- A Note On Optional Fields
- Validation Error Response Format
-
Form Request Validation
- Creating Form Requests
- Authorizing Form Requests
- Customizing The Error Messages
- Preparing Input For Validation
-
Manually Creating Validators
- Automatic Redirection
- Named Error Bags
- Customizing The Error Messages
- Performing Additional Validation
- Working With Validated Input
-
Working With Error Messages
- Specifying Custom Messages In Language Files
- Specifying Attributes In Language Files
- Specifying Values In Language Files
- Available Validation Rules
- Conditionally Adding Rules
-
Validating Arrays
- Validating Nested Array Input
- Error Message Indexes & Positions
- Validating Files
- Validating Passwords
-
Custom Validation Rules
- Using Rule Objects
- Using Closures
- Implicit Rules
Introduction
Laravel provides several different approaches to validate your application’s incoming data. It is most common to use the validate
method available on all incoming HTTP requests. However, we will discuss other approaches to validation as well.
Laravel includes a wide variety of convenient validation rules that you may apply to data, even providing the ability to validate if values are unique in a given database table. We’ll cover each of these validation rules in detail so that you are familiar with all of Laravel’s validation features.
Validation Quickstart
To learn about Laravel’s powerful validation features, let’s look at a complete example of validating a form and displaying the error messages back to the user. By reading this high-level overview, you’ll be able to gain a good general understanding of how to validate incoming request data using Laravel:
Defining The Routes
First, let’s assume we have the following routes defined in our routes/web.php
file:
use App\Http\Controllers\PostController;
Route::get('/post/create', [PostController::class, 'create']);
Route::post('/post', [PostController::class, 'store']);
The GET
route will display a form for the user to create a new blog post, while the POST
route will store the new blog post in the database.
Creating The Controller
Next, let’s take a look at a simple controller that handles incoming requests to these routes. We’ll leave the store
method empty for now:
<?php
namespace App\Http\Controllers;
use App\Http\Controllers\Controller;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\View\View;
class PostController extends Controller
{
/**
* Show the form to create a new blog post.
*/
public function create(): View
{
return view('post.create');
}
/**
* Store a new blog post.
*/
public function store(Request $request): RedirectResponse
{
// Validate and store the blog post...
$post = /** ... */
return to_route('post.show', ['post' => $post->id]);
}
}
Writing The Validation Logic
Now we are ready to fill in our store
method with the logic to validate the new blog post. To do this, we will use the validate
method provided by the Illuminate\Http\Request
object. If the validation rules pass, your code will keep executing normally; however, if validation fails, an Illuminate\Validation\ValidationException
exception will be thrown and the proper error response will automatically be sent back to the user.
If validation fails during a traditional HTTP request, a redirect response to the previous URL will be generated. If the incoming request is an XHR request, a JSON response containing the validation error messages will be returned.
To get a better understanding of the validate
method, let’s jump back into the store
method:
/**
* Store a new blog post.
*/
public function store(Request $request): RedirectResponse
{
$validated = $request->validate([
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
// The blog post is valid...
return redirect('/posts');
}
As you can see, the validation rules are passed into the validate
method. Don’t worry — all available validation rules are documented. Again, if the validation fails, the proper response will automatically be generated. If the validation passes, our controller will continue executing normally.
Alternatively, validation rules may be specified as arrays of rules instead of a single |
delimited string:
$validatedData = $request->validate([
'title' => ['required', 'unique:posts', 'max:255'],
'body' => ['required'],
]);
In addition, you may use the validateWithBag
method to validate a request and store any error messages within a named error bag:
$validatedData = $request->validateWithBag('post', [
'title' => ['required', 'unique:posts', 'max:255'],
'body' => ['required'],
]);
Stopping On First Validation Failure
Sometimes you may wish to stop running validation rules on an attribute after the first validation failure. To do so, assign the bail
rule to the attribute:
$request->validate([
'title' => 'bail|required|unique:posts|max:255',
'body' => 'required',
]);
In this example, if the unique
rule on the title
attribute fails, the max
rule will not be checked. Rules will be validated in the order they are assigned.
A Note On Nested Attributes
If the incoming HTTP request contains «nested» field data, you may specify these fields in your validation rules using «dot» syntax:
$request->validate([
'title' => 'required|unique:posts|max:255',
'author.name' => 'required',
'author.description' => 'required',
]);
On the other hand, if your field name contains a literal period, you can explicitly prevent this from being interpreted as «dot» syntax by escaping the period with a backslash:
$request->validate([
'title' => 'required|unique:posts|max:255',
'v1\.0' => 'required',
]);
Displaying The Validation Errors
So, what if the incoming request fields do not pass the given validation rules? As mentioned previously, Laravel will automatically redirect the user back to their previous location. In addition, all of the validation errors and request input will automatically be flashed to the session.
An $errors
variable is shared with all of your application’s views by the Illuminate\View\Middleware\ShareErrorsFromSession
middleware, which is provided by the web
middleware group. When this middleware is applied an $errors
variable will always be available in your views, allowing you to conveniently assume the $errors
variable is always defined and can be safely used. The $errors
variable will be an instance of Illuminate\Support\MessageBag
. For more information on working with this object, check out its documentation.
So, in our example, the user will be redirected to our controller’s create
method when validation fails, allowing us to display the error messages in the view:
<!-- /resources/views/post/create.blade.php -->
<h1>Create Post</h1>
@if ($errors->any())
<div class="alert alert-danger">
<ul>
@foreach ($errors->all() as $error)
<li>{{ $error }}</li>
@endforeach
</ul>
</div>
@endif
<!-- Create Post Form -->
Customizing The Error Messages
Laravel’s built-in validation rules each have an error message that is located in your application’s lang/en/validation.php
file. If your application does not have a lang
directory, you may instruct Laravel to create it using the lang:publish
Artisan command.
Within the lang/en/validation.php
file, you will find a translation entry for each validation rule. You are free to change or modify these messages based on the needs of your application.
In addition, you may copy this file to another language directory to translate the messages for your application’s language. To learn more about Laravel localization, check out the complete localization documentation.
Warning
By default, the Laravel application skeleton does not include thelang
directory. If you would like to customize Laravel’s language files, you may publish them via thelang:publish
Artisan command.
XHR Requests & Validation
In this example, we used a traditional form to send data to the application. However, many applications receive XHR requests from a JavaScript powered frontend. When using the validate
method during an XHR request, Laravel will not generate a redirect response. Instead, Laravel generates a JSON response containing all of the validation errors. This JSON response will be sent with a 422 HTTP status code.
The @error
Directive
You may use the @error
Blade directive to quickly determine if validation error messages exist for a given attribute. Within an @error
directive, you may echo the $message
variable to display the error message:
<!-- /resources/views/post/create.blade.php -->
<label for="title">Post Title</label>
<input id="title"
type="text"
name="title"
class="@error('title') is-invalid @enderror">
@error('title')
<div class="alert alert-danger">{{ $message }}</div>
@enderror
If you are using named error bags, you may pass the name of the error bag as the second argument to the @error
directive:
<input ... class="@error('title', 'post') is-invalid @enderror">
Repopulating Forms
When Laravel generates a redirect response due to a validation error, the framework will automatically flash all of the request’s input to the session. This is done so that you may conveniently access the input during the next request and repopulate the form that the user attempted to submit.
To retrieve flashed input from the previous request, invoke the old
method on an instance of Illuminate\Http\Request
. The old
method will pull the previously flashed input data from the session:
$title = $request->old('title');
Laravel also provides a global old
helper. If you are displaying old input within a Blade template, it is more convenient to use the old
helper to repopulate the form. If no old input exists for the given field, null
will be returned:
<input type="text" name="title" value="{{ old('title') }}">
A Note On Optional Fields
By default, Laravel includes the TrimStrings
and ConvertEmptyStringsToNull
middleware in your application’s global middleware stack. These middleware are listed in the stack by the App\Http\Kernel
class. Because of this, you will often need to mark your «optional» request fields as nullable
if you do not want the validator to consider null
values as invalid. For example:
$request->validate([
'title' => 'required|unique:posts|max:255',
'body' => 'required',
'publish_at' => 'nullable|date',
]);
In this example, we are specifying that the publish_at
field may be either null
or a valid date representation. If the nullable
modifier is not added to the rule definition, the validator would consider null
an invalid date.
Validation Error Response Format
When your application throws a Illuminate\Validation\ValidationException
exception and the incoming HTTP request is expecting a JSON response, Laravel will automatically format the error messages for you and return a 422 Unprocessable Entity
HTTP response.
Below, you can review an example of the JSON response format for validation errors. Note that nested error keys are flattened into «dot» notation format:
{
"message": "The team name must be a string. (and 4 more errors)",
"errors": {
"team_name": [
"The team name must be a string.",
"The team name must be at least 1 characters."
],
"authorization.role": [
"The selected authorization.role is invalid."
],
"users.0.email": [
"The users.0.email field is required."
],
"users.2.email": [
"The users.2.email must be a valid email address."
]
}
}
Form Request Validation
Creating Form Requests
For more complex validation scenarios, you may wish to create a «form request». Form requests are custom request classes that encapsulate their own validation and authorization logic. To create a form request class, you may use the make:request
Artisan CLI command:
php artisan make:request StorePostRequest
The generated form request class will be placed in the app/Http/Requests
directory. If this directory does not exist, it will be created when you run the make:request
command. Each form request generated by Laravel has two methods: authorize
and rules
.
As you might have guessed, the authorize
method is responsible for determining if the currently authenticated user can perform the action represented by the request, while the rules
method returns the validation rules that should apply to the request’s data:
/**
* Get the validation rules that apply to the request.
*
* @return array<string, \Illuminate\Contracts\Validation\Rule|array|string>
*/
public function rules(): array
{
return [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
];
}
Note
You may type-hint any dependencies you require within therules
method’s signature. They will automatically be resolved via the Laravel service container.
So, how are the validation rules evaluated? All you need to do is type-hint the request on your controller method. The incoming form request is validated before the controller method is called, meaning you do not need to clutter your controller with any validation logic:
/**
* Store a new blog post.
*/
public function store(StorePostRequest $request): RedirectResponse
{
// The incoming request is valid...
// Retrieve the validated input data...
$validated = $request->validated();
// Retrieve a portion of the validated input data...
$validated = $request->safe()->only(['name', 'email']);
$validated = $request->safe()->except(['name', 'email']);
// Store the blog post...
return redirect('/posts');
}
If validation fails, a redirect response will be generated to send the user back to their previous location. The errors will also be flashed to the session so they are available for display. If the request was an XHR request, an HTTP response with a 422 status code will be returned to the user including a JSON representation of the validation errors.
Note
Need to add real-time form request validation to your Inertia powered Laravel frontend? Check out Laravel Precognition.
Performing Additional Validation
Sometimes you need to perform additional validation after your initial validation is complete. You can accomplish this using the form request’s after
method.
The after
method should return an array of callables or closures which will be invoked after validation is complete. The given callables will receive an Illuminate\Validation\Validator
instance, allowing you to raise additional error messages if necessary:
use Illuminate\Validation\Validator;
/**
* Get the "after" validation callables for the request.
*/
public function after(): array
{
return [
function (Validator $validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add(
'field',
'Something is wrong with this field!'
);
}
}
];
}
As noted, the array returned by the after
method may also contain invokable classes. The __invoke
method of these classes will receive an Illuminate\Validation\Validator
instance:
use App\Validation\ValidateShippingTime;
use App\Validation\ValidateUserStatus;
use Illuminate\Validation\Validator;
/**
* Get the "after" validation callables for the request.
*/
public function after(): array
{
return [
new ValidateUserStatus,
new ValidateShippingTime,
function (Validator $validator) {
//
}
];
}
Stopping On The First Validation Failure
By adding a stopOnFirstFailure
property to your request class, you may inform the validator that it should stop validating all attributes once a single validation failure has occurred:
/**
* Indicates if the validator should stop on the first rule failure.
*
* @var bool
*/
protected $stopOnFirstFailure = true;
Customizing The Redirect Location
As previously discussed, a redirect response will be generated to send the user back to their previous location when form request validation fails. However, you are free to customize this behavior. To do so, define a $redirect
property on your form request:
/**
* The URI that users should be redirected to if validation fails.
*
* @var string
*/
protected $redirect = '/dashboard';
Or, if you would like to redirect users to a named route, you may define a $redirectRoute
property instead:
/**
* The route that users should be redirected to if validation fails.
*
* @var string
*/
protected $redirectRoute = 'dashboard';
Authorizing Form Requests
The form request class also contains an authorize
method. Within this method, you may determine if the authenticated user actually has the authority to update a given resource. For example, you may determine if a user actually owns a blog comment they are attempting to update. Most likely, you will interact with your authorization gates and policies within this method:
use App\Models\Comment;
/**
* Determine if the user is authorized to make this request.
*/
public function authorize(): bool
{
$comment = Comment::find($this->route('comment'));
return $comment && $this->user()->can('update', $comment);
}
Since all form requests extend the base Laravel request class, we may use the user
method to access the currently authenticated user. Also, note the call to the route
method in the example above. This method grants you access to the URI parameters defined on the route being called, such as the {comment}
parameter in the example below:
Route::post('/comment/{comment}');
Therefore, if your application is taking advantage of route model binding, your code may be made even more succinct by accessing the resolved model as a property of the request:
return $this->user()->can('update', $this->comment);
If the authorize
method returns false
, an HTTP response with a 403 status code will automatically be returned and your controller method will not execute.
If you plan to handle authorization logic for the request in another part of your application, you may simply return true
from the authorize
method:
/**
* Determine if the user is authorized to make this request.
*/
public function authorize(): bool
{
return true;
}
Note
You may type-hint any dependencies you need within theauthorize
method’s signature. They will automatically be resolved via the Laravel service container.
Customizing The Error Messages
You may customize the error messages used by the form request by overriding the messages
method. This method should return an array of attribute / rule pairs and their corresponding error messages:
/**
* Get the error messages for the defined validation rules.
*
* @return array<string, string>
*/
public function messages(): array
{
return [
'title.required' => 'A title is required',
'body.required' => 'A message is required',
];
}
Customizing The Validation Attributes
Many of Laravel’s built-in validation rule error messages contain an :attribute
placeholder. If you would like the :attribute
placeholder of your validation message to be replaced with a custom attribute name, you may specify the custom names by overriding the attributes
method. This method should return an array of attribute / name pairs:
/**
* Get custom attributes for validator errors.
*
* @return array<string, string>
*/
public function attributes(): array
{
return [
'email' => 'email address',
];
}
Preparing Input For Validation
If you need to prepare or sanitize any data from the request before you apply your validation rules, you may use the prepareForValidation
method:
use Illuminate\Support\Str;
/**
* Prepare the data for validation.
*/
protected function prepareForValidation(): void
{
$this->merge([
'slug' => Str::slug($this->slug),
]);
}
Likewise, if you need to normalize any request data after validation is complete, you may use the passedValidation
method:
/**
* Handle a passed validation attempt.
*/
protected function passedValidation(): void
{
$this->replace(['name' => 'Taylor']);
}
Manually Creating Validators
If you do not want to use the validate
method on the request, you may create a validator instance manually using the Validator
facade. The make
method on the facade generates a new validator instance:
<?php
namespace App\Http\Controllers;
use App\Http\Controllers\Controller;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
class PostController extends Controller
{
/**
* Store a new blog post.
*/
public function store(Request $request): RedirectResponse
{
$validator = Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
if ($validator->fails()) {
return redirect('post/create')
->withErrors($validator)
->withInput();
}
// Retrieve the validated input...
$validated = $validator->validated();
// Retrieve a portion of the validated input...
$validated = $validator->safe()->only(['name', 'email']);
$validated = $validator->safe()->except(['name', 'email']);
// Store the blog post...
return redirect('/posts');
}
}
The first argument passed to the make
method is the data under validation. The second argument is an array of the validation rules that should be applied to the data.
After determining whether the request validation failed, you may use the withErrors
method to flash the error messages to the session. When using this method, the $errors
variable will automatically be shared with your views after redirection, allowing you to easily display them back to the user. The withErrors
method accepts a validator, a MessageBag
, or a PHP array
.
Stopping On First Validation Failure
The stopOnFirstFailure
method will inform the validator that it should stop validating all attributes once a single validation failure has occurred:
if ($validator->stopOnFirstFailure()->fails()) {
// ...
}
Automatic Redirection
If you would like to create a validator instance manually but still take advantage of the automatic redirection offered by the HTTP request’s validate
method, you may call the validate
method on an existing validator instance. If validation fails, the user will automatically be redirected or, in the case of an XHR request, a JSON response will be returned:
Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
])->validate();
You may use the validateWithBag
method to store the error messages in a named error bag if validation fails:
Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
])->validateWithBag('post');
Named Error Bags
If you have multiple forms on a single page, you may wish to name the MessageBag
containing the validation errors, allowing you to retrieve the error messages for a specific form. To achieve this, pass a name as the second argument to withErrors
:
return redirect('register')->withErrors($validator, 'login');
You may then access the named MessageBag
instance from the $errors
variable:
{{ $errors->login->first('email') }}
Customizing The Error Messages
If needed, you may provide custom error messages that a validator instance should use instead of the default error messages provided by Laravel. There are several ways to specify custom messages. First, you may pass the custom messages as the third argument to the Validator::make
method:
$validator = Validator::make($input, $rules, $messages = [
'required' => 'The :attribute field is required.',
]);
In this example, the :attribute
placeholder will be replaced by the actual name of the field under validation. You may also utilize other placeholders in validation messages. For example:
$messages = [
'same' => 'The :attribute and :other must match.',
'size' => 'The :attribute must be exactly :size.',
'between' => 'The :attribute value :input is not between :min - :max.',
'in' => 'The :attribute must be one of the following types: :values',
];
Specifying A Custom Message For A Given Attribute
Sometimes you may wish to specify a custom error message only for a specific attribute. You may do so using «dot» notation. Specify the attribute’s name first, followed by the rule:
$messages = [
'email.required' => 'We need to know your email address!',
];
Specifying Custom Attribute Values
Many of Laravel’s built-in error messages include an :attribute
placeholder that is replaced with the name of the field or attribute under validation. To customize the values used to replace these placeholders for specific fields, you may pass an array of custom attributes as the fourth argument to the Validator::make
method:
$validator = Validator::make($input, $rules, $messages, [
'email' => 'email address',
]);
Performing Additional Validation
Sometimes you need to perform additional validation after your initial validation is complete. You can accomplish this using the validator’s after
method. The after
method accepts a closure or an array of callables which will be invoked after validation is complete. The given callables will receive an Illuminate\Validation\Validator
instance, allowing you to raise additional error messages if necessary:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make(/* ... */);
$validator->after(function ($validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add(
'field', 'Something is wrong with this field!'
);
}
});
if ($validator->fails()) {
// ...
}
As noted, the after
method also accepts an array of callables, which is particularly convenient if your «after validation» logic is encapsulated in invokable classes, which will receive an Illuminate\Validation\Validator
instance via their __invoke
method:
use App\Validation\ValidateShippingTime;
use App\Validation\ValidateUserStatus;
$validator->after([
new ValidateUserStatus,
new ValidateShippingTime,
function ($validator) {
// ...
},
]);
Working With Validated Input
After validating incoming request data using a form request or a manually created validator instance, you may wish to retrieve the incoming request data that actually underwent validation. This can be accomplished in several ways. First, you may call the validated
method on a form request or validator instance. This method returns an array of the data that was validated:
$validated = $request->validated();
$validated = $validator->validated();
Alternatively, you may call the safe
method on a form request or validator instance. This method returns an instance of Illuminate\Support\ValidatedInput
. This object exposes only
, except
, and all
methods to retrieve a subset of the validated data or the entire array of validated data:
$validated = $request->safe()->only(['name', 'email']);
$validated = $request->safe()->except(['name', 'email']);
$validated = $request->safe()->all();
In addition, the Illuminate\Support\ValidatedInput
instance may be iterated over and accessed like an array:
// Validated data may be iterated...
foreach ($request->safe() as $key => $value) {
// ...
}
// Validated data may be accessed as an array...
$validated = $request->safe();
$email = $validated['email'];
If you would like to add additional fields to the validated data, you may call the merge
method:
$validated = $request->safe()->merge(['name' => 'Taylor Otwell']);
If you would like to retrieve the validated data as a collection instance, you may call the collect
method:
$collection = $request->safe()->collect();
Working With Error Messages
After calling the errors
method on a Validator
instance, you will receive an Illuminate\Support\MessageBag
instance, which has a variety of convenient methods for working with error messages. The $errors
variable that is automatically made available to all views is also an instance of the MessageBag
class.
Retrieving The First Error Message For A Field
To retrieve the first error message for a given field, use the first
method:
$errors = $validator->errors();
echo $errors->first('email');
Retrieving All Error Messages For A Field
If you need to retrieve an array of all the messages for a given field, use the get
method:
foreach ($errors->get('email') as $message) {
// ...
}
If you are validating an array form field, you may retrieve all of the messages for each of the array elements using the *
character:
foreach ($errors->get('attachments.*') as $message) {
// ...
}
Retrieving All Error Messages For All Fields
To retrieve an array of all messages for all fields, use the all
method:
foreach ($errors->all() as $message) {
// ...
}
Determining If Messages Exist For A Field
The has
method may be used to determine if any error messages exist for a given field:
if ($errors->has('email')) {
// ...
}
Specifying Custom Messages In Language Files
Laravel’s built-in validation rules each have an error message that is located in your application’s lang/en/validation.php
file. If your application does not have a lang
directory, you may instruct Laravel to create it using the lang:publish
Artisan command.
Within the lang/en/validation.php
file, you will find a translation entry for each validation rule. You are free to change or modify these messages based on the needs of your application.
In addition, you may copy this file to another language directory to translate the messages for your application’s language. To learn more about Laravel localization, check out the complete localization documentation.
Warning
By default, the Laravel application skeleton does not include thelang
directory. If you would like to customize Laravel’s language files, you may publish them via thelang:publish
Artisan command.
Custom Messages For Specific Attributes
You may customize the error messages used for specified attribute and rule combinations within your application’s validation language files. To do so, add your message customizations to the custom
array of your application’s lang/xx/validation.php
language file:
'custom' => [
'email' => [
'required' => 'We need to know your email address!',
'max' => 'Your email address is too long!'
],
],
Specifying Attributes In Language Files
Many of Laravel’s built-in error messages include an :attribute
placeholder that is replaced with the name of the field or attribute under validation. If you would like the :attribute
portion of your validation message to be replaced with a custom value, you may specify the custom attribute name in the attributes
array of your lang/xx/validation.php
language file:
'attributes' => [
'email' => 'email address',
],
Warning
By default, the Laravel application skeleton does not include thelang
directory. If you would like to customize Laravel’s language files, you may publish them via thelang:publish
Artisan command.
Specifying Values In Language Files
Some of Laravel’s built-in validation rule error messages contain a :value
placeholder that is replaced with the current value of the request attribute. However, you may occasionally need the :value
portion of your validation message to be replaced with a custom representation of the value. For example, consider the following rule that specifies that a credit card number is required if the payment_type
has a value of cc
:
Validator::make($request->all(), [
'credit_card_number' => 'required_if:payment_type,cc'
]);
If this validation rule fails, it will produce the following error message:
The credit card number field is required when payment type is cc.
Instead of displaying cc
as the payment type value, you may specify a more user-friendly value representation in your lang/xx/validation.php
language file by defining a values
array:
'values' => [
'payment_type' => [
'cc' => 'credit card'
],
],
Warning
By default, the Laravel application skeleton does not include thelang
directory. If you would like to customize Laravel’s language files, you may publish them via thelang:publish
Artisan command.
After defining this value, the validation rule will produce the following error message:
The credit card number field is required when payment type is credit card.
Available Validation Rules
Below is a list of all available validation rules and their function:
accepted
The field under validation must be "yes"
, "on"
, 1
, or true
. This is useful for validating «Terms of Service» acceptance or similar fields.
accepted_if:anotherfield,value,…
The field under validation must be "yes"
, "on"
, 1
, or true
if another field under validation is equal to a specified value. This is useful for validating «Terms of Service» acceptance or similar fields.
active_url
The field under validation must have a valid A or AAAA record according to the dns_get_record
PHP function. The hostname of the provided URL is extracted using the parse_url
PHP function before being passed to dns_get_record
.
after:date
The field under validation must be a value after a given date. The dates will be passed into the strtotime
PHP function in order to be converted to a valid DateTime
instance:
'start_date' => 'required|date|after:tomorrow'
Instead of passing a date string to be evaluated by strtotime
, you may specify another field to compare against the date:
'finish_date' => 'required|date|after:start_date'
after_or_equal:date
The field under validation must be a value after or equal to the given date. For more information, see the after rule.
alpha
The field under validation must be entirely Unicode alphabetic characters contained in \p{L}
and \p{M}
.
To restrict this validation rule to characters in the ASCII range (a-z
and A-Z
), you may provide the ascii
option to the validation rule:
'username' => 'alpha:ascii',
alpha_dash
The field under validation must be entirely Unicode alpha-numeric characters contained in \p{L}
, \p{M}
, \p{N}
, as well as ASCII dashes (-
) and ASCII underscores (_
).
To restrict this validation rule to characters in the ASCII range (a-z
and A-Z
), you may provide the ascii
option to the validation rule:
'username' => 'alpha_dash:ascii',
alpha_num
The field under validation must be entirely Unicode alpha-numeric characters contained in \p{L}
, \p{M}
, and \p{N}
.
To restrict this validation rule to characters in the ASCII range (a-z
and A-Z
), you may provide the ascii
option to the validation rule:
'username' => 'alpha_num:ascii',
array
The field under validation must be a PHP array
.
When additional values are provided to the array
rule, each key in the input array must be present within the list of values provided to the rule. In the following example, the admin
key in the input array is invalid since it is not contained in the list of values provided to the array
rule:
use Illuminate\Support\Facades\Validator;
$input = [
'user' => [
'name' => 'Taylor Otwell',
'username' => 'taylorotwell',
'admin' => true,
],
];
Validator::make($input, [
'user' => 'array:name,username',
]);
In general, you should always specify the array keys that are allowed to be present within your array.
ascii
The field under validation must be entirely 7-bit ASCII characters.
bail
Stop running validation rules for the field after the first validation failure.
While the bail
rule will only stop validating a specific field when it encounters a validation failure, the stopOnFirstFailure
method will inform the validator that it should stop validating all attributes once a single validation failure has occurred:
if ($validator->stopOnFirstFailure()->fails()) {
// ...
}
before:date
The field under validation must be a value preceding the given date. The dates will be passed into the PHP strtotime
function in order to be converted into a valid DateTime
instance. In addition, like the after
rule, the name of another field under validation may be supplied as the value of date
.
before_or_equal:date
The field under validation must be a value preceding or equal to the given date. The dates will be passed into the PHP strtotime
function in order to be converted into a valid DateTime
instance. In addition, like the after
rule, the name of another field under validation may be supplied as the value of date
.
between:min,max
The field under validation must have a size between the given min and max (inclusive). Strings, numerics, arrays, and files are evaluated in the same fashion as the size
rule.
boolean
The field under validation must be able to be cast as a boolean. Accepted input are true
, false
, 1
, 0
, "1"
, and "0"
.
confirmed
The field under validation must have a matching field of {field}_confirmation
. For example, if the field under validation is password
, a matching password_confirmation
field must be present in the input.
current_password
The field under validation must match the authenticated user’s password. You may specify an authentication guard using the rule’s first parameter:
'password' => 'current_password:api'
date
The field under validation must be a valid, non-relative date according to the strtotime
PHP function.
date_equals:date
The field under validation must be equal to the given date. The dates will be passed into the PHP strtotime
function in order to be converted into a valid DateTime
instance.
date_format:format,…
The field under validation must match one of the given formats. You should use either date
or date_format
when validating a field, not both. This validation rule supports all formats supported by PHP’s DateTime class.
decimal:min,max
The field under validation must be numeric and must contain the specified number of decimal places:
// Must have exactly two decimal places (9.99)...
'price' => 'decimal:2'
// Must have between 2 and 4 decimal places...
'price' => 'decimal:2,4'
declined
The field under validation must be "no"
, "off"
, 0
, or false
.
declined_if:anotherfield,value,…
The field under validation must be "no"
, "off"
, 0
, or false
if another field under validation is equal to a specified value.
different:field
The field under validation must have a different value than field.
digits:value
The integer under validation must have an exact length of value.
digits_between:min,max
The integer validation must have a length between the given min and max.
dimensions
The file under validation must be an image meeting the dimension constraints as specified by the rule’s parameters:
'avatar' => 'dimensions:min_width=100,min_height=200'
Available constraints are: min_width, max_width, min_height, max_height, width, height, ratio.
A ratio constraint should be represented as width divided by height. This can be specified either by a fraction like 3/2
or a float like 1.5
:
'avatar' => 'dimensions:ratio=3/2'
Since this rule requires several arguments, you may use the Rule::dimensions
method to fluently construct the rule:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'avatar' => [
'required',
Rule::dimensions()->maxWidth(1000)->maxHeight(500)->ratio(3 / 2),
],
]);
distinct
When validating arrays, the field under validation must not have any duplicate values:
'foo.*.id' => 'distinct'
Distinct uses loose variable comparisons by default. To use strict comparisons, you may add the strict
parameter to your validation rule definition:
'foo.*.id' => 'distinct:strict'
You may add ignore_case
to the validation rule’s arguments to make the rule ignore capitalization differences:
'foo.*.id' => 'distinct:ignore_case'
doesnt_start_with:foo,bar,…
The field under validation must not start with one of the given values.
doesnt_end_with:foo,bar,…
The field under validation must not end with one of the given values.
The field under validation must be formatted as an email address. This validation rule utilizes the egulias/email-validator
package for validating the email address. By default, the RFCValidation
validator is applied, but you can apply other validation styles as well:
'email' => 'email:rfc,dns'
The example above will apply the RFCValidation
and DNSCheckValidation
validations. Here’s a full list of validation styles you can apply:
-
rfc
:RFCValidation
-
strict
:NoRFCWarningsValidation
-
dns
:DNSCheckValidation
-
spoof
:SpoofCheckValidation
-
filter
:FilterEmailValidation
-
filter_unicode
:FilterEmailValidation::unicode()
The filter
validator, which uses PHP’s filter_var
function, ships with Laravel and was Laravel’s default email validation behavior prior to Laravel version 5.8.
Warning
Thedns
andspoof
validators require the PHPintl
extension.
ends_with:foo,bar,…
The field under validation must end with one of the given values.
enum
The Enum
rule is a class based rule that validates whether the field under validation contains a valid enum value. The Enum
rule accepts the name of the enum as its only constructor argument:
use App\Enums\ServerStatus;
use Illuminate\Validation\Rules\Enum;
$request->validate([
'status' => [new Enum(ServerStatus::class)],
]);
exclude
The field under validation will be excluded from the request data returned by the validate
and validated
methods.
exclude_if:anotherfield,value
The field under validation will be excluded from the request data returned by the validate
and validated
methods if the anotherfield field is equal to value.
If complex conditional exclusion logic is required, you may utilize the Rule::excludeIf
method. This method accepts a boolean or a closure. When given a closure, the closure should return true
or false
to indicate if the field under validation should be excluded:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($request->all(), [
'role_id' => Rule::excludeIf($request->user()->is_admin),
]);
Validator::make($request->all(), [
'role_id' => Rule::excludeIf(fn () => $request->user()->is_admin),
]);
exclude_unless:anotherfield,value
The field under validation will be excluded from the request data returned by the validate
and validated
methods unless anotherfield‘s field is equal to value. If value is null
(exclude_unless:name,null
), the field under validation will be excluded unless the comparison field is null
or the comparison field is missing from the request data.
exclude_with:anotherfield
The field under validation will be excluded from the request data returned by the validate
and validated
methods if the anotherfield field is present.
exclude_without:anotherfield
The field under validation will be excluded from the request data returned by the validate
and validated
methods if the anotherfield field is not present.
exists:table,column
The field under validation must exist in a given database table.
Basic Usage Of Exists Rule
'state' => 'exists:states'
If the column
option is not specified, the field name will be used. So, in this case, the rule will validate that the states
database table contains a record with a state
column value matching the request’s state
attribute value.
Specifying A Custom Column Name
You may explicitly specify the database column name that should be used by the validation rule by placing it after the database table name:
'state' => 'exists:states,abbreviation'
Occasionally, you may need to specify a specific database connection to be used for the exists
query. You can accomplish this by prepending the connection name to the table name:
'email' => 'exists:connection.staff,email'
Instead of specifying the table name directly, you may specify the Eloquent model which should be used to determine the table name:
'user_id' => 'exists:App\Models\User,id'
If you would like to customize the query executed by the validation rule, you may use the Rule
class to fluently define the rule. In this example, we’ll also specify the validation rules as an array instead of using the |
character to delimit them:
use Illuminate\Database\Query\Builder;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'email' => [
'required',
Rule::exists('staff')->where(function (Builder $query) {
return $query->where('account_id', 1);
}),
],
]);
You may explicitly specify the database column name that should be used by the exists
rule generated by the Rule::exists
method by providing the column name as the second argument to the exists
method:
'state' => Rule::exists('states', 'abbreviation'),
file
The field under validation must be a successfully uploaded file.
filled
The field under validation must not be empty when it is present.
gt:field
The field under validation must be greater than the given field or value. The two fields must be of the same type. Strings, numerics, arrays, and files are evaluated using the same conventions as the size
rule.
gte:field
The field under validation must be greater than or equal to the given field or value. The two fields must be of the same type. Strings, numerics, arrays, and files are evaluated using the same conventions as the size
rule.
image
The file under validation must be an image (jpg, jpeg, png, bmp, gif, svg, or webp).
in:foo,bar,…
The field under validation must be included in the given list of values. Since this rule often requires you to implode
an array, the Rule::in
method may be used to fluently construct the rule:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'zones' => [
'required',
Rule::in(['first-zone', 'second-zone']),
],
]);
When the in
rule is combined with the array
rule, each value in the input array must be present within the list of values provided to the in
rule. In the following example, the LAS
airport code in the input array is invalid since it is not contained in the list of airports provided to the in
rule:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
$input = [
'airports' => ['NYC', 'LAS'],
];
Validator::make($input, [
'airports' => [
'required',
'array',
],
'airports.*' => Rule::in(['NYC', 'LIT']),
]);
in_array:anotherfield.*
The field under validation must exist in anotherfield‘s values.
integer
The field under validation must be an integer.
Warning
This validation rule does not verify that the input is of the «integer» variable type, only that the input is of a type accepted by PHP’sFILTER_VALIDATE_INT
rule. If you need to validate the input as being a number please use this rule in combination with thenumeric
validation rule.
ip
The field under validation must be an IP address.
ipv4
The field under validation must be an IPv4 address.
ipv6
The field under validation must be an IPv6 address.
json
The field under validation must be a valid JSON string.
lt:field
The field under validation must be less than the given field. The two fields must be of the same type. Strings, numerics, arrays, and files are evaluated using the same conventions as the size
rule.
lte:field
The field under validation must be less than or equal to the given field. The two fields must be of the same type. Strings, numerics, arrays, and files are evaluated using the same conventions as the size
rule.
lowercase
The field under validation must be lowercase.
mac_address
The field under validation must be a MAC address.
max:value
The field under validation must be less than or equal to a maximum value. Strings, numerics, arrays, and files are evaluated in the same fashion as the size
rule.
max_digits:value
The integer under validation must have a maximum length of value.
mimetypes:text/plain,…
The file under validation must match one of the given MIME types:
'video' => 'mimetypes:video/avi,video/mpeg,video/quicktime'
To determine the MIME type of the uploaded file, the file’s contents will be read and the framework will attempt to guess the MIME type, which may be different from the client’s provided MIME type.
mimes:foo,bar,…
The file under validation must have a MIME type corresponding to one of the listed extensions.
Basic Usage Of MIME Rule
'photo' => 'mimes:jpg,bmp,png'
Even though you only need to specify the extensions, this rule actually validates the MIME type of the file by reading the file’s contents and guessing its MIME type. A full listing of MIME types and their corresponding extensions may be found at the following location:
https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
min:value
The field under validation must have a minimum value. Strings, numerics, arrays, and files are evaluated in the same fashion as the size
rule.
min_digits:value
The integer under validation must have a minimum length of value.
multiple_of:value
The field under validation must be a multiple of value.
missing
The field under validation must not be present in the input data.
missing_if:anotherfield,value,…
The field under validation must not be present if the anotherfield field is equal to any value.
missing_unless:anotherfield,value
The field under validation must not be present unless the anotherfield field is equal to any value.
missing_with:foo,bar,…
The field under validation must not be present only if any of the other specified fields are present.
missing_with_all:foo,bar,…
The field under validation must not be present only if all of the other specified fields are present.
not_in:foo,bar,…
The field under validation must not be included in the given list of values. The Rule::notIn
method may be used to fluently construct the rule:
use Illuminate\Validation\Rule;
Validator::make($data, [
'toppings' => [
'required',
Rule::notIn(['sprinkles', 'cherries']),
],
]);
not_regex:pattern
The field under validation must not match the given regular expression.
Internally, this rule uses the PHP preg_match
function. The pattern specified should obey the same formatting required by preg_match
and thus also include valid delimiters. For example: 'email' => 'not_regex:/^.+$/i'
.
Warning
When using theregex
/not_regex
patterns, it may be necessary to specify your validation rules using an array instead of using|
delimiters, especially if the regular expression contains a|
character.
nullable
The field under validation may be null
.
numeric
The field under validation must be numeric.
password
The field under validation must match the authenticated user’s password.
Warning
This rule was renamed tocurrent_password
with the intention of removing it in Laravel 9. Please use the Current Password rule instead.
present
The field under validation must exist in the input data.
prohibited
The field under validation must be missing or empty. A field is «empty» if it meets one of the following criteria:
- The value is
null
. - The value is an empty string.
- The value is an empty array or empty
Countable
object. - The value is an uploaded file with an empty path.
prohibited_if:anotherfield,value,…
The field under validation must be missing or empty if the anotherfield field is equal to any value. A field is «empty» if it meets one of the following criteria:
- The value is
null
. - The value is an empty string.
- The value is an empty array or empty
Countable
object. - The value is an uploaded file with an empty path.
If complex conditional prohibition logic is required, you may utilize the Rule::prohibitedIf
method. This method accepts a boolean or a closure. When given a closure, the closure should return true
or false
to indicate if the field under validation should be prohibited:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($request->all(), [
'role_id' => Rule::prohibitedIf($request->user()->is_admin),
]);
Validator::make($request->all(), [
'role_id' => Rule::prohibitedIf(fn () => $request->user()->is_admin),
]);
prohibited_unless:anotherfield,value,…
The field under validation must be missing or empty unless the anotherfield field is equal to any value. A field is «empty» if it meets one of the following criteria:
- The value is
null
. - The value is an empty string.
- The value is an empty array or empty
Countable
object. - The value is an uploaded file with an empty path.
prohibits:anotherfield,…
If the field under validation is not missing or empty, all fields in anotherfield must be missing or empty. A field is «empty» if it meets one of the following criteria:
- The value is
null
. - The value is an empty string.
- The value is an empty array or empty
Countable
object. - The value is an uploaded file with an empty path.
regex:pattern
The field under validation must match the given regular expression.
Internally, this rule uses the PHP preg_match
function. The pattern specified should obey the same formatting required by preg_match
and thus also include valid delimiters. For example: 'email' => 'regex:/^.+@.+$/i'
.
Warning
When using theregex
/not_regex
patterns, it may be necessary to specify rules in an array instead of using|
delimiters, especially if the regular expression contains a|
character.
required
The field under validation must be present in the input data and not empty. A field is «empty» if it meets one of the following criteria:
- The value is
null
. - The value is an empty string.
- The value is an empty array or empty
Countable
object. - The value is an uploaded file with no path.
required_if:anotherfield,value,…
The field under validation must be present and not empty if the anotherfield field is equal to any value.
If you would like to construct a more complex condition for the required_if
rule, you may use the Rule::requiredIf
method. This method accepts a boolean or a closure. When passed a closure, the closure should return true
or false
to indicate if the field under validation is required:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($request->all(), [
'role_id' => Rule::requiredIf($request->user()->is_admin),
]);
Validator::make($request->all(), [
'role_id' => Rule::requiredIf(fn () => $request->user()->is_admin),
]);
required_unless:anotherfield,value,…
The field under validation must be present and not empty unless the anotherfield field is equal to any value. This also means anotherfield must be present in the request data unless value is null
. If value is null
(required_unless:name,null
), the field under validation will be required unless the comparison field is null
or the comparison field is missing from the request data.
required_with:foo,bar,…
The field under validation must be present and not empty only if any of the other specified fields are present and not empty.
required_with_all:foo,bar,…
The field under validation must be present and not empty only if all of the other specified fields are present and not empty.
required_without:foo,bar,…
The field under validation must be present and not empty only when any of the other specified fields are empty or not present.
required_without_all:foo,bar,…
The field under validation must be present and not empty only when all of the other specified fields are empty or not present.
required_array_keys:foo,bar,…
The field under validation must be an array and must contain at least the specified keys.
same:field
The given field must match the field under validation.
size:value
The field under validation must have a size matching the given value. For string data, value corresponds to the number of characters. For numeric data, value corresponds to a given integer value (the attribute must also have the numeric
or integer
rule). For an array, size corresponds to the count
of the array. For files, size corresponds to the file size in kilobytes. Let’s look at some examples:
// Validate that a string is exactly 12 characters long...
'title' => 'size:12';
// Validate that a provided integer equals 10...
'seats' => 'integer|size:10';
// Validate that an array has exactly 5 elements...
'tags' => 'array|size:5';
// Validate that an uploaded file is exactly 512 kilobytes...
'image' => 'file|size:512';
starts_with:foo,bar,…
The field under validation must start with one of the given values.
string
The field under validation must be a string. If you would like to allow the field to also be null
, you should assign the nullable
rule to the field.
timezone
The field under validation must be a valid timezone identifier according to the DateTimeZone::listIdentifiers
method.
The arguments accepted by the DateTimeZone::listIdentifiers
method may also be provided to this validation rule:
'timezone' => 'required|timezone:all';
'timezone' => 'required|timezone:Africa';
'timezone' => 'required|timezone:per_country,US';
unique:table,column
The field under validation must not exist within the given database table.
Specifying A Custom Table / Column Name:
Instead of specifying the table name directly, you may specify the Eloquent model which should be used to determine the table name:
'email' => 'unique:App\Models\User,email_address'
The column
option may be used to specify the field’s corresponding database column. If the column
option is not specified, the name of the field under validation will be used.
'email' => 'unique:users,email_address'
Specifying A Custom Database Connection
Occasionally, you may need to set a custom connection for database queries made by the Validator. To accomplish this, you may prepend the connection name to the table name:
'email' => 'unique:connection.users,email_address'
Forcing A Unique Rule To Ignore A Given ID:
Sometimes, you may wish to ignore a given ID during unique validation. For example, consider an «update profile» screen that includes the user’s name, email address, and location. You will probably want to verify that the email address is unique. However, if the user only changes the name field and not the email field, you do not want a validation error to be thrown because the user is already the owner of the email address in question.
To instruct the validator to ignore the user’s ID, we’ll use the Rule
class to fluently define the rule. In this example, we’ll also specify the validation rules as an array instead of using the |
character to delimit the rules:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
Validator::make($data, [
'email' => [
'required',
Rule::unique('users')->ignore($user->id),
],
]);
Warning
You should never pass any user controlled request input into theignore
method. Instead, you should only pass a system generated unique ID such as an auto-incrementing ID or UUID from an Eloquent model instance. Otherwise, your application will be vulnerable to an SQL injection attack.
Instead of passing the model key’s value to the ignore
method, you may also pass the entire model instance. Laravel will automatically extract the key from the model:
Rule::unique('users')->ignore($user)
If your table uses a primary key column name other than id
, you may specify the name of the column when calling the ignore
method:
Rule::unique('users')->ignore($user->id, 'user_id')
By default, the unique
rule will check the uniqueness of the column matching the name of the attribute being validated. However, you may pass a different column name as the second argument to the unique
method:
Rule::unique('users', 'email_address')->ignore($user->id)
Adding Additional Where Clauses:
You may specify additional query conditions by customizing the query using the where
method. For example, let’s add a query condition that scopes the query to only search records that have an account_id
column value of 1
:
'email' => Rule::unique('users')->where(fn (Builder $query) => $query->where('account_id', 1))
uppercase
The field under validation must be uppercase.
url
The field under validation must be a valid URL.
If you would like to specify the URL protocols that should be considered valid, you may pass the protocols as validation rule parameters:
'url' => 'url:http,https',
'game' => 'url:minecraft,steam',
ulid
The field under validation must be a valid Universally Unique Lexicographically Sortable Identifier (ULID).
uuid
The field under validation must be a valid RFC 4122 (version 1, 3, 4, or 5) universally unique identifier (UUID).
Conditionally Adding Rules
Skipping Validation When Fields Have Certain Values
You may occasionally wish to not validate a given field if another field has a given value. You may accomplish this using the exclude_if
validation rule. In this example, the appointment_date
and doctor_name
fields will not be validated if the has_appointment
field has a value of false
:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($data, [
'has_appointment' => 'required|boolean',
'appointment_date' => 'exclude_if:has_appointment,false|required|date',
'doctor_name' => 'exclude_if:has_appointment,false|required|string',
]);
Alternatively, you may use the exclude_unless
rule to not validate a given field unless another field has a given value:
$validator = Validator::make($data, [
'has_appointment' => 'required|boolean',
'appointment_date' => 'exclude_unless:has_appointment,true|required|date',
'doctor_name' => 'exclude_unless:has_appointment,true|required|string',
]);
Validating When Present
In some situations, you may wish to run validation checks against a field only if that field is present in the data being validated. To quickly accomplish this, add the sometimes
rule to your rule list:
$v = Validator::make($data, [
'email' => 'sometimes|required|email',
]);
In the example above, the email
field will only be validated if it is present in the $data
array.
Note
If you are attempting to validate a field that should always be present but may be empty, check out this note on optional fields.
Complex Conditional Validation
Sometimes you may wish to add validation rules based on more complex conditional logic. For example, you may wish to require a given field only if another field has a greater value than 100. Or, you may need two fields to have a given value only when another field is present. Adding these validation rules doesn’t have to be a pain. First, create a Validator
instance with your static rules that never change:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($request->all(), [
'email' => 'required|email',
'games' => 'required|numeric',
]);
Let’s assume our web application is for game collectors. If a game collector registers with our application and they own more than 100 games, we want them to explain why they own so many games. For example, perhaps they run a game resale shop, or maybe they just enjoy collecting games. To conditionally add this requirement, we can use the sometimes
method on the Validator
instance.
use Illuminate\Support\Fluent;
$validator->sometimes('reason', 'required|max:500', function (Fluent $input) {
return $input->games >= 100;
});
The first argument passed to the sometimes
method is the name of the field we are conditionally validating. The second argument is a list of the rules we want to add. If the closure passed as the third argument returns true
, the rules will be added. This method makes it a breeze to build complex conditional validations. You may even add conditional validations for several fields at once:
$validator->sometimes(['reason', 'cost'], 'required', function (Fluent $input) {
return $input->games >= 100;
});
Note
The$input
parameter passed to your closure will be an instance ofIlluminate\Support\Fluent
and may be used to access your input and files under validation.
Complex Conditional Array Validation
Sometimes you may want to validate a field based on another field in the same nested array whose index you do not know. In these situations, you may allow your closure to receive a second argument which will be the current individual item in the array being validated:
$input = [
'channels' => [
[
'type' => 'email',
'address' => '[email protected]',
],
[
'type' => 'url',
'address' => 'https://example.com',
],
],
];
$validator->sometimes('channels.*.address', 'email', function (Fluent $input, Fluent $item) {
return $item->type === 'email';
});
$validator->sometimes('channels.*.address', 'url', function (Fluent $input, Fluent $item) {
return $item->type !== 'email';
});
Like the $input
parameter passed to the closure, the $item
parameter is an instance of Illuminate\Support\Fluent
when the attribute data is an array; otherwise, it is a string.
Validating Arrays
As discussed in the array
validation rule documentation, the array
rule accepts a list of allowed array keys. If any additional keys are present within the array, validation will fail:
use Illuminate\Support\Facades\Validator;
$input = [
'user' => [
'name' => 'Taylor Otwell',
'username' => 'taylorotwell',
'admin' => true,
],
];
Validator::make($input, [
'user' => 'array:name,username',
]);
In general, you should always specify the array keys that are allowed to be present within your array. Otherwise, the validator’s validate
and validated
methods will return all of the validated data, including the array and all of its keys, even if those keys were not validated by other nested array validation rules.
Validating Nested Array Input
Validating nested array based form input fields doesn’t have to be a pain. You may use «dot notation» to validate attributes within an array. For example, if the incoming HTTP request contains a photos[profile]
field, you may validate it like so:
use Illuminate\Support\Facades\Validator;
$validator = Validator::make($request->all(), [
'photos.profile' => 'required|image',
]);
You may also validate each element of an array. For example, to validate that each email in a given array input field is unique, you may do the following:
$validator = Validator::make($request->all(), [
'person.*.email' => 'email|unique:users',
'person.*.first_name' => 'required_with:person.*.last_name',
]);
Likewise, you may use the *
character when specifying custom validation messages in your language files, making it a breeze to use a single validation message for array based fields:
'custom' => [
'person.*.email' => [
'unique' => 'Each person must have a unique email address',
]
],
Accessing Nested Array Data
Sometimes you may need to access the value for a given nested array element when assigning validation rules to the attribute. You may accomplish this using the Rule::forEach
method. The forEach
method accepts a closure that will be invoked for each iteration of the array attribute under validation and will receive the attribute’s value and explicit, fully-expanded attribute name. The closure should return an array of rules to assign to the array element:
use App\Rules\HasPermission;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
$validator = Validator::make($request->all(), [
'companies.*.id' => Rule::forEach(function (string|null $value, string $attribute) {
return [
Rule::exists(Company::class, 'id'),
new HasPermission('manage-company', $value),
];
}),
]);
Error Message Indexes & Positions
When validating arrays, you may want to reference the index or position of a particular item that failed validation within the error message displayed by your application. To accomplish this, you may include the :index
(starts from 0
) and :position
(starts from 1
) placeholders within your custom validation message:
use Illuminate\Support\Facades\Validator;
$input = [
'photos' => [
[
'name' => 'BeachVacation.jpg',
'description' => 'A photo of my beach vacation!',
],
[
'name' => 'GrandCanyon.jpg',
'description' => '',
],
],
];
Validator::validate($input, [
'photos.*.description' => 'required',
], [
'photos.*.description.required' => 'Please describe photo #:position.',
]);
Given the example above, validation will fail and the user will be presented with the following error of «Please describe photo #2.»
If necessary, you may reference more deeply nested indexes and positions via second-index
, second-position
, third-index
, third-position
, etc.
'photos.*.attributes.*.string' => 'Invalid attribute for photo #:second-position.',
Validating Files
Laravel provides a variety of validation rules that may be used to validate uploaded files, such as mimes
, image
, min
, and max
. While you are free to specify these rules individually when validating files, Laravel also offers a fluent file validation rule builder that you may find convenient:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\File;
Validator::validate($input, [
'attachment' => [
'required',
File::types(['mp3', 'wav'])
->min(1024)
->max(12 * 1024),
],
]);
If your application accepts images uploaded by your users, you may use the File
rule’s image
constructor method to indicate that the uploaded file should be an image. In addition, the dimensions
rule may be used to limit the dimensions of the image:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\File;
Validator::validate($input, [
'photo' => [
'required',
File::image()
->min(1024)
->max(12 * 1024)
->dimensions(Rule::dimensions()->maxWidth(1000)->maxHeight(500)),
],
]);
Note
More information regarding validating image dimensions may be found in the dimension rule documentation.
File Sizes
For convenience, minimum and maximum file sizes may be specified as a string with a suffix indicating the file size units. The kb
, mb
, gb
, and tb
suffixes are supported:
File::image()
->min('1kb')
->max('10mb')
File Types
Even though you only need to specify the extensions when invoking the types
method, this method actually validates the MIME type of the file by reading the file’s contents and guessing its MIME type. A full listing of MIME types and their corresponding extensions may be found at the following location:
https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
Validating Passwords
To ensure that passwords have an adequate level of complexity, you may use Laravel’s Password
rule object:
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\Password;
$validator = Validator::make($request->all(), [
'password' => ['required', 'confirmed', Password::min(8)],
]);
The Password
rule object allows you to easily customize the password complexity requirements for your application, such as specifying that passwords require at least one letter, number, symbol, or characters with mixed casing:
// Require at least 8 characters...
Password::min(8)
// Require at least one letter...
Password::min(8)->letters()
// Require at least one uppercase and one lowercase letter...
Password::min(8)->mixedCase()
// Require at least one number...
Password::min(8)->numbers()
// Require at least one symbol...
Password::min(8)->symbols()
In addition, you may ensure that a password has not been compromised in a public password data breach leak using the uncompromised
method:
Password::min(8)->uncompromised()
Internally, the Password
rule object uses the k-Anonymity model to determine if a password has been leaked via the haveibeenpwned.com service without sacrificing the user’s privacy or security.
By default, if a password appears at least once in a data leak, it will be considered compromised. You can customize this threshold using the first argument of the uncompromised
method:
// Ensure the password appears less than 3 times in the same data leak...
Password::min(8)->uncompromised(3);
Of course, you may chain all the methods in the examples above:
Password::min(8)
->letters()
->mixedCase()
->numbers()
->symbols()
->uncompromised()
Defining Default Password Rules
You may find it convenient to specify the default validation rules for passwords in a single location of your application. You can easily accomplish this using the Password::defaults
method, which accepts a closure. The closure given to the defaults
method should return the default configuration of the Password rule. Typically, the defaults
rule should be called within the boot
method of one of your application’s service providers:
use Illuminate\Validation\Rules\Password;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Password::defaults(function () {
$rule = Password::min(8);
return $this->app->isProduction()
? $rule->mixedCase()->uncompromised()
: $rule;
});
}
Then, when you would like to apply the default rules to a particular password undergoing validation, you may invoke the defaults
method with no arguments:
'password' => ['required', Password::defaults()],
Occasionally, you may want to attach additional validation rules to your default password validation rules. You may use the rules
method to accomplish this:
use App\Rules\ZxcvbnRule;
Password::defaults(function () {
$rule = Password::min(8)->rules([new ZxcvbnRule]);
// ...
});
Custom Validation Rules
Using Rule Objects
Laravel provides a variety of helpful validation rules; however, you may wish to specify some of your own. One method of registering custom validation rules is using rule objects. To generate a new rule object, you may use the make:rule
Artisan command. Let’s use this command to generate a rule that verifies a string is uppercase. Laravel will place the new rule in the app/Rules
directory. If this directory does not exist, Laravel will create it when you execute the Artisan command to create your rule:
php artisan make:rule Uppercase
Once the rule has been created, we are ready to define its behavior. A rule object contains a single method: validate
. This method receives the attribute name, its value, and a callback that should be invoked on failure with the validation error message:
<?php
namespace App\Rules;
use Closure;
use Illuminate\Contracts\Validation\ValidationRule;
class Uppercase implements ValidationRule
{
/**
* Run the validation rule.
*/
public function validate(string $attribute, mixed $value, Closure $fail): void
{
if (strtoupper($value) !== $value) {
$fail('The :attribute must be uppercase.');
}
}
}
Once the rule has been defined, you may attach it to a validator by passing an instance of the rule object with your other validation rules:
use App\Rules\Uppercase;
$request->validate([
'name' => ['required', 'string', new Uppercase],
]);
Translating Validation Messages
Instead of providing a literal error message to the $fail
closure, you may also provide a translation string key and instruct Laravel to translate the error message:
if (strtoupper($value) !== $value) {
$fail('validation.uppercase')->translate();
}
If necessary, you may provide placeholder replacements and the preferred language as the first and second arguments to the translate
method:
$fail('validation.location')->translate([
'value' => $this->value,
], 'fr')
Accessing Additional Data
If your custom validation rule class needs to access all of the other data undergoing validation, your rule class may implement the Illuminate\Contracts\Validation\DataAwareRule
interface. This interface requires your class to define a setData
method. This method will automatically be invoked by Laravel (before validation proceeds) with all of the data under validation:
<?php
namespace App\Rules;
use Illuminate\Contracts\Validation\DataAwareRule;
use Illuminate\Contracts\Validation\ValidationRule;
class Uppercase implements DataAwareRule, ValidationRule
{
/**
* All of the data under validation.
*
* @var array<string, mixed>
*/
protected $data = [];
// ...
/**
* Set the data under validation.
*
* @param array<string, mixed> $data
*/
public function setData(array $data): static
{
$this->data = $data;
return $this;
}
}
Or, if your validation rule requires access to the validator instance performing the validation, you may implement the ValidatorAwareRule
interface:
<?php
namespace App\Rules;
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Contracts\Validation\ValidatorAwareRule;
use Illuminate\Validation\Validator;
class Uppercase implements ValidationRule, ValidatorAwareRule
{
/**
* The validator instance.
*
* @var \Illuminate\Validation\Validator
*/
protected $validator;
// ...
/**
* Set the current validator.
*/
public function setValidator(Validator $validator): static
{
$this->validator = $validator;
return $this;
}
}
Using Closures
If you only need the functionality of a custom rule once throughout your application, you may use a closure instead of a rule object. The closure receives the attribute’s name, the attribute’s value, and a $fail
callback that should be called if validation fails:
use Illuminate\Support\Facades\Validator;
use Closure;
$validator = Validator::make($request->all(), [
'title' => [
'required',
'max:255',
function (string $attribute, mixed $value, Closure $fail) {
if ($value === 'foo') {
$fail("The {$attribute} is invalid.");
}
},
],
]);
Implicit Rules
By default, when an attribute being validated is not present or contains an empty string, normal validation rules, including custom rules, are not run. For example, the unique
rule will not be run against an empty string:
use Illuminate\Support\Facades\Validator;
$rules = ['name' => 'unique:users,name'];
$input = ['name' => ''];
Validator::make($input, $rules)->passes(); // true
For a custom rule to run even when an attribute is empty, the rule must imply that the attribute is required. To quickly generate a new implicit rule object, you may use the make:rule
Artisan command with the --implicit
option:
php artisan make:rule Uppercase --implicit
Warning
An «implicit» rule only implies that the attribute is required. Whether it actually invalidates a missing or empty attribute is up to you.
Вступление
Laravel предлагает несколько разных подходов для проверки входящих данных вашего приложения. По умолчанию базовый класс контроллера Laravel использует ValidatesRequests
черту, которая предоставляет удобный метод для проверки входящего HTTP-запроса с помощью множества мощных правил проверки.
Валидация Быстрый старт
Чтобы узнать о мощных функциях проверки Laravel, давайте рассмотрим полный пример проверки формы и отображения сообщений об ошибках пользователю.
Определение маршрутов
Сначала предположим, что в нашем файле определены следующие маршруты :routes/web.php
Route::get('post/create', 'PostController@create');
Route::post('post', 'PostController@store');
GET
Маршрут будет отображать форму для пользователя , чтобы создать новое сообщение в блоге, в то время как POST
маршрут будет хранить запись в блоге в базе данных.
Создание контроллера
Далее, давайте посмотрим на простой контроллер, который обрабатывает эти маршруты. Мы store
пока оставим метод пустым:
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
class PostController extends Controller
{
/**
* Show the form to create a new blog post.
*
* @return Response
*/
public function create()
{
return view('post.create');
}
/**
* Store a new blog post.
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
// Validate and store the blog post...
}
}
Написание логики валидации
Теперь мы готовы заполнить наш store
метод логикой для проверки нового сообщения в блоге. Для этого мы будем использовать validate
метод, предоставленный объектом. Если правила проверки пройдут, ваш код будет работать нормально; однако, если проверка не пройдена, будет выдано исключение, и правильный ответ об ошибке будет автоматически отправлен обратно пользователю. В случае традиционного HTTP-запроса будет сгенерирован ответ о перенаправлении, а JSON-ответ будет отправлен для AJAX-запросов.Illuminate\Http\Request
Чтобы лучше понять validate
метод, давайте вернемся к store
методу:
/**
* Store a new blog post.
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$validatedData = $request->validate([
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
// The blog post is valid...
}
Как видите, мы передаем в метод нужные правила валидации validate
. Опять же, если проверка не пройдена, автоматически генерируется правильный ответ. Если проверка пройдена, наш контроллер продолжит нормально работать.
Остановка при первом сбое проверки
Иногда может потребоваться прекратить запуск правил проверки для атрибута после первого сбоя проверки. Для этого присвойте bail
правило атрибуту:
$request->validate([
'title' => 'bail|required|unique:posts|max:255',
'body' => 'required',
]);
В этом примере, если unique
правило для title
атрибута не выполнено, max
правило не будет проверено. Правила будут утверждены в порядке их назначения.
Примечание о вложенных атрибутах
Если ваш HTTP-запрос содержит «вложенные» параметры, вы можете указать их в правилах проверки, используя синтаксис «точка»:
$request->validate([
'title' => 'required|unique:posts|max:255',
'author.name' => 'required',
'author.description' => 'required',
]);
Отображение ошибок валидации
Итак, что если параметры входящего запроса не соответствуют заданным правилам проверки? Как упоминалось ранее, Laravel автоматически перенаправит пользователя обратно на прежнее место. Кроме того, все ошибки проверки автоматически будут мигать в сеансе .
Опять же, обратите внимание, что нам не нужно было явно привязывать сообщения об ошибках к представлению нашего GET
маршрута. Это потому, что Laravel будет проверять ошибки в данных сеанса и автоматически связывать их с представлением, если они доступны. $errors
Переменная будет экземпляром . Для получения дополнительной информации о работе с этим объектом ознакомьтесь с его документацией .Illuminate\Support\MessageBag
$errors
Переменная связана с видом со стороны промежуточного программного обеспечения , которое обеспечивается в группе промежуточного программного обеспечения . Когда применяется это промежуточное программное обеспечение, переменная всегда будет доступна в ваших представлениях , что позволяет вам удобно предполагать, что переменная всегда определена и ее можно безопасно использовать.Illuminate\View\Middleware\ShareErrorsFromSession
web
$errors
$errors
Таким образом, в нашем примере пользователь будет перенаправлен на create
метод нашего контроллера при сбое проверки, что позволит нам отображать сообщения об ошибках в представлении:
<!-- /resources/views/post/create.blade.php -->
<h1>Create Post</h1>
@if ($errors->any())
<div class="alert alert-danger">
<ul>
@foreach ($errors->all() as $error)
<li>{{ $error }}</li>
@endforeach
</ul>
</div>
@endif
<!-- Create Post Form -->
@error
Директива
Вы также можете использовать директиву @error
Blade, чтобы быстро проверить, существуют ли сообщения об ошибках валидации для данного атрибута. Внутри @error
директивы вы можете вызвать $message
переменную для отображения сообщения об ошибке:
<!-- /resources/views/post/create.blade.php -->
<label for="title">Post Title</label>
<input id="title" type="text" class="@error('title') is-invalid @enderror">
@error('title')
<div class="alert alert-danger">{{ $message }}</div>
@enderror
Примечание о необязательных полях
По умолчанию Laravel включает TrimStrings
и ConvertEmptyStringsToNull
промежуточное ПО в глобальный стек промежуточного ПО вашего приложения. Эти промежуточные программы перечислены в стеке классом. Из-за этого вам часто нужно помечать ваши «необязательные» поля запроса так, как будто вы не хотите, чтобы валидатор считал значения недействительными. Например:App\Http\Kernel
nullable
null
$request->validate([
'title' => 'required|unique:posts|max:255',
'body' => 'required',
'publish_at' => 'nullable|date',
]);
В этом примере мы указываем, что publish_at
поле может быть либо null
действительным представлением даты. Если nullable
модификатор не добавлен в определение правила, валидатор будет считать null
недопустимую дату.
AJAX-запросы и валидация
В этом примере мы использовали традиционную форму для отправки данных в приложение. Однако многие приложения используют запросы AJAX. При использовании validate
метода во время запроса AJAX, Laravel не будет генерировать ответ перенаправления. Вместо этого Laravel генерирует ответ JSON, содержащий все ошибки проверки. Этот ответ JSON будет отправлен с кодом состояния 422 HTTP.
Проверка запроса формы
Создание запросов формы
Для более сложных сценариев проверки вы можете создать «запрос формы». Запросы форм — это пользовательские классы запросов, которые содержат логику проверки. Чтобы создать класс запроса формы, используйте команду Artisan CLI:make:request
php artisan make:request StoreBlogPost
Сгенерированный класс будет помещен в каталог. Если этот каталог не существует, он будет создан при запуске команды. Давайте добавим несколько правил проверки в метод:app/Http/Requests
make:request
rules
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
];
}
Вы можете напечатать любые зависимости, которые вам нужны, в
rules
сигнатуре метода. Они будут автоматически разрешены через сервисный контейнер Laravel .
Итак, как оцениваются правила валидации? Все, что вам нужно сделать, это напечатать запрос на метод вашего контроллера. Входящий запрос формы проверяется перед вызовом метода контроллера, что означает, что вам не нужно загромождать ваш контроллер какой-либо логикой проверки:
/**
* Store the incoming blog post.
*
* @param StoreBlogPost $request
* @return Response
*/
public function store(StoreBlogPost $request)
{
// The incoming request is valid...
// Retrieve the validated input data...
$validated = $request->validated();
}
Если проверка не пройдена, будет сгенерирован ответ о перенаправлении, чтобы отправить пользователя обратно в его предыдущее местоположение. Ошибки также будут мигать в сеансе, чтобы они были доступны для отображения. Если запрос был запросом AJAX, пользователю будет возвращен HTTP-ответ с кодом состояния 422, включая JSON-представление ошибок проверки.
Добавление после хуков для формирования запросов
Если вы хотите добавить хук «после» к запросу формы, вы можете использовать withValidator
метод. Этот метод получает полностью сконструированный валидатор, позволяющий вам вызвать любой из его методов до того, как правила валидации действительно будут оценены:
/**
* Configure the validator instance.
*
* @param \Illuminate\Validation\Validator $validator
* @return void
*/
public function withValidator($validator)
{
$validator->after(function ($validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add('field', 'Something is wrong with this field!');
}
});
}
Запросы формы авторизации
Класс запроса формы также содержит authorize
метод. В рамках этого метода вы можете проверить, действительно ли аутентифицированный пользователь имеет полномочия на обновление данного ресурса. Например, вы можете определить, действительно ли пользователю принадлежит комментарий в блоге, который он пытается обновить:
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
$comment = Comment::find($this->route('comment'));
return $comment && $this->user()->can('update', $comment);
}
Поскольку все запросы формы расширяют базовый класс запросов Laravel, мы можем использовать user
метод для доступа к аутентифицированному в настоящее время пользователю. Также обратите внимание на вызов route
метода в примере выше. Этот метод предоставляет вам доступ к параметрам URI, определенным на вызываемом маршруте, таким как параметр в примере ниже:{comment}
Route::post('comment/{comment}');
Если authorize
метод возвращается false
, HTTP-ответ с кодом состояния 403 будет автоматически возвращен, и ваш метод контроллера не будет выполнен.
Если вы планируете использовать логику авторизации в другой части вашего приложения, вернитесь true
из authorize
метода:
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
Вы можете напечатать любые зависимости, которые вам нужны, в
authorize
сигнатуре метода. Они будут автоматически разрешены через сервисный контейнер Laravel .
Настройка сообщений об ошибках
Вы можете настроить сообщения об ошибках, используемые запросом формы, переопределив messages
метод. Этот метод должен возвращать массив пар атрибут / правило и соответствующие им сообщения об ошибках:
/**
* Get the error messages for the defined validation rules.
*
* @return array
*/
public function messages()
{
return [
'title.required' => 'A title is required',
'body.required' => 'A message is required',
];
}
Настройка атрибутов проверки
Если вы хотите, чтобы :attribute
часть вашего сообщения проверки была заменена именем настраиваемого атрибута, вы можете указать настраиваемые имена, переопределив attributes
метод. Этот метод должен возвращать массив пар атрибут / имя:
/**
* Get custom attributes for validator errors.
*
* @return array
*/
public function attributes()
{
return [
'email' => 'email address',
];
}
Создание валидаторов вручную
Если вы не хотите использовать validate
метод в запросе, вы можете создать экземпляр валидатора вручную, используя Validator
фасад . make
Метод на фасаде создает новый экземпляр валидатора:
<?php
namespace App\Http\Controllers;
use Validator;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
class PostController extends Controller
{
/**
* Store a new blog post.
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$validator = Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
if ($validator->fails()) {
return redirect('post/create')
->withErrors($validator)
->withInput();
}
// Store the blog post...
}
}
Первым аргументом, переданным make
методу, являются проверяемые данные. Второй аргумент — это правила проверки, которые должны применяться к данным.
После проверки, не прошла ли проверка запроса, вы можете использовать этот withErrors
метод для отправки сообщений об ошибках в сеанс. При использовании этого метода $errors
переменная будет автоматически предоставлена вашим представлениям после перенаправления, что позволит вам легко отображать их обратно пользователю. withErrors
Метод принимает валидатор, а MessageBag
, или PHP array
.
Автоматическое перенаправление
Если вы хотите создать экземпляр валидатора вручную, но все же воспользоваться преимуществами автоматического перенаправления, предлагаемого методом запросов validate
, вы можете вызвать validate
метод в существующем экземпляре валидатора. Если проверка не пройдена, пользователь будет автоматически перенаправлен или, в случае запроса AJAX, будет возвращен ответ JSON:
Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
])->validate();
Именованные пакеты с ошибками
Если у вас есть несколько форм на одной странице, вы можете назвать имена MessageBag
ошибок, что позволит вам получать сообщения об ошибках для конкретной формы. Передайте имя в качестве второго аргумента withErrors
:
return redirect('register')
->withErrors($validator, 'login');
Затем вы можете получить доступ к именованному MessageBag
экземпляру из $errors
переменной:
{{ $errors->login->first('email') }}
После проверки крюк
Валидатор также позволяет вам добавлять обратные вызовы, которые будут выполняться после завершения проверки. Это позволяет вам легко выполнять дальнейшую проверку и даже добавлять больше сообщений об ошибках в коллекцию сообщений. Чтобы начать, используйте after
метод на экземпляре валидатора:
$validator = Validator::make(...);
$validator->after(function ($validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add('field', 'Something is wrong with this field!');
}
});
if ($validator->fails()) {
//
}
Работа с сообщениями об ошибках
После вызова errors
метода для Validator
экземпляра вы получите экземпляр, который имеет множество удобных методов для работы с сообщениями об ошибках. Переменная , которая автоматически становится доступной для всех представлений также является экземпляром класса.Illuminate\Support\MessageBag
$errors
MessageBag
Получение первого сообщения об ошибке для поля
Чтобы получить первое сообщение об ошибке для данного поля, используйте first
метод:
$errors = $validator->errors();
echo $errors->first('email');
Получение всех сообщений об ошибках для поля
Если вам нужно получить массив всех сообщений для данного поля, используйте get
метод:
foreach ($errors->get('email') as $message) {
//
}
Если вы проверяете поле формы массива, вы можете получить все сообщения для каждого из элементов массива, используя *
символ:
foreach ($errors->get('attachments.*') as $message) {
//
}
Получение всех сообщений об ошибках для всех полей
Чтобы получить массив всех сообщений для всех полей, используйте all
метод:
foreach ($errors->all() as $message) {
//
}
Определение наличия сообщений для поля
has
Метод может быть использован , чтобы определить , существуют ли какие — либо сообщения об ошибках для данного поля:
if ($errors->has('email')) {
//
}
Пользовательские сообщения об ошибках
При необходимости вы можете использовать пользовательские сообщения об ошибках для проверки вместо значений по умолчанию. Есть несколько способов указать пользовательские сообщения. Во-первых, вы можете передать пользовательские сообщения в качестве третьего аргумента методу:Validator::make
$messages = [
'required' => 'The :attribute field is required.',
];
$validator = Validator::make($input, $rules, $messages);
В этом примере :attribute
заполнитель будет заменен действительным именем проверяемого поля. Вы также можете использовать другие заполнители в сообщениях проверки. Например:
$messages = [
'same' => 'The :attribute and :other must match.',
'size' => 'The :attribute must be exactly :size.',
'between' => 'The :attribute value :input is not between :min - :max.',
'in' => 'The :attribute must be one of the following types: :values',
];
Указание пользовательского сообщения для данного атрибута
Иногда вам может потребоваться указать пользовательское сообщение об ошибке только для определенного поля. Вы можете сделать это, используя обозначение «точка». Сначала укажите имя атрибута, а затем правило:
$messages = [
'email.required' => 'We need to know your e-mail address!',
];
Указание пользовательских сообщений в языковых файлах
В большинстве случаев вы, вероятно, будете указывать свои пользовательские сообщения в языковом файле, а не передавать их непосредственно в Validator
. Для этого добавьте ваши сообщения в custom
массив в языковой файл.resources/lang/xx/validation.php
'custom' => [
'email' => [
'required' => 'We need to know your e-mail address!',
],
],
Указание пользовательских атрибутов в языковых файлах
Если вы хотите, чтобы :attribute
часть вашего сообщения проверки была заменена именем настраиваемого атрибута, вы можете указать это имя в attributes
массиве вашего языкового файла:resources/lang/xx/validation.php
'attributes' => [
'email' => 'email address',
],
Указание пользовательских значений в языковых файлах
Иногда вам может понадобиться :value
заменить часть вашего сообщения для проверки пользовательским представлением значения. Например, рассмотрим следующее правило, которое указывает, что номер кредитной карты требуется, если значение payment_type
имеет cc
:
$request->validate([
'credit_card_number' => 'required_if:payment_type,cc'
]);
Если это правило проверки не выполнено, оно выдаст следующее сообщение об ошибке:
The credit card number field is required when payment type is cc.
Вместо отображения cc
в качестве значения типа платежа вы можете указать представление пользовательского значения в вашем validation
языковом файле, определив values
массив:
'values' => [
'payment_type' => [
'cc' => 'credit card'
],
],
Теперь, если правило проверки не выполнено, оно выдаст следующее сообщение:
The credit card number field is required when payment type is credit card.
Доступные правила проверки
Ниже приведен список всех доступных правил проверки и их функции:
- Accepted
- Active URL
- After (Date)
- After Or Equal (Date)
- Alpha
- Alpha Dash
- Alpha Numeric
- Array
- Bail
- Before (Date)
- Before Or Equal (Date)
- Between
- Boolean
- Confirmed
- Date
- Date Equals
- Date Format
- Different
- Digits
- Digits Between
- Dimensions (Image Files)
- Distinct
- Ends With
- Exists (Database)
- File
- Filled
- Greater Than
- Greater Than Or Equal
- Image (File)
- In
- In Array
- Integer
- IP Address
- JSON
- Less Than
- Less Than Or Equal
- Max
- MIME Types
- MIME Type By File Extension
- Min
- Not In
- Not Regex
- Nullable
- Numeric
- Present
- Regular Expression
- Required
- Required If
- Required Unless
- Required With
- Required With All
- Required Without
- Required Without All
- Same
- Size
- Sometimes
- Starts With
- String
- Timezone
- Unique (Database)
- URL
- UUID
accepted
Проверяемое поле должно быть yes , on , 1 или true . Это полезно для подтверждения принятия «Условий обслуживания».
active_url
Проверяемое поле должно иметь действительную запись A или AAAA в соответствии с dns_get_record
функцией PHP.
after (Date)
Проверяемое поле должно быть значением после указанной даты. Даты будут переданы в strtotime
функцию PHP:
'start_date' => 'required|date|after:tomorrow'
Вместо того, чтобы передавать строку даты для оценки strtotime
, вы можете указать другое поле для сравнения с датой:
'finish_date' => 'required|date|after:start_date'
after_or_equal: date
Проверяемое поле должно быть значением после или равным указанной дате. Для получения дополнительной информации см. Правило после .
alpha
Проверяемое поле должно состоять исключительно из буквенных символов.
alpha_dash
Проверяемое поле может содержать буквенно-цифровые символы, а также тире и подчеркивания.
alpha_num
Проверяемое поле должно состоять из буквенно-цифровых символов.
array
Проверяемое поле должно быть PHP array
.
bail
Прекратите запуск правил проверки после первого сбоя проверки.
before (Date)
Проверяемое поле должно быть значением, предшествующим данной дате. Даты будут переданы в strtotime
функцию PHP . Кроме того, как after
правило, в качестве значения можно указать имя другого проверяемого поля date
.
before Or Equal (Date)
Проверяемое поле должно быть значением, предшествующим или равным указанной дате. Даты будут переданы в strtotime
функцию PHP . Кроме того, как after
правило, в качестве значения можно указать имя другого проверяемого поля date
.
between:min,max
Проверяемое поле должно иметь размер от заданного минимального до максимального значения . Строки, числа, массивы и файлы оцениваются так же, как size
правило.
boolean
Проверяемое поле должно быть в состоянии быть логическим. Принимаемые входные true
, false
, 1
, 0
, "1"
, и "0"
.
confirmed
Проверяемое поле должно иметь соответствующее поле foo_confirmation
. Например, если проверяемое поле имеет значение password
, соответствующее password_confirmation
поле должно присутствовать во входных данных.
date
Проверяемое поле должно быть действительной, не относительной датой в соответствии с strtotime
функцией PHP.
date_equals: date
Проверяемое поле должно быть равно заданной дате. Даты будут переданы в strtotime
функцию PHP .
date_format: format
Проверяемое поле должно соответствовать заданному формату . Вы должны использовать либоdate
или date_format
при проверке поля, но не оба.
different:field
Проверяемое поле должно иметь значение, отличное от поля .
digits:value
Проверяемое поле должно быть числовым и иметь точную длину значения .
digits_between:min,max
Проверяемое поле должно иметь длину от заданного минимального до максимального значения .
dimensions
Проверяемый файл должен быть изображением, соответствующим ограничениям размеров, указанным в параметрах правила:
'avatar' => 'dimensions:min_width=100,min_height=200'
Доступны следующие ограничения: min_width , max_width , min_height , max_height , ширина , высота , коэффициент .
Отношение ограничение должно быть представлено в виде ширины , деленная на высоту. Это может быть указано либо с помощью оператора like или с плавающей точкой :3/2
1.5
'avatar' => 'dimensions:ratio=3/2'
Так как это правило требует нескольких аргументов, вы можете использовать метод для свободного создания правила:Rule::dimensions
use Illuminate\Validation\Rule;
Validator::make($data, [
'avatar' => [
'required',
Rule::dimensions()->maxWidth(1000)->maxHeight(500)->ratio(3 / 2),
],
]);
distinct
При работе с массивами проверяемое поле не должно иметь повторяющихся значений.
'foo.*.id' => 'distinct'
Проверяемое поле должно быть отформатировано как адрес электронной почты.
ends_with:foo,bar,…
Проверяемое поле должно заканчиваться одним из указанных значений.
exists:table,column
Проверяемое поле должно существовать в данной таблице базы данных.
Основное использование правила существования
'state' => 'exists:states'
Если column
опция не указана, будет использовано имя поля.
Указание пользовательского имени столбца
'state' => 'exists:states,abbreviation'
Иногда вам может потребоваться указать конкретное соединение с базой данных, которое будет использоваться для exists
запроса. Это можно сделать, добавив имя соединения к имени таблицы, используя синтаксис «точка»:
'email' => 'exists:connection.staff,email'
Если вы хотите настроить запрос, выполняемый правилом валидации, вы можете использовать Rule
класс для свободного определения правила. В этом примере мы также указываем правила проверки в виде массива вместо использования |
символа для их разделения:
use Illuminate\Validation\Rule;
Validator::make($data, [
'email' => [
'required',
Rule::exists('staff')->where(function ($query) {
$query->where('account_id', 1);
}),
],
]);
file
Проверяемое поле должно быть успешно загруженным файлом.
filled
Проверяемое поле не должно быть пустым, если оно присутствует.
gt:field
Проверяемое поле должно быть больше указанного поля . Два поля должны быть одного типа. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и size
правило.
gte:field
Проверяемое поле должно быть больше или равно данному полю . Два поля должны быть одного типа. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и size
правило.
image
Проверяемый файл должен быть изображением (jpeg, png, bmp, gif или svg)
in:foo,bar,…
Проверяемое поле должно быть включено в данный список значений. Поскольку для этого правила часто требуется implode
массив, метод может быть использован для свободного построения правила:Rule::in
use Illuminate\Validation\Rule;
Validator::make($data, [
'zones' => [
'required',
Rule::in(['first-zone', 'second-zone']),
],
]);
in_array:anotherfield.*
Проверяемое поле должно существовать в значениях другого поля .
integer
Проверяемое поле должно быть целым числом.
ip
Проверяемое поле должно быть IP-адресом.
ipv4
Проверяемое поле должно быть адресом IPv4.
ipv6
Проверяемое поле должно быть адресом IPv6.
json
Проверяемое поле должно быть допустимой строкой JSON.
lt:field
Проверяемое поле должно быть меньше указанного поля . Два поля должны быть одного типа. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и size
правило.
lte:field
Проверяемое поле должно быть меньше или равно данному полю . Два поля должны быть одного типа. Строки, числа, массивы и файлы оцениваются с использованием тех же соглашений, что и size
правило.
max:value
Проверяемое поле должно быть меньше или равно максимальному значению . Строки, числа, массивы и файлы оцениваются так же, как size
правило.
mimetypes:text/plain,…
Проверяемый файл должен соответствовать одному из указанных типов MIME:
'video' => 'mimetypes:video/avi,video/mpeg,video/quicktime'
Чтобы определить тип MIME загруженного файла, его содержимое будет прочитано, и платформа попытается угадать тип MIME, который может отличаться от типа MIME, предоставленного клиентом.
mimes:foo,bar,…
Проверяемый файл должен иметь тип MIME, соответствующий одному из перечисленных расширений.
Основное использование правила MIME
'photo' => 'mimes:jpeg,bmp,png'
Несмотря на то, что вам нужно только указать расширения, это правило фактически проверяет тип файла MIME, читая содержимое файла и угадывая его тип MIME.
Полный список типов MIME и их соответствующих расширений можно найти по следующему адресу : https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types.
min:value
Проверяемое поле должно иметь минимальное значение . Строки, числа, массивы и файлы оцениваются так же, как size
правило.
not_in:foo,bar,…
Проверяемое поле не должно быть включено в данный список значений. Метод может быть использован для построения свободно правила:Rule::notIn
use Illuminate\Validation\Rule;
Validator::make($data, [
'toppings' => [
'required',
Rule::notIn(['sprinkles', 'cherries']),
],
]);
not_regex:pattern
Проверяемое поле не должно соответствовать заданному регулярному выражению.
Внутренне это правило использует preg_match
функцию PHP . Указанный шаблон должен соответствовать форматированию, требуемому для этого, preg_match
и, следовательно, также включать допустимые разделители. Например: .'email' => 'not_regex:/^.+$/i'
Примечание. При использовании шаблонов
regex
/not_regex
может потребоваться указать правила в массиве вместо использования разделителей канала, особенно если регулярное выражение содержит символ канала.
nullable
Проверяемое поле может быть null
. Это особенно полезно при проверке примитивов, таких как строки и целые числа, которые могут содержать null
значения.
numeric
Проверяемое поле должно быть числовым.
present
Проверяемое поле должно присутствовать во входных данных, но может быть пустым.
regex:pattern
Проверяемое поле должно соответствовать заданному регулярному выражению.
Внутренне это правило использует preg_match
функцию PHP . Указанный шаблон должен соответствовать форматированию, требуемому для этого, preg_match
и, следовательно, также включать допустимые разделители. Например: .'email' => 'regex:/^.+@.+$/i'
Примечание. При использовании шаблонов
regex
/not_regex
может потребоваться указать правила в массиве вместо использования разделителей канала, особенно если регулярное выражение содержит символ канала.
required
Проверяемое поле должно присутствовать во входных данных и не быть пустым. Поле считается «пустым», если выполняется одно из следующих условий:
- Значение есть
null
. - Значение является пустой строкой.
- Значением является пустой массив или пустой
Countable
объект. - Значением является загруженный файл без пути.
required_if:anotherfield,value,…
Проверяемое поле должно присутствовать и не быть пустым, если поле другого поля равно какому-либо значению .
Если вы хотите построить более сложное условие для required_if
правила, вы можете использовать метод. Этот метод принимает логическое значение или замыкание. Когда передано Закрытие, Закрытие должно возвратиться или указать, требуется ли проверяемое поле:Rule::requiredIf
true
false
use Illuminate\Validation\Rule;
Validator::make($request->all(), [
'role_id' => Rule::requiredIf($request->user()->is_admin),
]);
Validator::make($request->all(), [
'role_id' => Rule::requiredIf(function () use ($request) {
return $request->user()->is_admin;
}),
]);
required_unless:anotherfield,value,…
Проверяемое поле должно присутствовать и не быть пустым, если поле другого поля не равно какому-либо значению .
required_with:foo,bar,…
Проверяемое поле должно присутствовать и не быть пустым, только если присутствуют какие-либо другие указанные поля.
required_with_all:foo,bar,…
Проверяемое поле должно присутствовать и не быть пустым, только если присутствуют все другие указанные поля.
required_without:foo,bar,…
Проверяемое поле должно присутствовать и не быть пустым, только если нет других указанных полей.
required_without_all:foo,bar,…
Проверяемое поле должно присутствовать и не быть пустым, только если все другие указанные поля отсутствуют.
same:field
Данное поле должно соответствовать проверяемому полю.
size:value
Проверяемое поле должно иметь размер, соответствующий заданному значению . Для строковых данных значение соответствует количеству символов. Для числовых данных значениесоответствует заданному целочисленному значению. Для массива размер соответствует count
массиву. Для файлов размер соответствует размеру файла в килобайтах.
starts_with:foo,bar,…
Проверяемое поле должно начинаться с одного из указанных значений.
string
Проверяемое поле должно быть строкой. Если вы хотите, чтобы поле также было null
, вы должны назначить nullable
правило для поля.
timezone
Проверяемое поле должно быть действительным идентификатором часового пояса в соответствии с timezone_identifiers_list
функцией PHP.
unique:table,column,except,idColumn
Проверяемое поле не должно существовать в данной таблице базы данных.
Указание пользовательского имени столбца:
column
Вариант может быть использован для определения соответствующего столбца базы данных в полях. Если column
опция не указана, будет использовано имя поля.
'email' => 'unique:users,email_address'
Настраиваемое соединение с базой данных
Иногда вам может понадобиться установить пользовательское соединение для запросов к базе данных, выполняемых валидатором. Как показано выше, при настройке в качестве правила проверки будет использоваться соединение с базой данных по умолчанию для запроса к базе данных. Чтобы переопределить это, укажите соединение и имя таблицы, используя синтаксис «точка»:unique:users
'email' => 'unique:connection.users,email_address'
Принудительное уникальное правило игнорирования заданного идентификатора:
Иногда вы можете игнорировать данный идентификатор во время уникальной проверки. Например, рассмотрим экран «Обновить профиль», который включает имя пользователя, адрес электронной почты и местоположение. Возможно, вы захотите убедиться, что адрес электронной почты является уникальным. Однако, если пользователь изменяет только поле имени, а не поле электронной почты, вы не хотите, чтобы выдавалась ошибка проверки, поскольку пользователь уже является владельцем адреса электронной почты.
Чтобы поручить валидатору игнорировать идентификатор пользователя, мы будем использовать Rule
класс для свободного определения правила. В этом примере мы также указываем правила проверки в виде массива вместо использования |
символа для разделения правил:
use Illuminate\Validation\Rule;
Validator::make($data, [
'email' => [
'required',
Rule::unique('users')->ignore($user->id),
],
]);
Вы никогда не должны передавать какой-либо пользовательский ввод запроса в
ignore
метод. Вместо этого вы должны передавать только сгенерированный системой уникальный идентификатор, такой как идентификатор с автоматическим увеличением или UUID, из экземпляра модели Eloquent. В противном случае ваше приложение будет уязвимо для атаки SQL-инъекцией.
Вместо того, чтобы передавать значение ключа модели в ignore
метод, вы можете передать весь экземпляр модели. Laravel автоматически извлечет ключ из модели:
Rule::unique('users')->ignore($user)
Если ваша таблица использует имя столбца первичного ключа, отличное от id
, вы можете указать имя столбца при вызове ignore
метода:
Rule::unique('users')->ignore($user->id, 'user_id')
По умолчанию unique
правило проверяет уникальность столбца, совпадающего с именем проверяемого атрибута. Однако вы можете передать другое имя столбца в качестве второго аргумента unique
метода:
Rule::unique('users', 'email_address')->ignore($user->id),
Добавление дополнительных предложений Where:
Вы также можете указать дополнительные ограничения запроса, настроив запрос с помощью where
метода. Например, давайте добавим ограничение , которое проверяет account_id
IS 1
:
'email' => Rule::unique('users')->where(function ($query) {
return $query->where('account_id', 1);
})
url
Проверяемое поле должно быть действительным URL.
uuid
Проверяемое поле должно быть действительным универсальным уникальным идентификатором (UUID) RFC 4122 (версия 1, 3, 4 или 5).
Условия добавления правил
Проверка при наличии
В некоторых ситуациях вам может потребоваться выполнить проверки правильности для поля, только если это поле присутствует во входном массиве. Чтобы быстро это сделать, добавьте sometimes
правило в список правил:
$v = Validator::make($data, [
'email' => 'sometimes|required|email',
]);
В приведенном выше примере email
поле будет проверено, только если оно присутствует в $data
массиве.
Если вы пытаетесь проверить поле, которое всегда должно присутствовать, но может быть пустым, ознакомьтесь с этим примечанием к дополнительным полям
Комплексная условная проверка
Иногда вы можете захотеть добавить правила проверки, основанные на более сложной условной логике. Например, вам может потребоваться указать данное поле только в том случае, если другое поле имеет значение больше 100. Или вам может потребоваться, чтобы два поля имели заданное значение только при наличии другого поля. Добавление этих правил проверки не должно быть проблемой. Сначала создайте Validator
экземпляр со своими статическими правилами,которые никогда не меняются:
$v = Validator::make($data, [
'email' => 'required|email',
'games' => 'required|numeric',
]);
Давайте предположим, что наше веб-приложение предназначено для коллекционеров игр. Если коллекционер игр регистрируется в нашем приложении и им принадлежит более 100 игр, мы хотим, чтобы они объяснили, почему у них так много игр. Например, возможно, они управляют магазином перепродажи игр, или, возможно, им просто нравится коллекционировать. Чтобы условно добавить это требование, мы можем использовать sometimes
метод в Validator
экземпляре.
$v->sometimes('reason', 'required|max:500', function ($input) {
return $input->games >= 100;
});
Первым аргументом, переданным sometimes
методу, является имя поля, которое мы условно проверяем. Второй аргумент — это правила, которые мы хотим добавить. Если Closure
передано в качестве третьего аргумента true
, правила будут добавлены. Этот метод позволяет легко создавать сложные условные проверки. Вы можете даже добавить условные проверки для нескольких полей одновременно:
$v->sometimes(['reason', 'cost'], 'required', function ($input) {
return $input->games >= 100;
});
$input
Параметр , переданный к вашемуClosure
будет экземпляром и может использоваться для доступа к вашему вводу и файлам.Illuminate\Support\Fluent
Проверка массивов
Проверка полей ввода на основе массива не должна быть проблемой. Вы можете использовать «точечную нотацию» для проверки атрибутов в массиве. Например, если входящий HTTP-запрос содержит поле, вы можете проверить его следующим образом:photos[profile]
$validator = Validator::make($request->all(), [
'photos.profile' => 'required|image',
]);
Вы также можете проверить каждый элемент массива. Например, чтобы проверить, что каждое электронное письмо в данном поле ввода массива уникально, вы можете сделать следующее:
$validator = Validator::make($request->all(), [
'person.*.email' => 'email|unique:users',
'person.*.first_name' => 'required_with:person.*.last_name',
]);
Аналогичным образом, вы можете использовать этот *
символ при указании ваших сообщений проверки в ваших языковых файлах, что позволяет без труда использовать одно сообщение проверки для полей на основе массива:
'custom' => [
'person.*.email' => [
'unique' => 'Each person must have a unique e-mail address',
]
],
Пользовательские правила проверки
Использование объектов правил
Laravel предлагает множество полезных правил проверки; тем не менее, вы можете указать свои собственные. Одним из способов регистрации пользовательских правил проверки является использование объектов правил. Чтобы создать новый объект правила, вы можете использовать команду Artisan. Давайте использовать эту команду для генерации правила, которое проверяет строку в верхнем регистре. Laravel поместит новое правило в каталог:make:rule
app/Rules
php artisan make:rule Uppercase
Как только правило было создано, мы готовы определить его поведение. Объект правила содержит два метода: passes
и message
. passes
Метод получает значение атрибута и имя, и он должен возвращать true
или в false
зависимости от того, является ли или нет значение атрибута. message
Метод должен возвращать сообщение об ошибке проверки , которая должна использоваться при сбое проверки:
<?php
namespace App\Rules;
use Illuminate\Contracts\Validation\Rule;
class Uppercase implements Rule
{
/**
* Determine if the validation rule passes.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
public function passes($attribute, $value)
{
return strtoupper($value) === $value;
}
/**
* Get the validation error message.
*
* @return string
*/
public function message()
{
return 'The :attribute must be uppercase.';
}
}
Вы можете вызвать trans
помощника из вашего message
метода, если хотите вернуть сообщение об ошибке из ваших файлов перевода:
/**
* Get the validation error message.
*
* @return string
*/
public function message()
{
return trans('validation.uppercase');
}
Как только правило было определено, вы можете присоединить его к валидатору, передав экземпляр объекта правила с другими вашими правилами валидации:
use App\Rules\Uppercase;
$request->validate([
'name' => ['required', 'string', new Uppercase],
]);
Использование замыканий
Если вам требуется функциональность настраиваемого правила только один раз в приложении, вы можете использовать Closure вместо объекта правила. Замыкание получает имя атрибута, значение атрибута и $fail
обратный вызов, который должен быть вызван в случае сбоя проверки:
$validator = Validator::make($request->all(), [
'title' => [
'required',
'max:255',
function ($attribute, $value, $fail) {
if ($value === 'foo') {
$fail($attribute.' is invalid.');
}
},
],
]);
Использование расширений
Другой метод регистрации пользовательских правил проверки — использование extend
метода на Validator
фасаде . Давайте использовать этот метод в сервис-провайдере для регистрации пользовательского правила проверки:
<?php
namespace App\Providers;
use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Validator;
class AppServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*
* @return void
*/
public function register()
{
//
}
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
Validator::extend('foo', function ($attribute, $value, $parameters, $validator) {
return $value == 'foo';
});
}
}
Пользовательский валидатор Closure получает четыре аргумента: имя $attribute
проверяемого $value
объекта, атрибута, массив, $parameters
передаваемый правилу, и Validator
экземпляр.
Вы также можете передать класс и метод в extend
метод вместо Closure:
Validator::extend('foo', 'FooValidator@validate');
Определение сообщения об ошибке
Вам также необходимо определить сообщение об ошибке для вашего пользовательского правила. Это можно сделать либо с помощью встроенного пользовательского массива сообщений, либо добавив запись в файл языка проверки. Это сообщение должно быть помещено в первый уровень массива, а не в custom
массив, который предназначен только для сообщений об ошибках, относящихся к атрибуту:
"foo" => "Your input was invalid!",
"accepted" => "The :attribute must be accepted.",
// The rest of the validation error messages...
При создании пользовательского правила проверки иногда может потребоваться определить пользовательские замены заполнителей для сообщений об ошибках. Вы можете сделать это, создав пользовательский Validator, как описано выше, затем вызвав replacer
метод на Validator
фасаде. Вы можете сделать это в рамках boot
метода поставщика услуг :
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
Validator::extend(...);
Validator::replacer('foo', function ($message, $attribute, $rule, $parameters) {
return str_replace(...);
});
}
Неявные расширения
По умолчанию, когда проверяемый атрибут отсутствует или содержит пустую строку, обычные правила проверки, включая пользовательские расширения, не запускаются. Например, unique
правило не будет запущено для пустой строки:
$rules = ['name' => 'unique:users,name'];
$input = ['name' => ''];
Validator::make($input, $rules)->passes(); // true
Чтобы правило запускалось, даже если атрибут пуст, правило должно подразумевать, что атрибут является обязательным. Чтобы создать такое «неявное» расширение, используйте метод:Validator::extendImplicit()
Validator::extendImplicit('foo', function ($attribute, $value, $parameters, $validator) {
return $value == 'foo';
});
«Неявное» расширение подразумевает, что атрибут является обязательным. Независимо от того, действительно ли он аннулирует отсутствующий или пустой атрибут, зависит от вас.
Search code, repositories, users, issues, pull requests…
Provide feedback
Saved searches
Use saved searches to filter your results more quickly
Sign up