FormRequest
класс FormRequest расширяет Request и реализует ValidatesWhenResolved (View source)
Особенности
| ValidatesWhenResolvedTrait | Предоставляет реализацию по умолчанию для контракта ValidatesWhenResolved. |
| InteractsWithContentTypes | |
| InteractsWithFlashData | |
| InteractsWithInput | |
| Macroable |
Свойства
| static protected массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected ParameterBag|null | $json | Декодированное JSON-содержание запроса. | из Request |
| protected массив | $convertedFiles | Все преобразованные файлы для запроса. | из Request |
| protected Closure | $userResolver | Обратный вызов для получения пользователя. | из Request |
| protected Closure | $routeResolver | Обратный вызов для получения маршрута. | из Request |
| protected Container | $container | Экземпляр контейнера. | |
| protected Redirector | $redirector | Экземпляр перенаправления. | |
| protected строка | $redirect | URI для перенаправления в случае неудачной валидации. | |
| protected строка | $redirectRoute | Маршрут для перенаправления в случае неудачной валидации. | |
| protected строка | $redirectAction | Действие контроллера для перенаправления в случае неудачной валидации. | |
| protected строка | $errorBag | Ключ, используемый для мешка с ошибками представления. | |
| protected Validator | $validator | Экземпляр валидатора. |
Методы
| static bool | matchesType(string $actual, string $type)
Определить, совпадают ли заданные типы содержимого. | from InteractsWithContentTypes |
| bool | isJson()
Определить, отправляет ли запрос JSON. | from InteractsWithContentTypes |
| bool | expectsJson()
Определить, ожидает ли текущий запрос, вероятно, JSON-ответ. | from InteractsWithContentTypes |
| bool | wantsJson()
Определить, запрашивает ли текущий запрос JSON. | from InteractsWithContentTypes |
| bool | accepts(string|array $contentTypes)
Определяет, принимает ли текущий запрос заданный тип содержимого. | from InteractsWithContentTypes |
| string|null | prefers(string|array $contentTypes)
Возвращает наиболее подходящий тип содержимого из заданного массива на основе согласования содержимого. | from InteractsWithContentTypes |
| bool | acceptsAnyContentType()
Определить, принимает ли текущий запрос любой тип содержимого. | from InteractsWithContentTypes |
| bool | acceptsJson()
Определяет, принимает ли запрос JSON. | from InteractsWithContentTypes |
| bool | acceptsHtml()
Определяет, принимает ли запрос HTML. | from InteractsWithContentTypes |
| string | format(string $default = 'html')
Получить ожидаемый формат данных в ответе. | from InteractsWithContentTypes |
| string|array | old(string|null $key = null, string|array|null $default = null)
Получить элемент старого ввода. | from InteractsWithFlashData |
| void | flash()
Переслать ввод для текущего запроса в сессию. | from InteractsWithFlashData |
| void | flashOnly(array|mixed $keys)
Переслать только некоторые данные ввода в сессию. | from InteractsWithFlashData |
| void | flashExcept(array|mixed $keys)
Переслать только некоторые данные ввода в сессию. | from InteractsWithFlashData |
| void | flush()
Очистить весь старый ввод из сессии. | from InteractsWithFlashData |
| string|array|null | server(string|null $key = null, string|array|null $default = null)
Получить переменную сервера из запроса. | from InteractsWithInput |
| bool | hasHeader(string $key)
Определить, установлена ли заголовка в запросе. | from InteractsWithInput |
| string|array|null | header(string|null $key = null, string|array|null $default = null)
Получить заголовок из запроса. | from InteractsWithInput |
| string|null | bearerToken()
Получить токен доступа из заголовков запроса. | from InteractsWithInput |
| bool | exists(string|array $key)
Определить, содержит ли запрос заданный элемент ввода. | from InteractsWithInput |
| bool | has(string|array $key)
Определить, содержит ли запрос заданный элемент ввода. | from InteractsWithInput |
| bool | hasAny(string|array $keys)
Определить, содержит ли запрос любой из заданных элементов ввода. | from InteractsWithInput |
| bool | filled(string|array $key)
Определить, содержит ли запрос ненулевое значение для элемента ввода. | from InteractsWithInput |
| bool | anyFilled(string|array $keys)
Определить, содержит ли запрос ненулевое значение для любого из заданных элементов ввода. | from InteractsWithInput |
| bool | missing(string|array $key)
Определить, отсутствует ли заданный элемент ввода в запросе. | from InteractsWithInput |
| bool | isEmptyString(string $key)
Определить, является ли заданный ключ ввода пустой строкой для «has». | from InteractsWithInput |
| array | keys()
Получить ключи для всех данных ввода и файлов. | from InteractsWithInput |
| array | all(array|mixed|null $keys = null)
Получить все данные ввода и файлы для запроса. | from InteractsWithInput |
| mixed | input(string|null $key = null, mixed $default = null)
Получить элемент ввода из запроса. | from InteractsWithInput |
| bool | boolean(string|null $key = null, bool $default = false)
Получить входные данные как булево значение. | из InteractsWithInput |
| array | only(array|mixed $keys)
Получить подмножество, содержащее указанные ключи со значениями из входных данных. | из InteractsWithInput |
| array | except(array|mixed $keys)
Получить все входные данные, за исключением указанного массива элементов. | из InteractsWithInput |
| string|array|null | query(string|null $key = null, string|array|null $default = null)
Получить элемент строки запроса из запроса. | из InteractsWithInput |
| string|array|null | post(string|null $key = null, string|array|null $default = null)
Получить элемент данных запроса из запроса. | из InteractsWithInput |
| bool | hasCookie(string $key)
Определить, установлен ли куки в запросе. | из InteractsWithInput |
| string|array|null | cookie(string|null $key = null, string|array|null $default = null)
Получить куки из запроса. | из InteractsWithInput |
| array | allFiles()
Получить массив всех файлов в запросе. | из InteractsWithInput |
| array | convertUploadedFiles(array $files)
Преобразовать предоставленный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles. | из InteractsWithInput |
| bool | hasFile(string $key)
Определить, содержит ли загруженные данные файл. | из InteractsWithInput |
| bool | isValidFile(mixed $file)
Проверить, является ли данный файл допустимым экземпляром файла. | из InteractsWithInput |
| UploadedFile|UploadedFile[]|array|null | file(string|null $key = null, mixed $default = null)
Получить файл из запроса. | из InteractsWithInput |
| string|array|null | retrieveItem(string $source, string $key, string|array|null $default)
Получить элемент параметра из указанного источника. | из InteractsWithInput |
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро. | из Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | из Macroable |
| static bool | hasMacro(string $name)
Проверка, зарегистрировано ли макро. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамическая обработка вызовов класса. | из Macroable |
| mixed | __call(string $method, array $parameters)
Динамическая обработка вызовов класса. | из Macroable |
| static Request | capture()
Создать новый запрос Illuminate HTTP из переменных сервера. | из Request |
| $this | instance()
Возвратить экземпляр Request. | из Request |
| string | method()
Получить метод запроса. | из Request |
| string | root()
Получить корневой URL приложения. | из Request |
| string | url()
Получить URL (без строки запроса) для запроса. | из Request |
| string | fullUrl()
Получить полный URL для запроса. | из Request |
| string | fullUrlWithQuery(array $query)
Получить полный URL для запроса с добавленными параметрами строки запроса. | из Request |
| string | path()
Получить текущий путь инфo для запроса. | из Request |
| string | decodedPath()
Получить текущий декодированный путь инфo для запроса. | из Request |
| string|null | segment(int $index, string|null $default = null)
Получить сегмент из URI (индекс 1-основанный). | из Request |
| array | segments()
Получить все сегменты для пути запроса. | из Request |
| bool | is(mixed ...$patterns)
Определить, соответствует ли текущий URI запроса шаблону. | из Request |
| bool | routeIs(mixed ...$patterns)
Определить, соответствует ли имя маршрута заданному шаблону. | из Request |
| bool | fullUrlIs(mixed ...$patterns)
Определить, соответствует ли текущий URL-адрес запроса и строка запроса шаблону. | from Request |
| bool | ajax()
Определить, является ли запрос результатом вызова AJAX. | from Request |
| bool | pjax()
Определить, является ли запрос результатом вызова PJAX. | from Request |
| bool | prefetch()
Определить, является ли запрос результатом вызова prefetch. | from Request |
| bool | secure()
Определить, выполняется ли запрос по протоколу HTTPS. | from Request |
| string|null | ip()
Получить IP-адрес клиента. | from Request |
| array | ips()
Получить IP-адреса клиента. | from Request |
| string|null | userAgent()
Получить пользователя-агента клиента. | from Request |
| $this | merge(array $input)
Объединить новые данные в массив данных текущего запроса. | from Request |
| $this | replace(array $input)
Заменить данные для текущего запроса. | from Request |
| mixed | get(string $key, mixed $default = null)
Этот метод принадлежит Symfony HttpFoundation и обычно не требуется при использовании Laravel. | from Request |
| ParameterBag|mixed | json(string|null $key = null, mixed $default = null)
Получить JSON-данные для запроса. | from Request |
| ParameterBag | getInputSource()
Получить источник данных для запроса. | from Request |
| static Request | createFrom(Request $from, Request|null $to = null)
Создать новый экземпляр запроса из данного запроса Laravel. | from Request |
| static Request | createFromBase(Request $request)
Создать запрос Illuminate из экземпляра Symfony. | from Request |
| duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null) {@inheritdoc} | from Request | |
| mixed | filterFiles(mixed $files)
Отфильтровать заданный массив файлов, удалив любые пустые значения. | from Request |
| Store | session()
Получить сеанс, связанный с запросом. | from Request |
| Store|null | getSession()
Получить сеанс, связанный с запросом. | from Request |
| void | setLaravelSession(Session $session)
Установить экземпляр сеанса в запросе. | from Request |
| mixed | user(string|null $guard = null)
Получить пользователя, производящего запрос. | from Request |
| Route|object|string|null | route(string|null $param = null, mixed $default = null)
Получить маршрут, обрабатывающий запрос. | from Request |
| string | fingerprint()
Получить уникальный отпечаток запроса / маршрута / IP-адреса. | from Request |
| $this | setJson(ParameterBag $json)
Установить JSON-данные для запроса. | from Request |
| Closure | getUserResolver()
Получить обратный вызов решателя пользователя. | from Request |
| $this | setUserResolver(Closure $callback)
Установить обратный вызов решателя пользователя. | from Request |
| Closure | getRouteResolver()
Получить обратный вызов решателя маршрута. | from Request |
| $this | setRouteResolver(Closure $callback)
Установить обратный вызов решателя маршрута. | from Request |
| array | toArray()
Получить все данные и файлы для запроса. | from Request |
| bool | offsetExists(string $offset)
Определить, существует ли заданный смещение. | from Request |
| mixed | offsetGet(string $offset)
Получить значение по заданному смещению. | from Request |
| void | offsetSet(string $offset, mixed $value)
Установить значение по заданному смещению. | from Request |
| void | offsetUnset(string $offset)
Удалить значение по заданному смещению. | из Request |
| bool | __isset(string $key)
Проверить, установлено ли элемент ввода в запросе. | из Request |
| mixed | __get(string $key)
Получить элемент ввода из запроса. | из Request |
| array | validate(array $rules, mixed $params) Описание отсутствует | из Request |
| array | validateWithBag(string $errorBag, array $rules, mixed $params) Описание отсутствует | из Request |
| bool | hasValidSignature(bool $absolute = true) Описание отсутствует | из Request |
| void | validateResolved()
Проверить экземпляр класса. | из ValidatesWhenResolvedTrait |
| void | prepareForValidation()
Подготовить данные для проверки. | из ValidatesWhenResolvedTrait |
| Validator | getValidatorInstance()
Получить экземпляр валидатора для запроса. | |
| void | passedValidation()
Обработка успешной попытки проверки. | из ValidatesWhenResolvedTrait |
| void | failedValidation(Validator $validator)
Обработка неудачной попытки проверки. | |
| bool | passesAuthorization()
Определить, проходит ли запрос проверку авторизации. | |
| void | failedAuthorization()
Обработка неудачной попытки авторизации. | |
| Validator | createDefaultValidator(Factory $factory)
Создать экземпляр валидатора по умолчанию. | |
| array | validationData()
Получить данные для проверки из запроса. | |
| string | getRedirectUrl()
Получить URL для перенаправления при ошибке валидации. | |
| array | validated()
Получить проверенные данные из запроса. | |
| array | messages()
Получить пользовательские сообщения для ошибок валидации. | |
| array | attributes()
Получить пользовательские атрибуты для ошибок валидации. | |
| $this | setValidator(Validator $validator)
Установить экземпляр Validator. | |
| $this | setRedirector(Redirector $redirector)
Установить экземпляр Redirector. | |
| $this | setContainer(Container $container)
Установить реализацию контейнера. |
Подробности
static bool matchesType(string $actual, string $type)
Определить, совпадают ли заданные типы контента.
bool isJson()
Определить, отправляет ли запрос JSON.
bool expectsJson()
Определить, вероятно ли, что текущий запрос ожидает ответ в формате JSON.
bool wantsJson()
Определить, запрашивает ли текущий запрос JSON.
bool accepts(string|array $contentTypes)
Определяет, принимает ли текущий запрос заданный тип контента.
string|null prefers(string|array $contentTypes)
Возвращает наиболее подходящий тип контента из заданного массива на основе согласования контента.
bool acceptsAnyContentType()
Определить, принимает ли текущий запрос любой тип контента.
bool acceptsJson()
Определяет, принимает ли запрос JSON.
bool acceptsHtml()
Определяет, принимает ли запрос HTML.
string format(string $default = 'html')
Получить ожидаемый формат данных в ответе.
строка|массив old(строка|null $key = null, строка|массив|null $default = null)
Получить старое значение элемента ввода.
пустое значение flash()
Сохранить данные ввода текущего запроса в сессии.
пустое значение flashOnly(массив|смешанный $keys)
Сохранить в сессии только указанные элементы ввода.
пустое значение flashExcept(массив|смешанный $keys)
Сохранить в сессии только указанные элементы ввода.
пустое значение flush()
Очистить все старые данные ввода из сессии.
строка|массив|null server(строка|null $key = null, строка|массив|null $default = null)
Получить переменную сервера из запроса.
bool hasHeader(строка $key)
Проверить, задан ли заголовок в запросе.
строка|массив|null header(строка|null $key = null, строка|массив|null $default = null)
Получить заголовок из запроса.
строка|null bearerToken()
Получить токен bearer из заголовков запроса.
bool exists(строка|массив $key)
Проверить, содержит ли запрос заданный ключ элемента ввода.
bool has(строка|массив $key)
Проверить, содержит ли запрос заданный ключ элемента ввода.
bool hasAny(строка|массив $keys)
Проверить, содержит ли запрос любой из заданных элементов ввода.
bool filled(строка|массив $key)
Проверить, содержит ли запрос непустое значение для элемента ввода.
bool anyFilled(строка|массив $keys)
Проверить, содержит ли запрос непустое значение для любого из заданных элементов ввода.
bool missing(строка|массив $key)
Проверить, отсутствует ли заданный ключ элемента ввода в запросе.
protected bool isEmptyString(строка $key)
Проверить, является ли заданный ключ элемента ввода пустой строкой для проверки "has".
массив keys()
Получить ключи всех элементов ввода и файлов.
массив all(массив|смешанный|null $keys = null)
Получить все элементы ввода и файлы для запроса.
смешанный input(строка|null $key = null, смешанный $default = null)
Получить элемент ввода из запроса.
bool boolean(строка|null $key = null, bool $default = false)
Получить элемент ввода как булево значение.
Возвращает true, если значение равно "1", "true", "on", "yes". В противном случае, возвращает false.
массив only(массив|смешанный $keys)
Получить подмножество, содержащее указанные ключи со значениями из данных ввода.
массив except(массив|смешанный $keys)
Получить все элементы ввода, за исключением указанного массива элементов.
строка|массив|null query(строка|null $key = null, строка|массив|null $default = null)
Получить элемент запроса из строки запроса.
string|array|null post(string|null $key = null, string|array|null $default = null)
Получить элемент загрузки запроса из запроса.
bool hasCookie(string $key)
Определить, установлено ли cookie в запросе.
string|array|null cookie(string|null $key = null, string|array|null $default = null)
Получить cookie из запроса.
array allFiles()
Получить массив всех файлов в запросе.
protected array convertUploadedFiles(array $files)
Преобразовать заданный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles.
bool hasFile(string $key)
Определить, содержит ли загруженные данные файл.
protected bool isValidFile(mixed $file)
Проверить, является ли данный файл допустимым экземпляром файла.
UploadedFile|UploadedFile[]|array|null file(string|null $key = null, mixed $default = null)
Получить файл из запроса.
protected string|array|null retrieveItem(string $source, string $key, string|array|null $default)
Получить элемент параметра из заданного источника.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static mixed __callStatic(string $method, array $parameters)
Динамически обработать вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обработать вызовы класса.
static Request capture()
Создать новый запрос Illuminate HTTP из переменных сервера.
$this instance()
Возвратить экземпляр Request.
string method()
Получить метод запроса.
string root()
Получить корневой URL приложения.
string url()
Получить URL (без строки запроса) для запроса.
string fullUrl()
Получить полный URL для запроса.
string fullUrlWithQuery(array $query)
Получить полный URL для запроса с добавленными параметрами строки запроса.
string path()
Получить текущий путь для запроса.
string decodedPath()
Получить текущий декодированный путь для запроса.
string|null segment(int $index, string|null $default = null)
Получить сегмент из URI (индекс, начинающийся с 1).
array segments()
Получить все сегменты пути запроса.
bool is(mixed ...$patterns)
Определить, соответствует ли текущий URI запроса шаблону.
bool routeIs(mixed ...$patterns)
Определить, соответствует ли имя маршрута заданному шаблону.
bool fullUrlIs(mixed ...$patterns)
Определить, соответствует ли текущий URL-адрес запроса и строка запроса шаблону.
bool ajax()
Определить, является ли запрос результатом вызова AJAX.
bool pjax()
Определить, является ли запрос результатом вызова PJAX.
bool prefetch()
Определить, является ли запрос результатом вызова prefetch.
bool secure()
Определить, происходит ли запрос по протоколу HTTPS.
string|null ip()
Получить IP-адрес клиента.
array ips()
Получить IP-адреса клиента.
string|null userAgent()
Получить user agent клиента.
$this merge(array $input)
Объединить новые входные данные в массив входных данных текущего запроса.
$this replace(array $input)
Заменить входные данные для текущего запроса.
mixed get(string $key, mixed $default = null)
Этот метод принадлежит Symfony HttpFoundation и обычно не требуется при использовании Laravel.
Вместо этого можно использовать метод "input".
ParameterBag|mixed json(string|null $key = null, mixed $default = null)
Получить JSON-payload запроса.
protected ParameterBag getInputSource()
Получить источник входных данных для запроса.
static Request createFrom(Request $from, Request|null $to = null)
Создать новый экземпляр запроса из данного Laravel-запроса.
static Request createFromBase(Request $request)
Создать Illuminate запрос из экземпляра Symfony.
duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)
{@inheritdoc}
protected mixed filterFiles(mixed $files)
Отфильтровать заданный массив файлов, удалив пустые значения.
Store session()
Получить сессию, связанную с запросом.
Store|null getSession()
Получить сессию, связанную с запросом.
void setLaravelSession(Session $session)
Установить экземпляр сессии в запросе.
mixed user(string|null $guard = null)
Получить пользователя, отправляющего запрос.
Route|object|string|null route(string|null $param = null, mixed $default = null)
Получить маршрут, обрабатывающий запрос.
string fingerprint()
Получить уникальный отпечаток запроса / маршрута / IP-адреса.
$this setJson(ParameterBag $json)
Установить JSON-полезную нагрузку для запроса.
Closure getUserResolver()
Получить обратный вызов решателя пользователей.
$this setUserResolver(Closure $callback)
Установить обратный вызов решателя пользователей.
Closure getRouteResolver()
Получить обратный вызов решателя маршрутов.
$this setRouteResolver(Closure $callback)
Установить обратный вызов решателя маршрутов.
array toArray()
Получить все входные данные и файлы для запроса.
bool offsetExists(string $offset)
Определить, существует ли заданный смещение.
mixed offsetGet(string $offset)
Получить значение по заданному смещению.
void offsetSet(string $offset, mixed $value)
Установить значение по заданному смещению.
void offsetUnset(string $offset)
Удалить значение по заданному смещению.
bool __isset(string $key)
Проверить, установлен ли элемент входных данных в запросе.
mixed __get(string $key)
Получить элемент входных данных из запроса.
array validate(array $rules, mixed $params)
Без описания
array validateWithBag(string $errorBag, array $rules, mixed $params)
Без описания
bool hasValidSignature(bool $absolute = true)
Без описания
void validateResolved()
Проверить экземпляр класса.
protected void prepareForValidation()
Подготовить данные для проверки.
protected Validator getValidatorInstance()
Получить экземпляр валидатора для запроса.
protected void passedValidation()
Обработать успешную попытку валидации.
protected void failedValidation(Validator $validator)
Обработать неудачную попытку валидации.
protected bool passesAuthorization()
Определить, проходит ли запрос проверку авторизации.
protected void failedAuthorization()
Обработать неудачную попытку авторизации.
protected Validator createDefaultValidator(Factory $factory)
Создать экземпляр валидатора по умолчанию.
array validationData()
Получить данные для валидации из запроса.
protected string getRedirectUrl()
Получить URL для перенаправления при ошибке валидации.
array validated()
Получить данные, прошедшие валидацию из запроса.
array messages()
Получить пользовательские сообщения для ошибок валидации.
array attributes()
Получить пользовательские атрибуты для ошибок валидации.
$this setValidator(Validator $validator)
Установить экземпляр Validator.
$this setRedirector(Redirector $redirector)
Установить экземпляр Redirector.
$this setContainer(Container $container)
Установить реализацию контейнера.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Foundation/Http/FormRequest.html
