FormRequest

class FormRequest extends Request implements ValidatesWhenResolved (View source)

Свойства

Предоставляет реализацию по умолчанию контракта ValidatesWhenResolved.

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected string	$json	Декодированное JSON-содержимое запроса.	из Request
protected array	$convertedFiles	Все преобразованные файлы для запроса.	из Request
protected Closure	$userResolver	Обратный вызов резолвера пользователя.	из Request
protected Closure	$routeResolver	Обратный вызов резолвера маршрута.	из Request
protected Container	$container	Экземпляр контейнера.
protected Redirector	$redirector	Экземпляр перенаправляющего объекта.
protected string	$redirect	URI для перенаправления при ошибке валидации.
protected string	$redirectRoute	Маршрут для перенаправления при ошибке валидации.
protected string	$redirectAction	Действие контроллера для перенаправления при ошибке валидации.
protected string	$errorBag	Ключ, используемый для пакета ошибок представления.
protected array	$dontFlash	Ключи ввода, которые не должны отображаться при перенаправлении.

Методы

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() Создать новый запрос HTTP Illuminate из переменных сервера.	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 Request
bool	fullUrlIs() Определить, соответствует ли текущий 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
bool	exists(string\|array $key) Определить, содержит ли запрос заданный ключ элемента ввода.	from Request
bool	has(string\|array $key) Определить, содержит ли запрос непустое значение для элемента ввода.	from Request
bool	isEmptyString(string $key) Определить, является ли заданный ключ ввода пустой строкой для "has".	from Request
array	all() Получить все данные ввода и файлы для запроса.	from Request
string\|array	input(string $key = null, string\|array\|null $default = null) Получить элемент ввода из запроса.	from Request
array	only(array\|mixed $keys) Получить подмножество, содержащее указанные ключи со значениями из данных ввода.	from Request
array	except(array\|mixed $keys) Получить все данные ввода, кроме указанного массива элементов.	from Request
array	intersect(array\|mixed $keys) Пересечь массив элементов с данными ввода.	from Request
string\|array	query(string $key = null, string\|array\|null $default = null) Получить элемент строки запроса из запроса.	from Request
bool	hasCookie(string $key) Определить, установлен ли cookie в запросе.	from Request
string\|array	cookie(string $key = null, string\|array\|null $default = null) Получить cookie из запроса.	from Request
array	allFiles() Получить массив всех файлов в запросе.	from Request

