Spec-Zone.ru › Laravel 5.5

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 Ключ для использования в пакете ошибок представления.

Методы

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 hasAny($keys)

Определить, содержит ли запрос любой из заданных элементов ввода.

 from InteractsWithInput
bool filled(string|array $key)

Определить, содержит ли запрос ненулевое значение для элемента ввода.

 from InteractsWithInput
bool isEmptyString(string $key)

Определить, является ли заданный ключ элемента ввода пустой строкой для "has".

 from InteractsWithInput
array keys()

Получить ключи для всех элементов ввода и файлов.

 from InteractsWithInput
array all(array|mixed $keys = null)

Получить все элементы ввода и файлы для запроса.

 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
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)

Определить, установлен ли куки в запросе.

 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, object|callable $macro)

Зарегистрировать пользовательское макро.

 from 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()

Создать новый запрос 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(dynamic $patterns)

Определить, соответствует ли текущий URI запроса шаблону.

 from 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 Запрос
void merge(array $input)

Объединить новые данные в массив входных данных текущего запроса.

 from Запрос
void replace(array $input)

Заменить входные данные текущего запроса.

 from Запрос
mixed json(string $key = null, mixed $default = null)

Получить JSON-payload запроса.

 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)

Установить экземпляр сессии в запросе.

 from Запрос
mixed user(string|null $guard = null)

Получить пользователя, совершающего запрос.

 from Запрос
Маршрут|object|string route(string|null $param = null)

Получить маршрут, обрабатывающий запрос.

 from Запрос
string fingerprint()

Получить уникальный отпечаток запроса/маршрута/IP-адреса.

 from Запрос
$this setJson(array $json)

Установить JSON-payload запроса.

 from Запрос
Closure getUserResolver()

Получить коллбэк пользовательского резолвера.

 from Запрос
$this setUserResolver(Closure $callback)

Установить коллбэк пользовательского резолвера.

 from Запрос
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 ValidatesWhenResolvedTrait
void prepareForValidation()

Подготовить данные для проверки.

 from ValidatesWhenResolvedTrait
Валидатор getValidatorInstance()

Получить экземпляр валидатора для запроса.
void failedValidation(Валидатор $validator)

Обработать неудачную попытку проверки.
bool passesAuthorization()

Определить, проходит ли запрос проверку авторизации.
void failedAuthorization()

Обработать неудачную попытку авторизации.
Валидатор createDefaultValidator(Фабрика $factory)

Создать экземпляр валидатора по умолчанию.
array validationData()

Получить данные для проверки из запроса.
string getRedirectUrl()

Получить URL для перенаправления при ошибке проверки.
массив validated()

Получить валидированные данные из запроса.
массив messages()

Получить пользовательские сообщения для ошибок валидации.
массив attributes()

Получить пользовательские атрибуты для ошибок валидации.
$this setRedirector(Redirector $redirector)

Установить экземпляр Redirector.
$this setContainer(Container $container)

Установить реализацию контейнера.

Подробности

static bool matchesType(string $actual, string $type)

Определить, совпадают ли заданные типы контента.

Параметры

string $actual
string $type

Возвращаемое значение

bool

bool isJson()

Определить, отправляет ли запрос JSON.

Возвращаемое значение

bool

bool expectsJson()

Определить, ожидает ли текущий запрос, вероятно, JSON-ответ.

Возвращаемое значение

bool

bool wantsJson()

Определить, запрашивает ли текущий запрос JSON в ответ.

Возвращаемое значение

bool

bool accepts(string|array $contentTypes)

Определяет, принимает ли текущий запрос заданный тип контента.

Параметры

string|array $contentTypes

Возвращаемое значение

bool

string|null prefers(string|array $contentTypes)

Возвращает наиболее подходящий тип контента из заданного массива на основе согласования контента.

Параметры

string|array $contentTypes

Возвращаемое значение

string|null

bool acceptsJson()

Определяет, принимает ли запрос JSON.

Возвращаемое значение

bool

bool acceptsHtml()

Определяет, принимает ли запрос HTML.

Возвращаемое значение

bool

string format(string $default = 'html')

Получить ожидаемый формат данных в ответе.

Параметры

string $default

Возвращаемое значение

string

string|array old(string $key = null, string|array|null $default = null)

Получить старое значение ввода.

Параметры

string $key
string|array|null $default

Возвращаемое значение

string|array

void flash()

Переслать данные ввода для текущего запроса в сессию.

Возвращаемое значение

void

void flashOnly(array|mixed $keys)

Переслать только некоторые данные ввода в сессию.

Параметры

array|mixed $keys

Возвращаемое значение

void

void flashExcept(array|mixed $keys)

Переслать только некоторые данные ввода в сессию.

Параметры

array|mixed $keys

Возвращаемое значение

void

void flush()

Очистить все старые данные ввода из сессии.

Возвращаемое значение

void

string|array server(string $key = null, string|array|null $default = null)

Получить переменную сервера из запроса.

Параметры

string $key
string|array|null $default

Возвращаемое значение

string|array

bool hasHeader(string $key)

