FormRequest
class FormRequest extends Request implements ValidatesWhenResolved (View source)
Особенности
| 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 | Ключ, используемый для пакета ошибок представления. | |
| 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 |
| $this|mixed | whenHas(string $key, callable $callback)
Применить обратный вызов, если запрос содержит заданный ключ элемента ввода. | from InteractsWithInput |
| bool | filled(string|array $key)
Определить, содержит ли запрос непустое значение для элемента ввода. | from InteractsWithInput |
| bool | isNotFilled(string|array $key)
Определить, содержит ли запрос пустое значение для элемента ввода. | from InteractsWithInput |
| bool | anyFilled(string|array $keys)
Определить, содержит ли запрос непустое значение для любого из заданных элементов ввода. | from InteractsWithInput |
| $this|mixed | whenFilled(string $key, callable $callback)
Применить обратный вызов, если запрос содержит непустое значение для заданного ключа элемента ввода. | 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)
Получить входные данные в виде логического значения. | from InteractsWithInput |
| array | only(array|mixed $keys)
Получить подмножество, содержащее указанные ключи со значениями из входных данных. | from InteractsWithInput |
| array | except(array|mixed $keys)
Получить все входные данные, кроме указанного массива элементов. | from InteractsWithInput |
| string|array|null | query(string|null $key = null, string|array|null $default = null)
Получить элемент строки запроса из запроса. | from InteractsWithInput |
| string|array|null | post(string|null $key = null, string|array|null $default = null)
Получить элемент загрузки запроса из запроса. | from InteractsWithInput |
| bool | hasCookie(string $key)
Определить, установлен ли куки в запросе. | from InteractsWithInput |
| string|array|null | cookie(string|null $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|UploadedFile[]|array|null | file(string|null $key = null, mixed $default = null)
Получить файл из запроса. | from InteractsWithInput |
| string|array|null | retrieveItem(string $source, string $key, string|array|null $default)
Получить элемент параметра из заданного источника. | from InteractsWithInput |
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | 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). | из 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|null | 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|null | 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 |
| массив | toArray()
Получить все данные ввода и файлы для запроса. | из запроса |
| логическое | offsetExists(строка $offset)
Определить, существует ли данный смещение. | из запроса |
| смешанный | offsetGet(строка $offset)
Получить значение по заданному смещению. | из запроса |
| void | offsetSet(строка $offset, смешанный $value)
Установить значение по заданному смещению. | из запроса |
| void | offsetUnset(строка $offset)
Удалить значение по заданному смещению. | из запроса |
| логическое | __isset(строка $key)
Проверить, задан ли элемент ввода в запросе. | из запроса |
| смешанный | __get(строка $key)
Получить элемент ввода из запроса. | из запроса |
| массив | validate(массив $rules, смешанный $params) Без описания | из запроса |
| массив | validateWithBag(строка $errorBag, массив $rules, смешанный $params) Без описания | из запроса |
| логическое | hasValidSignature(логическое $absolute = true) Без описания | из запроса |
| void | validateResolved()
Проверить экземпляр класса. | из ValidatesWhenResolvedTrait |
| void | prepareForValidation()
Подготовить данные для проверки. | из ValidatesWhenResolvedTrait |
| Validator | getValidatorInstance()
Получить экземпляр валидатора для запроса. | |
| void | passedValidation()
Обработать успешную попытку проверки. | из ValidatesWhenResolvedTrait |
| void | failedValidation(Validator $validator)
Обработать неудачную попытку проверки. | |
| логическое | passesAuthorization()
Определить, проходит ли запрос проверку авторизации. | |
| void | failedAuthorization()
Обработать неудачную попытку авторизации. | |
| Validator | createDefaultValidator(Factory $factory)
Создать экземпляр валидатора по умолчанию. | |
| массив | validationData()
Получить данные для проверки из запроса. | |
| строка | getRedirectUrl()
Получить URL для перенаправления при ошибке проверки. | |
| массив | validated()
Получить проверенные данные из запроса. | |
| массив | messages()
Получить настраиваемые сообщения для ошибок валидатора. | |
| массив | attributes()
Получить настраиваемые атрибуты для ошибок валидатора. | |
| $this | setValidator(Validator $validator)
Установить экземпляр Validator. | |
| $this | setRedirector(Redirector $redirector)
Установить экземпляр Redirector. | |
| $this | setContainer(Container $container)
Установить реализацию контейнера. |
Подробности
статический логическое matchesType(строка $actual, строка $type)
Определить, совпадают ли заданные типы содержимого.
логическое isJson()
Определить, отправляет ли запрос JSON.
логическое expectsJson()
Определить, ожидает ли текущий запрос ответ в формате JSON.
логическое wantsJson()
Определить, запрашивает ли текущий запрос JSON.
логическое accepts(строка|массив $contentTypes)
Определяет, принимает ли текущий запрос заданный тип содержимого.
строка|null prefers(строка|массив $contentTypes)
Возвращает наиболее подходящий тип содержимого из заданного массива на основе согласования типов содержимого.
логическое acceptsAnyContentType()
Определить, принимает ли текущий запрос любой тип содержимого.
логическое 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)
Определить, содержит ли запрос любой из заданных элементов ввода.
$this|mixed whenHas(string $key, callable $callback)
Применить обратный вызов, если запрос содержит заданный ключ элемента ввода.
bool filled(string|array $key)
Определить, содержит ли запрос ненулевое значение для элемента ввода.
bool isNotFilled(string|array $key)
Определить, содержит ли запрос пустое значение для элемента ввода.
bool anyFilled(string|array $keys)
Определить, содержит ли запрос ненулевое значение для любого из заданных элементов ввода.
$this|mixed whenFilled(string $key, callable $callback)
Применить обратный вызов, если запрос содержит ненулевое значение для заданного ключа элемента ввода.
bool missing(string|array $key)
Определить, отсутствует ли заданный ключ элемента ввода в запросе.
protected bool isEmptyString(string $key)
Определить, является ли заданный ключ элемента ввода пустой строкой для "has".
array keys()
Получить ключи для всех элементов ввода и файлов.
array all(array|mixed|null $keys = null)
Получить все элементы ввода и файлы для запроса.
mixed input(string|null $key = null, mixed $default = null)
Получить элемент ввода из запроса.
bool boolean(string|null $key = null, bool $default = false)
Получить ввод как булевое значение.
Возвращает true, когда значение равно "1", "true", "on", или "yes". В противном случае возвращает false.
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 Запрос 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(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|null userAgent()
Получить пользовательский агент клиента.
$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 Запрос 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)
Отфильтровать заданный массив файлов, удалив любые пустые значения.
Хранилище session()
Получить сеанс, связанный с запросом.
Хранилище|null getSession()
Получить сеанс, связанный с запросом.
void setLaravelSession(Сессия $session)
Установить экземпляр сессии в запросе.
mixed user(string|null $guard = null)
Получить пользователя, производящего запрос.
Маршрут|object|string|null route(string|null $param = null, mixed $default = null)
Получить маршрут, обрабатывающий запрос.
string fingerprint()
Получить уникальный отпечаток запроса/маршрута/IP-адреса.
$this setJson(ParameterBag $json)
Установить JSON-полезную нагрузку для запроса.
Замыкание getUserResolver()
Получить обратный вызов разрешителя пользователей.
$this setUserResolver(Замыкание $callback)
Установить обратный вызов разрешителя пользователей.
Замыкание getRouteResolver()
Получить обратный вызов разрешителя маршрутов.
$this setRouteResolver(Замыкание $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)
Установка экземпляра валидатора.
$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/7.x/Illuminate/Foundation/Http/FormRequest.html