array	convertUploadedFiles(array $files) Преобразовать заданный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles.	из Request
UploadedFile\|array\|null	file(string $key = null, mixed $default = null) Получить файл из запроса.	из Request
bool	hasFile(string $key) Определить, содержит ли загруженные данные файл.	из Request
bool	isValidFile(mixed $file) Проверить, является ли заданный файл допустимым экземпляром файла.	из Request
bool	hasHeader(string $key) Определить, установлен ли заголовок в запросе.	из Request
string\|array	header(string $key = null, string\|array\|null $default = null) Получить заголовок из запроса.	из Request
string\|array	server(string $key = null, string\|array\|null $default = null) Получить переменную сервера из запроса.	из Request
string\|array	old(string $key = null, string\|array\|null $default = null) Получить элемент ввода сохранённых ранее.	из Request
void	flash(string $filter = null, array $keys = []) Переслать данные ввода текущего запроса в сессию.	из Request
void	flashOnly(array\|mixed $keys) Переслать только некоторые данные ввода в сессию.	из Request
void	flashExcept(array\|mixed $keys) Переслать только некоторые данные ввода в сессию.	из Request
void	flush() Очистить все сохранённые ранее данные ввода из сессии.	из Request
string\|array	retrieveItem(string $source, string $key, string\|array\|null $default) Получить элемент параметра из заданного источника.	из Request
void	merge(array $input) Объединить новые данные ввода в текущий массив ввода запроса.	из Request
void	replace(array $input) Заменить данные ввода для текущего запроса.	из Request
mixed	json(string $key = null, mixed $default = null) Получить JSON-payload для запроса.	из Request
ParameterBag	getInputSource() Получить источник ввода для запроса.	из Request
static bool	matchesType(string $actual, string $type) Определить, совпадают ли заданные типы контента.	из Request
bool	isJson() Определить, отправляет ли запрос JSON.	из Request
bool	wantsJson() Определить, запрашивает ли текущий запрос JSON в ответ.	из Request
bool	accepts(string\|array $contentTypes) Определяет, принимает ли текущий запрос заданный тип контента.	из Request
string\|null	prefers(string\|array $contentTypes) Возвращает наиболее подходящий тип контента из заданного массива на основе согласования контента.	из Request
bool	acceptsJson() Определяет, принимает ли запрос JSON.	из Request
bool	acceptsHtml() Определяет, принимает ли запрос HTML.	из Request
string	format(string $default = 'html') Получить ожидаемый формат данных в ответе.	из Request
string\|null	bearerToken() Получить токен bearer из заголовков запроса.	из 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
Store	session() Получить сессию, связанную с запросом.	из Request
mixed	user(string\|null $guard = null) Получить пользователя, производящего запрос.	из Request
Route\|object\|string	route(string\|null $param = null) Получить маршрут, обрабатывающий запрос.	из Request
string	fingerprint() Получить уникальный отпечаток запроса/маршрута/IP-адреса.	из 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) Проверить, установлен ли элемент входных данных в запросе.	из Request
mixed	__get(string $key) Получить элемент входных данных из запроса.	из Request
void	validate() Проверить экземпляр класса.	из ValidatesWhenResolvedTrait
Validator	getValidatorInstance() Получить экземпляр валидатора для запроса.
void	failedValidation(Validator $validator) Обработать неудачную попытку проверки.
bool	passesAuthorization() Определить, проходит ли запрос проверку авторизации.
void	failedAuthorization() Обработать неудачную попытку авторизации.
array	validationData() Получить данные для проверки из запроса.
Response	response(array $errors) Получить соответствующий ответ при неудачной проверке для запроса.
Response	forbiddenResponse() Получить ответ для запрещенной операции.
array	formatErrors(Validator $validator) Отформатировать ошибки из данного экземпляра Validator.
string	getRedirectUrl() Получить URL для перенаправления при ошибке проверки.
$this	setRedirector(Redirector $redirector) Установить экземпляр Redirector.
$this	setContainer(Container $container) Установить реализацию контейнера.
array	messages() Получить пользовательские сообщения для ошибок валидатора.
array	attributes() Получить пользовательские атрибуты для ошибок валидатора.

Подробности

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

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

Параметры

string	$name
callable	$macro

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

void

static bool hasMacro(string $name)

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

Параметры

string

$name

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

bool

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

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

static Request capture()

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

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

Request

$this instance()

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

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

$this

string method()

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

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

string

string root()

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

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

string

END_OF_DOCUMENT_MARKER

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

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

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

bool

bool fullUrlIs()

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

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

bool

bool ajax()

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

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

bool

bool pjax()

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

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

bool

bool secure()

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

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

bool

string ip()

Возвращает IP-адрес клиента.

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

string

array ips()

Возвращает IP-адреса клиентов.

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

array

bool exists(string|array $key)

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

Параметры

string|array

$key

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

bool

bool has(string|array $key)

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

Параметры

string|array

$key

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

bool

protected bool isEmptyString(string $key)

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

Параметры

string

$key

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

bool

array all()

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

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

array

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

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

Параметры

string	$key
string\|array\|null	$default

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

string|array

array only(array|mixed $keys)

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

Параметры

array|mixed

$keys

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

array

array except(array|mixed $keys)

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

Параметры

array|mixed

$keys

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

array

array intersect(array|mixed $keys)

Пересечение массива элементов с данными ввода.

Параметры

array|mixed

$keys

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

array

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

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

Параметры

string	$key
string\|array\|null	$default

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

string|array

bool hasCookie(string $key)

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

Параметры

string

$key

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

bool

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

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

Параметры

string	$key
string\|array\|null	$default

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

string|array

array allFiles()

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

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

array

