Запрос формы
класс Запрос формы расширяет Запрос и реализует ValidatesWhenResolved (Просмотреть исходный код)
Трейты
| ValidatesWhenResolvedTrait | Предоставляет реализацию по умолчанию контракта ValidatesWhenResolved. |
| InteractsWithContentTypes | |
| InteractsWithFlashData | |
| InteractsWithInput | |
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные макросы строк. | from Macroable |
| protected ParameterBag|null | $json | Декодированное JSON-содержимое запроса. | from Request |
| protected array | $convertedFiles | Все преобразованные файлы для запроса. | from Request |
| protected Closure | $userResolver | Обратный вызов для разрешения пользователя. | from Request |
| protected Closure | $routeResolver | Обратный вызов для разрешения маршрута. | from Request |
| protected Container | $container | Экземпляр контейнера. | |
| protected Redirector | $redirector | Экземпляр перенаправления. | |
| protected string | $redirect | URI для перенаправления при ошибке валидации. | |
| protected string | $redirectRoute | Маршрут для перенаправления при ошибке валидации. | |
| protected string | $redirectAction | Действие контроллера для перенаправления при ошибке валидации. | |
| protected string | $errorBag | Ключ для использования в пакете ошибок представления. |
Методы
| 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 $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 | server(string $key = null, string|array|null $default = null) Получить переменную сервера из запроса. | from InteractsWithInput |
| bool | hasHeader(string $key) Определить, установлен ли заголовок в запросе. | from InteractsWithInput |
| string|array | header(string $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) Определить, содержит ли запрос указанный ключ элемента ввода. | из InteractsWithInput |
| bool | hasAny(string|array $keys) Определить, содержит ли запрос любой из указанных элементов ввода. | из InteractsWithInput |
| bool | filled(string|array $key) Определить, содержит ли запрос непустое значение для элемента ввода. | из InteractsWithInput |
| bool | anyFilled(string|array $keys) Определить, содержит ли запрос непустое значение для любого из указанных элементов ввода. | из InteractsWithInput |
| bool | isEmptyString(string $key) Определить, является ли заданный ключ элемента ввода пустой строкой для "has". | из InteractsWithInput |
| array | keys() Получить ключи всех элементов ввода и файлов. | из InteractsWithInput |
| array | all(array|mixed $keys = null) Получить все элементы ввода и файлы для запроса. | из InteractsWithInput |
| string|array|null | input(string|null $key = null, string|array|null $default = null) Получить элемент ввода из запроса. | from InteractsWithInput |
| array | only(array|mixed $keys) Получить подмножество, содержащее указанные ключи со значениями из входных данных. | from InteractsWithInput |
| array | except(array|mixed $keys) Получить все входные данные за исключением указанного массива элементов. | from InteractsWithInput |
| string|array | query(string $key = null, string|array|null $default = null) Получить элемент строки запроса из запроса. | from InteractsWithInput |
| string|array | post(string $key = null, string|array|null $default = null) Получить элемент полезной нагрузки запроса из запроса. | from InteractsWithInput |
| bool | hasCookie(string $key) Определить, установлено ли cookie в запросе. | from InteractsWithInput |
| string|array | cookie(string $key = null, string|array|null $default = null) Получить cookie из запроса. | from InteractsWithInput |
| массив | allFiles() Получить массив всех файлов в запросе. | из InteractsWithInput |
| массив | convertUploadedFiles(массив $files) Преобразовать данный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles. | из InteractsWithInput |
| bool | hasFile(строка $key) Определить, содержит ли загруженные данные файл. | из InteractsWithInput |
| bool | isValidFile(смешанный $file) Проверить, является ли данный файл допустимым объектом файла. | из InteractsWithInput |
| UploadedFile|массив|null | file(строка $key = null, смешанный $default = null) Получить файл из запроса. | из InteractsWithInput |
| строка|массив | retrieveItem(строка $source, строка $key, строка|массив|null $default) Получить элемент параметра из заданного источника. | из InteractsWithInput |
| статический void | macro(строка $name, объект|вызываемый $macro) Зарегистрировать пользовательский макрос. | из Macroable |
| static void | mixin(object $mixin) Смешать другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name) Проверка, зарегистрирован ли макрос. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters) Динамическая обработка вызовов класса. | from Macroable |
| mixed | __call(string $method, array $parameters) Динамическая обработка вызовов класса. | from Macroable |
| static Request | capture() Создать новый запрос HTTP Illuminate из переменных сервера. | from Request |
| $this | instance() Возвратить экземпляр Request. | from Request |
| string | method() Получить метод запроса. | from Request |
| string | root() Получить корневой URL приложения. | from Request |
| string | url() Получить URL запроса (без строки запроса). | из Request |
| string | fullUrl() Получить полный URL запроса. | из Request |
| string | fullUrlWithQuery(array $query) Получить полный URL запроса с добавленными параметрами строки запроса. | из Request |
| string | path() Получить текущую информацию о пути запроса. | из Request |
| string | decodedPath() Получить текущую декодированную информацию о пути запроса. | из Request |
| string|null | segment(int $index, string|null $default = null) Получить сегмент из URI (индекс с 1). | из Request |
| array | segments() Получить все сегменты пути запроса. | из Request |
| bool | is(dynamic $patterns) Определить, соответствует ли текущий URI запроса шаблону. | из Request |
| bool | routeIs(dynamic $patterns) Определить, соответствует ли имя маршрута заданному шаблону. | from Request |
| bool | fullUrlIs(dynamic $patterns) Определить, соответствует ли текущий URL-адрес запроса и строка запроса шаблону. | from Request |
| bool | ajax() Определить, является ли запрос результатом вызова AJAX. | from Request |
| bool | pjax() Определить, является ли запрос результатом вызова PJAX. | from Request |
| bool | secure() Определить, используется ли HTTPS для запроса. | from Request |
| string | ip() Получить IP-адрес клиента. | from Request |
| array | ips() Получить IP-адреса клиента. | from Request |
| string | userAgent() Получить пользовательский агент клиента. | from Request |
| Запрос | merge(array $input) Объединить новые данные в массив данных текущего запроса. | из Запрос |
| Запрос | replace(array $input) Заменить данные текущего запроса. | из Запрос |
| mixed | get(string $key, mixed $default = null) Этот метод принадлежит Symfony HttpFoundation и обычно не нужен при использовании Laravel. | из Запрос |
| ParameterBag|mixed | json(string $key = null, mixed $default = null) Получить JSON-payload запроса. | из Запрос |
| ParameterBag | getInputSource() Получить источник данных запроса. | из Запрос |
| static Запрос | createFrom(Запрос $from, Запрос|null $to = null) Создать новый экземпляр запроса из заданного запроса Laravel. | из Запрос |
| static Запрос | 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} | from Запрос | |
| mixed | filterFiles(mixed $files) Фильтрует заданный массив файлов, удаляя пустые значения. | from Запрос |
| Хранилище | session() Получить сеанс, связанный с запросом. | from Запрос |
| Хранилище|null | getSession() Получить сеанс, связанный с запросом. | from Запрос |
| void | setLaravelSession(Сессия $session) Установить экземпляр сеанса в запросе. | from Запрос |
| mixed | user(string|null $guard = null) Получить пользователя, совершающего запрос. | from Запрос |
| Маршрут|object|string | route(string|null $param = null) Получить маршрут, обрабатывающий запрос. | from Запрос |
| string | fingerprint() Получить уникальный отпечаток запроса/маршрута/IP-адреса. | from Request |
| $this | setJson(ParameterBag $json) Установить JSON-payload для запроса. | 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 |
| смешанный | offsetGet(string $offset) Получить значение по заданному смещению. | из Request |
| void | offsetSet(string $offset, mixed $value) Установить значение по заданному смещению. | из Request |
| void | offsetUnset(string $offset) Удалить значение по заданному смещению. | из Request |
| bool | __isset(string $key) Проверить, задан ли элемент ввода в запросе. | из Request |
| смешанный | __get(string $key) Получить элемент ввода из запроса. | из Request |
| void | validateResolved() Проверить экземпляр класса. | из ValidatesWhenResolvedTrait |
| void | prepareForValidation() Подготовить данные для проверки. | из ValidatesWhenResolvedTrait |
| Validator | getValidatorInstance() Получить экземпляр валидатора для запроса. |
| void | failedValidation(Validator $validator) Обработать попытку проверки с ошибкой. | |
| bool | passesAuthorization() Определить, проходит ли запрос проверку авторизации. | |
| void | failedAuthorization() Обработать попытку авторизации с ошибкой. | |
| Validator | createDefaultValidator(Factory $factory) Создать экземпляр валидатора по умолчанию. | |
| array | validationData() Получить данные для проверки из запроса. | |
| string | getRedirectUrl() Получить URL для перенаправления при ошибке проверки. | |
| array | validated() Получить проверенные данные из запроса. | |
| array | messages() Получить пользовательские сообщения для ошибок валидатора. | |
| array | attributes() Получить пользовательские атрибуты для ошибок валидатора. | |
| $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 $key = null, string|array|null $default = null)
Получить элемент ввода из старых данных.
void flash()
Вывести входные данные текущего запроса в сессию.
void flashOnly(array|mixed $keys)
Вывести только часть входных данных в сессию.
void flashExcept(array|mixed $keys)
Вывести только часть входных данных в сессию.
void flush()
Очистить все старые входные данные из сессии.
string|array server(string $key = null, string|array|null $default = null)
Получить переменную сервера из запроса.
bool hasHeader(string $key)
Определить, установлен ли заголовок в запросе.
string|array header(string $key = null, string|array|null $default = null)
Получить заголовок из запроса.
string|null bearerToken()
Получить токен доступа из заголовков запроса.
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 $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 query(string $key = null, string|array|null $default = null)
Получить элемент строки запроса из запроса.
string|array post(string $key = null, string|array|null $default = null)
Получить элемент содержимого запроса из запроса.
bool hasCookie(string $key)
Определить, установлено ли cookie в запросе.
string|array cookie(string $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)
Проверка, является ли заданный файл допустимым экземпляром файла.
ЗагруженныйФайл|array|null file(string $key = null, mixed $default = null)
Получение файла из запроса.
protected string|array retrieveItem(string $source, string $key, string|array|null $default)
Получение элемента параметра из заданного источника.
static void macro(string $name, object|callable $macro)
Регистрация пользовательского макроса.
static void mixin(object $mixin)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
static Запрос capture()
Создать новый запрос Illuminate HTTP из переменных сервера.
$this instance()
Возвращает экземпляр запроса.
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(dynamic $patterns)
Определить, соответствует ли текущий URI шаблону.
bool routeIs(dynamic $patterns)
Определить, соответствует ли имя маршрута заданному шаблону.
bool fullUrlIs(dynamic $patterns)
Определить, соответствует ли текущий URL-адрес запроса и строка запроса шаблону.
bool ajax()
Определить, является ли запрос результатом вызова AJAX.
bool pjax()
Определить, является ли запрос результатом вызова PJAX.
bool secure()
Определить, происходит ли запрос по протоколу HTTPS.
string ip()
Получить IP-адрес клиента.
array ips()
Получить IP-адреса клиента.
string userAgent()
Получить пользовательский агент клиента.
Запрос merge(массив $input)
Объединить новые данные в текущий массив данных запроса.
Запрос replace(массив $input)
Заменить данные запроса на новые.
смешанный тип get(строка $key, смешанный тип $default = null)
Этот метод принадлежит Symfony HttpFoundation и обычно не нужен при использовании Laravel.
Вместо этого можно использовать метод "input".
ParameterBag|смешанный тип json(строка $key = null, смешанный тип $default = null)
Получить JSON-данные запроса.
protected ParameterBag getInputSource()
Получить источник данных запроса.
static Запрос createFrom(Запрос $from, Запрос|null $to = null)
Создать новый экземпляр запроса из заданного Laravel-запроса.
static Запрос createFromBase(Запрос $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 route(string|null $param = 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)
Получить входное поле из запроса.
void validateResolved()
Проверить экземпляр класса.
protected void prepareForValidation()
Подготовить данные для проверки.
protected Validator getValidatorInstance()
Получить экземпляр валидатора для запроса.
protected void failedValidation(Validator $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 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.6/Illuminate/Foundation/Http/FormRequest.html