FormRequest
class FormRequest extends Request implements ValidatesWhenResolved (View source)
Свойства
| ValidatesWhenResolvedTrait | Предоставляет реализацию по умолчанию контракта ValidatesWhenResolved. |
| InteractsWithContentTypes | |
| InteractsWithFlashData | |
| InteractsWithInput | |
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные макросы строк. | from Macroable |
| protected string | $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 | Ключ для использования в пакете ошибок представления. | |
| protected array | $dontFlash | Ключи ввода, которые не должны быть отображены при перенаправлении. |
Методы
| 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 | 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) Определить, содержит ли запрос значение, отличное от пустого, для входного элемента. | from InteractsWithInput |
| bool | isEmptyString(string $key) Определить, является ли заданный входной ключ пустой строкой для «has». | from InteractsWithInput |
| array | all() Получить все входные данные и файлы для запроса. | from InteractsWithInput |
| string|array | input(string $key = null, string|array|null $default = null) Получить элемент входных данных из запроса. | from InteractsWithInput |
| array | only(array|mixed $keys) Получить подмножество, содержащее предоставленные ключи со значениями из входных данных. | from InteractsWithInput |
| array | except(array|mixed $keys) Получить все входные данные, за исключением указанного массива элементов. | from InteractsWithInput |
| array | intersect(array|mixed $keys) Пересечь массив элементов с входными данными. | from InteractsWithInput |
| string|array | query(string $key = null, string|array|null $default = null) Получить элемент строки запроса из запроса. | from InteractsWithInput |
| bool | hasCookie(string $key) Определить, установлен ли куки в запросе. | from InteractsWithInput |
| string|array | cookie(string $key = null, string|array|null $default = null) Получить куки из запроса. | from InteractsWithInput |
| array | allFiles() Получить массив всех файлов в запросе. | from InteractsWithInput |
| array | convertUploadedFiles(array $files) Преобразовать массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles. | from InteractsWithInput |
| bool | hasFile(string $key) Определить, содержит ли загруженные данные файл. | from InteractsWithInput |
| bool | isValidFile(mixed $file) Проверить, является ли данный файл допустимым экземпляром файла. | from InteractsWithInput |
| UploadedFile|array|null | file(string $key = null, mixed $default = null) Получить файл из запроса. | from InteractsWithInput |
| string|array | retrieveItem(string $source, string $key, string|array|null $default) Извлечь элемент параметра из заданного источника. | from InteractsWithInput |
| static void | macro(string $name, callable $macro) Зарегистрировать пользовательское макрос. | 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() Создать новый запрос Illuminate HTTP из переменных сервера. | from Request |
| $this | instance() Возвращает экземпляр Request. | from Request |
| string | method() Получить метод запроса. | from Request |
| string | root() Получить корневой URL-адрес приложения. | from Request |
| string | url() Получить URL-адрес запроса (без строки запроса). | from Request |
| string | fullUrl() Получить полный URL-адрес запроса. | from Request |
| string | fullUrlWithQuery(array $query) Получить полный URL-адрес запроса с добавленными параметрами строки запроса. | from Request |
| string | path() Получить текущую информацию о пути запроса. | from Request |
| string | decodedPath() Получить текущую закодированную информацию о пути запроса. | from Request |
| string|null | segment(int $index, string|null $default = null) Получить сегмент URI (индекс с основанием 1). | from Request |
| array | segments() Получить все сегменты пути запроса. | from Request |
| bool | is() Определить, соответствует ли текущий URI запроса шаблону. | from Запрос |
| bool | routeIs(string $name) Проверить, соответствует ли имя маршрута заданной строке. | from Запрос |
| bool | fullUrlIs() Определить, соответствует ли текущий URL запроса и строка запроса шаблону. | from Запрос |
| bool | ajax() Определить, является ли запрос результатом вызова AJAX. | from Запрос |
| bool | pjax() Определить, является ли запрос результатом вызова PJAX. | from Запрос |
| bool | secure() Определить, осуществляется ли запрос по протоколу HTTPS. | from Запрос |
| string | ip() Получить IP-адрес клиента. | from Запрос |
| array | ips() Получить IP-адреса клиента. | from Запрос |
| string | userAgent() Получить пользовательский агент клиента. | from Запрос |
| void | merge(array $input) Объединить новые входные данные в массив входных данных текущего запроса. | from Запрос |
| void | replace(array $input) Заменить входные данные текущего запроса. | from Запрос |
| mixed | json(string $key = null, mixed $default = null) Получить JSON-данные запроса. | from Запрос |
| ParameterBag | getInputSource() Получить источник входных данных запроса. | from Запрос |
| static Запрос | createFromBase(Request $request) Создать запрос Illuminate из экземпляра Symfony. | from Запрос |
| 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 Запрос |
| void | setLaravelSession(Session $session) Установить экземпляр сессии для запроса. | from Request |
| mixed | user(string|null $guard = null) Получить пользователя, совершающего запрос. | from Request |
| Route|object|string | route(string|null $param = null) Получить маршрут, обрабатывающий запрос. | from Request |
| string | fingerprint() Получить уникальный отпечаток запроса/маршрута/IP-адреса. | from Request |
| $this | setJson(array $json) Установить JSON-payload для запроса. | from Request |
| Closure | getUserResolver() Получить коллбек-функцию для разрешения пользователя. | from Request |
| $this | setUserResolver(Closure $callback) Установить коллбек-функцию для разрешения пользователя. | from Request |
| Closure | getRouteResolver() Получить коллбэк-функцию разрешения маршрутов. | from Запрос |
| $this | setRouteResolver(Closure $callback) Установить коллбэк-функцию разрешения маршрутов. | from Запрос |
| array | toArray() Получить все входные данные и файлы для запроса. | from Запрос |
| bool | offsetExists(string $offset) Определить, существует ли заданный смещение. | from Запрос |
| mixed | offsetGet(string $offset) Получить значение по заданному смещению. | from Запрос |
| void | offsetSet(string $offset, mixed $value) Установить значение по заданному смещению. | from Запрос |
| void | offsetUnset(string $offset) Удалить значение по заданному смещению. | from Запрос |
| bool | __isset(string $key) Проверить, задан ли элемент входных данных в запросе. | from Запрос |
| mixed | __get(string $key) Получить элемент ввода из запроса. | from Запрос |
| void | validate() Проверить экземпляр класса. | from Trait ValidatesWhenResolved |
| void | prepareForValidation() Подготовить данные для проверки. | from Trait ValidatesWhenResolved |
| Validator | getValidatorInstance() Получить экземпляр валидатора для запроса. | |
| void | failedValidation(Validator $validator) Обработать неудачную попытку проверки. | |
| bool | passesAuthorization() Определить, проходит ли запрос проверку авторизации. | |
| void | failedAuthorization() Обработать неудачную попытку авторизации. | |
| Validator | createDefaultValidator(Factory $factory) Создать экземпляр валидатора по умолчанию. |
| массив | validationData() Получить данные для валидации из запроса. | |
| Ответ | response(array $errors) Получить правильный ответ для запроса с ошибками валидации. | |
| массив | formatErrors(Validator $validator) Отформатировать ошибки из данного экземпляра Validator. | |
| строка | getRedirectUrl() Получить URL для перенаправления при ошибке валидации. | |
| массив | messages() Получить настраиваемые сообщения для ошибок валидации. | |
| массив | 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 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)
Определить, содержит ли запрос ненулевое значение для элемента ввода.
protected bool isEmptyString(string $key)
Определить, является ли заданный ключ ввода пустой строкой для "has".
array all()
Получить все входные данные и файлы для запроса.
string|array input(string $key = null, string|array|null $default = null)
Получить элемент ввода из запроса.
array only(array|mixed $keys)
Получить подмножество, содержащее предоставленные ключи со значениями из входных данных.
array except(array|mixed $keys)
Получить все входные данные, кроме указанного массива элементов.
array intersect(array|mixed $keys)
Пересечение массива элементов с входными данными.
string|array query(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)
Проверить, является ли данный файл допустимым объектом файла.
UploadedFile|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, callable $macro)
Зарегистрировать пользовательскую макрос.
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()
Определить, соответствует ли текущий URI запроса шаблону.
bool routeIs(string $name)
Проверка, совпадает ли имя маршрута с заданной строкой.
bool fullUrlIs()
Определяет, соответствует ли текущий URL-адрес запроса и строка запроса шаблону.
bool ajax()
Определяет, является ли запрос результатом вызова AJAX.
bool pjax()
Определяет, является ли запрос результатом вызова PJAX.
bool secure()
Определяет, осуществляется ли запрос по протоколу HTTPS.
string ip()
Получить IP-адрес клиента.
array ips()
Получить IP-адреса клиента.
string userAgent()
Получить строку пользовательского агента.
void merge(array $input)
Объединить новые данные в массив входных данных текущего запроса.
void replace(array $input)
Заменить входные данные текущего запроса.
mixed json(string $key = null, mixed $default = null)
Получить JSON-данные запроса.
protected ParameterBag getInputSource()
Получить источник входных данных запроса.
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)
Отфильтровать предоставленный массив файлов, удалив любые пустые значения.
Хранилище session()
Получить сессию, связанную с запросом.
void setLaravelSession(Сессия $session)
Установить экземпляр сессии в запросе.
mixed user(string|null $guard = null)
Получить пользователя, производящего запрос.
Маршрут|object|string route(string|null $param = null)
Получить маршрут, обрабатывающий запрос.
string fingerprint()
Получить уникальный отпечаток запроса/маршрута/IP-адреса.
$this setJson(array $json)
Установить JSON-payload для запроса.
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 validate()
Проверить экземпляр класса.
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()
Получить данные для валидации из запроса.
Response response(array $errors)
Получить правильный ответ при ошибке валидации для запроса.
protected array formatErrors(Validator $validator)
Отформатировать ошибки из экземпляра Validator.
protected string getRedirectUrl()
Получить URL для перенаправления при ошибке валидации.
array messages()
Получить пользовательские сообщения для ошибок валидации.
array attributes()
Получить пользовательские атрибуты для ошибок валидации.
$this setRedirector(Перенаправитель $redirector)
Установить экземпляр Перенаправителя.
$this setContainer(Контейнер $container)
Установить реализацию контейнера.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Foundation/Http/FormRequest.html