protected array convertUploadedFiles(array $files)

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

Parameters

array

$files

Return Value

array

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

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

Parameters

string	$key
mixed	$default

Return Value

UploadedFile|array|null

bool hasFile(string $key)

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

Parameters

string

$key

Return Value

bool

protected bool isValidFile(mixed $file)

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

Parameters

mixed

$file

Return Value

bool

bool hasHeader(string $key)

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

Parameters

string

$key

Return Value

bool

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

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

Parameters

string	$key
string\|array\|null	$default

Return Value

string|array

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

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

Parameters

string	$key
string\|array\|null	$default

Return Value

string|array

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

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

Parameters

string	$key
string\|array\|null	$default

Return Value

string|array

void flash(string $filter = null, array $keys = [])

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

Parameters

string	$filter
array	$keys

Return Value

void

void flashOnly(array|mixed $keys)

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

Parameters

array|mixed

$keys

Return Value

void

void flashExcept(array|mixed $keys)

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

Parameters

array|mixed

$keys

Return Value

void

void flush()

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

Return Value

void

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

void merge(array $input)

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

Parameters

array

$input

Return Value

void

void replace(array $input)

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

Parameters

array

$input

Return Value

void

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

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

Parameters

string	$key
mixed	$default

Return Value

mixed

protected ParameterBag getInputSource()

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

Return Value

ParameterBag

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

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

Parameters

string	$actual
string	$type

Return Value

bool

bool isJson()

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

Return Value

bool

bool wantsJson()

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

Return Value

bool

bool accepts(string|array $contentTypes)

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

Parameters

string|array

$contentTypes

Return Value

bool

string|null prefers(string|array $contentTypes)

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

Parameters

string|array

$contentTypes

Return Value

string|null

bool acceptsJson()

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

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

bool

bool acceptsHtml()

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

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

bool

string format(string $default = 'html')

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

Параметры

string

$default

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

string

string|null bearerToken()

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

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

string|null

static Request createFromBase(Request $request)

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

Параметры

Request

$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

Store session()

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

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

Store

Исключения

RuntimeException

mixed user(string|null $guard = null)

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

Параметры

string|null

$guard

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

mixed

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

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

Параметры

string|null

$param

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

Route|object|string

string fingerprint()

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

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

string

Исключения

RuntimeException

Closure getUserResolver()

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

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

Closure

$this setUserResolver(Closure $callback)

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

Параметры

Closure

$callback

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

$this

Closure getRouteResolver()

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

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

Closure

$this setRouteResolver(Closure $callback)

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

Параметры

Closure

$callback

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

$this

array toArray()

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

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

array

bool offsetExists(string $offset)

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

Параметры

string

$offset

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

bool

mixed offsetGet(string $offset)

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

Параметры

string

$offset

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

mixed

void offsetSet(string $offset, mixed $value)

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

Параметры

string	$offset
mixed	$value

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

void

void offsetUnset(string $offset)

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

Параметры

string

$offset

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

void

bool __isset(string $key)

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

Параметры

string

$key

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

bool

mixed __get(string $key)

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

Параметры

string

$key

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

mixed

void validate()

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

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

void

protected Validator getValidatorInstance()

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

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

Validator

protected void failedValidation(Validator $validator)

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

Параметры

Validator

$validator

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

void

Исключения

HttpResponseException

protected bool passesAuthorization()

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

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

bool

protected void failedAuthorization()

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

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

void

Исключения

HttpResponseException

protected array validationData()

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

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

array

Response response(array $errors)

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

Параметры

array

$errors

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

Response

Response forbiddenResponse()

Получить ответ для запрещённой операции.

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

Response

protected array formatErrors(Validator $validator)

Отформатировать ошибки из данного экземпляра Validator.

Параметры

Validator

$validator

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

array

protected string getRedirectUrl()

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

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

string

$this setRedirector(Redirector $redirector)

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

Параметры

Redirector

$redirector

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

$this

$this setContainer(Container $container)

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

Параметры

Container

$container

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

$this

array messages()

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

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

array

array attributes()

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

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

array

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