Определить, установлено ли заголовки в запросе.

Параметры

string $key

Возвращаемое значение

bool

string|array header(string $key = null, string|array|null $default = null)

Получить заголовок из запроса.

Параметры

string $key
string|array|null $default

Возвращаемое значение

string|array

string|null bearerToken()

Получить токен bearer из заголовков запроса.

Возвращаемое значение

string|null

bool exists(string|array $key)

Определить, содержит ли запрос заданный ключ элемента ввода.

Параметры

string|array $key

Возвращаемое значение

bool

bool has(string|array $key)

Определить, содержит ли запрос заданный ключ элемента ввода.

Параметры

string|array $key

Возвращаемое значение

bool

bool hasAny($keys)

Определить, содержит ли запрос любой из заданных элементов ввода.

Параметры

$keys

Возвращаемое значение

bool

bool filled(string|array $key)

Определить, содержит ли запрос ненулевое значение для элемента ввода.

Параметры

string|array $key

Возвращаемое значение

bool

protected bool isEmptyString(string $key)

Определить, является ли заданный ключ входных данных пустой строкой для "has".

Parameters

string $key

Return Value

bool

array keys()

Получить ключи для всех входных данных и файлов.

Return Value

array

array all(array|mixed $keys = null)

Получить все входные данные и файлы для запроса.

Parameters

array|mixed $keys

Return Value

array

string|array input(string $key = null, string|array|null $default = null)

Получить элемент входных данных из запроса.

Parameters

string $key
string|array|null $default

Return Value

string|array

array only(array|mixed $keys)

Получить подмножество, содержащее указанные ключи со значениями из входных данных.

Parameters

array|mixed $keys

Return Value

array

array except(array|mixed $keys)

Получить все входные данные, за исключением указанного массива элементов.

Parameters

array|mixed $keys

Return Value

array

string|array query(string $key = null, string|array|null $default = null)

Получить элемент строки запроса из запроса.

Parameters

string $key
string|array|null $default

Return Value

string|array

string|array post(string $key = null, string|array|null $default = null)

Получить элемент тела запроса из запроса.

Parameters

string $key
string|array|null $default

Return Value

string|array

bool hasCookie(string $key)

Определить, установлен ли cookie в запросе.

Parameters

string $key

Return Value

bool

string|array cookie(string $key = null, string|array|null $default = null)

Получить cookie из запроса.

Parameters

string $key
string|array|null $default

Return Value

string|array

array allFiles()

Получить массив всех файлов в запросе.

Return Value

array

protected array convertUploadedFiles(array $files)

Преобразовать заданный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles.

Parameters

array $files

Return Value

array

bool hasFile(string $key)

Определить, содержит ли загруженные данные файл.

Parameters

string $key

Return Value

bool

protected bool isValidFile(mixed $file)

Проверить, является ли данный файл допустимым экземпляром файла.

Parameters

mixed $file

Return Value

bool

UploadedFile|array|null file(string $key = null, mixed $default = null)

Получить файл из запроса.

Parameters

string $key
mixed $default

Return Value

UploadedFile|array|null

protected string|array retrieveItem(string $source, string $key, string|array|null $default)

Получить элемент параметра из заданного источника.

Parameters

string $source
string $key
string|array|null $default

Return Value

string|array

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

Добавить другой объект в класс.

Parameters

object $mixin

Return Value

void

static bool hasMacro(string $name)

Проверяет, зарегистрировано ли макро.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException
END_OF_DOCUMENT_MARKER

static Запрос capture()

Создать новый запрос HTTP Illuminate из переменных сервера.

Значение возврата

Запрос

$this instance()

Возвратить экземпляр запроса.

Значение возврата

$this

string method()

Получить метод запроса.

Значение возврата

string

string root()

Получить корневой URL приложения.

Значение возврата

string

string url()

Получить URL (без строки запроса) для запроса.

Значение возврата

string

string fullUrl()

Получить полный URL для запроса.

Значение возврата

string

string fullUrlWithQuery(array $query)

Получить полный URL для запроса с добавленными параметрами строки запроса.

Параметры

array $query

Значение возврата

string

string path()

Получить текущий путь запроса.

Значение возврата

string

string decodedPath()

Получить текущий декодированный путь запроса.

Значение возврата

string

string|null segment(int $index, string|null $default = null)

Получить сегмент из URI (индекс, основанный на 1).

Параметры

int $index
string|null $default

Значение возврата

string|null

array segments()

Получить все сегменты пути запроса.

Значение возврата

array

bool is(dynamic $patterns)

Определить, соответствует ли текущий URI запроса шаблону.

Параметры

dynamic $patterns

Значение возврата

bool

bool routeIs(dynamic $patterns)

Определить, соответствует ли имя маршрута заданному шаблону.

Параметры

dynamic $patterns

Значение возврата

bool

bool fullUrlIs(dynamic $patterns)

Определить, соответствует ли текущий URL запроса и строка запроса шаблону.

Параметры

dynamic $patterns

Значение возврата

bool

bool ajax()

Определить, является ли запрос результатом вызова AJAX.

Значение возврата

bool

