FormRequest

class FormRequest extends Request implements ValidatesWhenResolved (View source)

Свойства

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

Свойства

protected string	$json	Декодированное JSON-содержимое запроса.	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 Request	capture() Создать новый запрос HTTP Illuminate из переменных сервера.	из Request
$this	instance() Возвратить экземпляр Request.	из Request
string	method() Получить метод запроса.	из Request
string	root() Получить корневой URL приложения.	из Request
string	url() Получить URL (без строки запроса) для запроса.	из Request
string	fullUrl() Получить полный URL для запроса.	из Request
string	path() Получить текущий путь информации для запроса.	из Request
string	decodedPath() Получить текущую закодированную информацию о пути для запроса.	из Request
string\|null	segment(int $index, string\|null $default = null) Получить сегмент из URI (индекс с 1).	из Request
array	segments() Получить все сегменты для пути запроса.	из Request
bool	is() Определить, соответствует ли текущий URI запроса шаблону.	из Request
bool	ajax() Определить, является ли запрос результатом вызова AJAX.	из Request
bool	pjax() Определить, является ли запрос результатом вызова PJAX.	из Request
bool	secure() Определить, осуществляется ли запрос по протоколу HTTPS.	из Request
string	ip() Возвращает IP-адрес клиента.	из Request
array	ips() Возвращает IP-адреса клиентов.	из Request
bool	exists(string\|array $key) Определить, содержит ли запрос заданный ключ элемента ввода.	из Request
bool	has(string\|array $key) Определить, содержит ли запрос ненулевое значение для элемента ввода.	из Request
bool	isEmptyString(string $key) Определить, является ли заданный ключ элемента ввода пустой строкой для "has".	из Request
array	all() Получить все данные ввода и файлы для запроса.	из Request
string\|array	input(string $key = null, string\|array\|null $default = null) Извлечь элемент ввода из запроса.	из Request
array	only(array $keys) Получить подмножество элементов из данных ввода.	из Request
array	except(array\|mixed $keys) Получить все данные ввода за исключением указанного набора элементов.	из Request
string\|array	query(string $key = null, string\|array\|null $default = null) Извлечь элемент строки запроса из запроса.	из Request
bool	hasCookie(string $key) Определить, установлен ли куки в запросе.	из Request
string\|array	cookie(string $key = null, string\|array\|null $default = null) Извлечь куки из запроса.	из Request
UploadedFile\|array\|null	file(string $key = null, mixed $default = null) Извлечь файл из запроса.	из Request
bool	hasFile(string $key) Определить, содержит ли загруженные данные файл.	из Request
bool	isValidFile(mixed $file) Проверить, является ли данный файл допустимым экземпляром файла.	из 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) Переслать только некоторые данные ввода в сессию.	from 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-данные для запроса.	из 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
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() Получить пользователя, делающего запрос.	из Request
Route\|object\|string	route(string\|null $param = null) Получить маршрут, обрабатывающий запрос.	из Request
Closure	getUserResolver() Получить обратный вызов решателя пользователя.	из Request
$this	setUserResolver(Closure $callback) Установить обратный вызов решателя пользователя.	из Request
Closure	getRouteResolver() Получить обратный вызов решателя маршрута.	из Request
$this	setRouteResolver(Closure $callback) Установить обратный вызов решателя маршрута.	из 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() Получить экземпляр валидатора для запроса.
mixed	failedValidation(Validator $validator) Обработать неудачную попытку валидации.
bool	passesAuthorization() Определить, проходит ли запрос проверку авторизации.
mixed	failedAuthorization() Обработать неудачную попытку авторизации.

Ответ	response(array $errors) Получить соответствующий ответ при неудачной валидации запроса.
Ответ	forbiddenResponse() Получить ответ для запрещенной операции.
массив	formatErrors(Validator $validator) Отформатировать ошибки из данного экземпляра Validator.
строка	getRedirectUrl() Получить URL для перенаправления при ошибке валидации.
Запрос формы	setRedirector(Redirector $redirector) Установить экземпляр Redirector.
$this	setContainer(Контейнер $container) Установить реализацию контейнера.
массив	messages() Установить пользовательские сообщения для ошибок валидации.
массив	attributes() Установить пользовательские атрибуты для ошибок валидации.

Подробности

static Запрос capture()

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

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

Запрос

$this instance()

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

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

$this

строка method()

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

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

строка

строка root()

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

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

строка

строка url()

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

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

строка

строка fullUrl()

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

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

строка

строка path()

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

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

строка

строка decodedPath()

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

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

строка

строка|null segment(int $index, string|null $default = null)

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

Параметры

int	$index
строка\|null	$default

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

строка|null

массив segments()

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

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

массив

bool is()

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

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

bool

bool ajax()

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

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

bool

bool pjax()

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

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

bool

bool secure()

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

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

bool

строка ip()

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

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

строка

массив ips()

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

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

массив

bool exists(string|array $key)

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

Параметры

строка|массив

$key

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

bool

bool has(string|array $key)

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

Параметры

строка|массив

$key

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

bool

protected bool isEmptyString(string $key)

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

Параметры

строка

$key

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

bool

массив all()

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

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

массив

строка|массив input(string $key = null, string|array|null $default = null)

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

Параметры

строка	$key
строка\|массив\|null	$default

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

строка|массив

массив only(array $keys)

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

Параметры

массив

$keys

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

массив

array except(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

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

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

Параметры

string	$key
mixed	$default

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

UploadedFile|array|null

bool hasFile(string $key)

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

Параметры

string

$key

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

bool

protected bool isValidFile(mixed $file)

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

Параметры

mixed

$file

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

bool

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

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

Параметры

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

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

string|array

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

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

Параметры

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

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

string|array

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

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

Параметры

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

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

string|array

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

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

Параметры

string	$filter
array	$keys

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

void

void flashOnly(array|mixed $keys)

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

Параметры

array|mixed

$keys

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

void

void flashExcept(array|mixed $keys)

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

Параметры

array|mixed

$keys

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

void

void flush()

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

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

void

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

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

Параметры

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

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

string|array

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 bool matchesType(string $actual, string $type)

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

Параметры

string	$actual
string	$type

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

bool

bool isJson()

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

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

bool

bool wantsJson()

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

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

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.

Return Value

bool

bool acceptsHtml()

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

Return Value

bool

string format(string $default = 'html')

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

Parameters

string

$default

Return Value

string

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

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

Parameters

Запрос

$request

Return Value

Запрос

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

{@inheritdoc}

Parameters

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

Хранилище session()

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

Return Value

Хранилище

Exceptions

RuntimeException

mixed user()

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

Return Value

mixed

Маршрут|object|string route(string|null $param = null)

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

Parameters

string|null

$param

Return Value

Маршрут|object|string

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

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 Валидатор getValidatorInstance()

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

Return Value

Валидатор

protected mixed failedValidation(Validator $validator)

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

Параметры

Validator

$validator

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

mixed

protected bool passesAuthorization()

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

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

bool

protected mixed failedAuthorization()

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

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

mixed

Response response(array $errors)

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

Параметры

array

$errors

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

Response

Response forbiddenResponse()

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

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

Response

protected array formatErrors(Validator $validator)

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

Параметры

Validator

$validator

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

array

protected string getRedirectUrl()

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

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

string

FormRequest setRedirector(Redirector $redirector)

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

Параметры

Redirector

$redirector

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

FormRequest

$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.1/Illuminate/Foundation/Http/FormRequest.html