Запрос формы
класс FormRequest расширяет Запрос и реализует ValidatesWhenResolved (Просмотреть исходный код)
Трейты
| ValidatesWhenResolvedTrait | Предоставляет реализацию по умолчанию контракта ValidatesWhenResolved. |
| InteractsWithContentTypes | |
| InteractsWithFlashData | |
| InteractsWithInput | |
| Macroable |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищенный ParameterBag|null | $json | Декодированное JSON-содержимое запроса. | из Запрос |
| защищенный массив | $convertedFiles | Все преобразованные файлы для запроса. | из Запрос |
| защищенный Closure | $userResolver | Обратный вызов для разрешения пользователя. | из Запрос |
| защищенный Closure | $routeResolver | Обратный вызов для разрешения маршрута. | из Запрос |
| защищенный Контейнер | $container | Экземпляр контейнера. | |
| защищенный Перенаправлятор | $redirector | Экземпляр перенаправляющего объекта. | |
| защищенная строка | $redirect | URI для перенаправления при неудачной валидации. | |
| защищенная строка | $redirectRoute | Маршрут для перенаправления при неудачной валидации. | |
| защищенная строка | $redirectAction | Действие контроллера для перенаправления при неудачной валидации. | |
| защищенная строка | $errorBag | Ключ для использования в пакете ошибок представления. | |
| защищенный Валидатор | $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 | isEmptyString(string $key) Определить, является ли заданный ключ ввода пустой строкой для "has". | from InteractsWithInput |
| array | keys() Получить ключи для всех элементов ввода и файлов. | from InteractsWithInput |
| array | all(array|mixed|null $keys = null) Получить все элементы ввода и файлы для запроса. | from InteractsWithInput |
| string|array|null | input(string|null $key = null, string|array|null $default = null) Получить элемент ввода из запроса. | from 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) Определить, установлен ли cookie в запросе. | из InteractsWithInput |
| string|array|null | cookie(string|null $key = null, string|array|null $default = null) Получить cookie из запроса. | из 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 запроса и строка запроса шаблону. | из Request |
| bool | ajax() Определить, является ли запрос результатом вызова AJAX. | из Request |
| bool | pjax() Определить, является ли запрос результатом вызова PJAX. | из Request |
| bool | prefetch() Определить, является ли запрос результатом вызова prefetch. | из Request |
| bool | secure() Определить, передаётся ли запрос по протоколу HTTPS. | из Request |
| string|null | ip() Получить IP-адрес клиента. | из Request |
| array | ips() Получить IP-адреса клиента. | из Request |
| string | userAgent() Получить пользовательский агент клиента. | из Request |
| $this | merge(array $input) Объединить новые данные в массив входных данных текущего запроса. | из Request |
| $this | replace(array $input) Заменить входные данные для текущего запроса. | из Request |
| mixed | get(string $key, mixed $default = null) Этот метод принадлежит Symfony HttpFoundation и обычно не нужен при использовании Laravel. | из Request |
| ParameterBag|mixed | json(string|null $key = null, mixed $default = null) Получить JSON-груз запроса. | из Request |
| ParameterBag | getInputSource() Получить источник входных данных для запроса. | из Request |
| static Request | createFrom(Request $from, Request|null $to = null) Создать новый экземпляр запроса из данного запроса Laravel. | из Request |
| static Request | createFromBase(Request $request) Создать запрос Illuminate из экземпляра Symfony. | из Request |
| duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null) {@inheritdoc} | из Request | |
| mixed | filterFiles(mixed $files) Отфильтровать заданный массив файлов, удалив все пустые значения. | из Request |
| Store | session() Получить сеанс, связанный с запросом. | из Request |
| Store|null | getSession() Получить сеанс, связанный с запросом. | из Request |
| void | setLaravelSession(Session $session) Установить экземпляр сеанса в запросе. | из Request |
| mixed | user(string|null $guard = null) Получить пользователя, совершающего запрос. | из Request |
| Route|object|string | route(string|null $param = null, mixed $default = null) Получить маршрут, обрабатывающий запрос. | из Request |
| string | fingerprint() Получить уникальный отпечаток запроса/маршрута/IP-адреса. | из Request |
| $this | setJson(ParameterBag $json) Установить JSON-груз для запроса. | из Request |
| Closure | getUserResolver() Получить обратный вызов резолвера пользователя. | из Request |
| $this | setUserResolver(Closure $callback) Установить обратный вызов резолвера пользователя. | из Request |
| Closure | getRouteResolver() Получить обратный вызов резолвера маршрута. | из Request |
| $this | setRouteResolver(Closure $callback) Установить обратный вызов резолвера маршрута. | из Request |
| array | toArray() Получить все входные данные и файлы для запроса. | из Request |
| bool | offsetExists(string $offset) Определить, существует ли заданный смещение. | из Request |
| mixed | offsetGet(string $offset) Получить значение по заданному смещению. | из Request |
| void | offsetSet(string $offset, mixed $value) Установить значение по заданному смещению. | из Request |
| void | offsetUnset(string $offset) Удалить значение по заданному смещению. | из Request |
| bool | __isset(string $key) Проверить, задан ли элемент ввода в запросе. | из Запроса |
| mixed | __get(string $key) Получить элемент ввода из запроса. | из Запроса |
| 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')
Получить ожидаемый формат данных в ответе.
string|array old(string|null $key = null, string|array|null $default = null)
Получить элемент ввода из старых данных.
void flash()
Передать данные ввода текущего запроса в сессию.
void flashOnly(array|mixed $keys)
Передать в сессию только некоторые данные ввода.
void flashExcept(array|mixed $keys)
Вывести только часть ввода в сессию.
void flush()
Очистить весь старый ввод из сессии.
string|array|null server(string|null $key = null, string|array|null $default = null)
Получить переменную сервера из запроса.
bool hasHeader(string $key)
Определить, установлен ли заголовок в запросе.
string|array|null header(string|null $key = null, string|array|null $default = null)
Получить заголовок из запроса.
string|null bearerToken()
Получить токен bearer из заголовков запроса.
bool exists(string|array $key)
Определить, содержит ли запрос заданный ключ элемента ввода.
bool has(string|array $key)
Определить, содержит ли запрос заданный ключ элемента ввода.
bool hasAny(string|array $keys)
Определить, содержит ли запрос любой из заданных элементов ввода.
bool filled(string|array $key)
Определить, содержит ли запрос значение, отличное от пустого, для элемента ввода.
bool anyFilled(string|array $keys)
Определить, содержит ли запрос значение, отличное от пустого, для любого из заданных элементов ввода.
protected bool isEmptyString(string $key)
Определить, является ли заданный ключ элемента ввода пустой строкой для «has».
array keys()
Получить ключи для всех элементов ввода и файлов.
array all(array|mixed|null $keys = null)
Получить все элементы ввода и файлы для запроса.
string|array|null input(string|null $key = null, string|array|null $default = null)
Получить элемент ввода из запроса.
array only(array|mixed $keys)
Получить подмножество, содержащее указанные ключи со значениями из данных ввода.
array except(array|mixed $keys)
Получить все элементы ввода, кроме указанного массива элементов.
string|array|null query(string|null $key = null, string|array|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()
Создать новый запрос HTTP Illuminate из переменных сервера.
$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()
Определить, является ли запрос результатом вызова префетча.
bool secure()
Определить, использует ли запрос протокол HTTPS.
string|null ip()
Получить IP-адрес клиента.
array ips()
Получить IP-адреса клиента.
string 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-данные запроса.
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(строка|null $param = null, смешанное $default = null)
Получить маршрут, обрабатывающий запрос.
строка fingerprint()
Получить уникальный отпечаток запроса/маршрута/IP-адреса.
$this setJson(ParameterBag $json)
Установить JSON-полезную нагрузку для запроса.
Closure getUserResolver()
Получить обратный вызов разрешения пользователя.
$this setUserResolver(Closure $callback)
Установить обратный вызов разрешения пользователя.
Closure getRouteResolver()
Получить обратный вызов разрешения маршрута.
$this setRouteResolver(Closure $callback)
Установить обратный вызов разрешения маршрута.
массив toArray()
Получить все входные данные и файлы для запроса.
bool offsetExists(строка $offset)
Определить, существует ли заданный смещение.
смешанное offsetGet(строка $offset)
Получить значение по заданному смещению.
void offsetSet(строка $offset, смешанное $value)
Установить значение по заданному смещению.
void offsetUnset(строка $offset)
Удалить значение по заданному смещению.
bool __isset(строка $key)
Проверить, установлено ли элемент ввода в запросе.
смешанное __get(строка $key)
Получить элемент ввода из запроса.
void validateResolved()
Проверить экземпляр класса.
protected void prepareForValidation()
Подготовить данные для проверки.
protected Валидатор getValidatorInstance()
Получить экземпляр валидатора для запроса.
protected void passedValidation()
Обработать успешную попытку валидации.
protected void failedValidation(Ва**лидатор $validator)
Обработать неудачную попытку валидации.
protected bool passesAuthorization()
Определить, проходит ли запрос проверку авторизации.
protected void failedAuthorization()
Обработать неудачную попытку авторизации.
protected Validator createDefaultValidator(Factory $factory)
Создать экземпляр валидатора по умолчанию.
protected 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/5.8/Illuminate/Foundation/Http/FormRequest.html