bool pjax()

Определить, является ли запрос результатом вызова PJAX.

Значение возврата

bool

bool secure()

Определить, используется ли HTTPS для запроса.

Значение возврата

bool

string ip()

Получить IP-адрес клиента.

Значение возврата

string

array ips()

Получить IP-адреса клиента.

Значение возврата

array

string userAgent()

Получить пользовательский агент клиента.

Значение возврата

string

void merge(array $input)

Слить новые данные в массив входных данных текущего запроса.

Параметры

array $input

Значение возврата

void

void replace(array $input)

Заменить входные данные для текущего запроса.

Параметры

array $input

Значение возврата

void

mixed json(string $key = null, mixed $default = null)

Получить JSON-груз для запроса.

Параметры

string $key
mixed $default

Значение возврата

mixed

protected ParameterBag getInputSource()

Получить источник входных данных для запроса.

Значение возврата

ParameterBag

static Запрос createFromBase(Request $request)

Создать запрос Illuminate из экземпляра Symfony.

Параметры

Request $request

Значение возврата

Запрос

duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)

{@inheritdoc}

Параметры

array $query
array $request
array $attributes
array $cookies
array $files
array $server

protected mixed filterFiles(mixed $files)

Отфильтровать предоставленный массив файлов, удалив любые пустые значения.

Parameters

mixed $files

Return Value

mixed

Store session()

Получить сеанс, связанный с запросом.

Return Value

Store

Exceptions

RuntimeException

void setLaravelSession(Session $session)

Установить экземпляр сеанса в запросе.

Parameters

Session $session

Return Value

void

mixed user(string|null $guard = null)

Получить пользователя, производящего запрос.

Parameters

string|null $guard

Return Value

mixed

Route|object|string route(string|null $param = null)

Получить маршрут, обрабатывающий запрос.

Parameters

string|null $param

Return Value

Route|object|string

string fingerprint()

Получить уникальный отпечаток запроса/маршрута/IP-адреса.

Return Value

string

Exceptions

RuntimeException

$this setJson(array $json)

Установить JSON-полезную нагрузку для запроса.

Parameters

array $json

Return Value

$this

Closure getUserResolver()

Получить обратный вызов для разрешения пользователя.

Return Value

Closure

$this setUserResolver(Closure $callback)

Установить обратный вызов для разрешения пользователя.

Parameters

Closure $callback

Return Value

$this

Closure getRouteResolver()

Получить обратный вызов для разрешения маршрута.

Return Value

Closure

$this setRouteResolver(Closure $callback)

Установить обратный вызов для разрешения маршрута.

Parameters

Closure $callback

Return Value

$this

array toArray()

Получить все входные данные и файлы для запроса.

Return Value

array

bool offsetExists(string $offset)

Определить, существует ли указанный смещение.

Parameters

string $offset

Return Value

bool

mixed offsetGet(string $offset)

Получить значение по указанному смещению.

Parameters

string $offset

Return Value

mixed

void offsetSet(string $offset, mixed $value)

Установить значение по указанному смещению.

Parameters

string $offset
mixed $value

Return Value

void

void offsetUnset(string $offset)

Удалить значение по указанному смещению.

Parameters

string $offset

Return Value

void

bool __isset(string $key)

Проверить, установлен ли элемент входных данных в запросе.

Parameters

string $key

Return Value

bool

mixed __get(string $key)

Получить элемент входных данных из запроса.

Parameters

string $key

Return Value

mixed

void validate()

Проверить экземпляр класса.

Return Value

void

protected void prepareForValidation()

Подготовить данные для проверки.

Return Value

void

protected Validator getValidatorInstance()

Получить экземпляр валидатора для запроса.

Return Value

Validator

protected void failedValidation(Validator $validator)

Обработать попытку проверки с ошибкой.

Parameters

Validator $validator

Return Value

void

Exceptions

ValidationException

protected bool passesAuthorization()

Определить, проходит ли запрос проверку авторизации.

Возвращаемое значение

bool

protected void failedAuthorization()

Обработать неудачную попытку авторизации.

Возвращаемое значение

void

Исключения

AuthorizationException

protected Validator createDefaultValidator(Factory $factory)

Создать экземпляр валидатора по умолчанию.

Параметры

Factory $factory

Возвращаемое значение

Validator

protected array validationData()

Получить данные для валидации из запроса.

Возвращаемое значение

array

protected string getRedirectUrl()

Получить URL для перенаправления при ошибке валидации.

Возвращаемое значение

string

array validated()

Получить данные, прошедшие валидацию из запроса.

Возвращаемое значение

array

array messages()

Получить пользовательские сообщения для ошибок валидатора.

Возвращаемое значение

array

array attributes()

Получить пользовательские атрибуты для ошибок валидатора.

Возвращаемое значение

array

$this setRedirector(Redirector $redirector)

Установить экземпляр Redirector.

Параметры

Redirector $redirector

Возвращаемое значение

$this

$this setContainer(Container $container)

Установить реализацию контейнера.

Параметры

Container $container

Возвращаемое значение

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Foundation/Http/FormRequest.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API