FormRequest

class FormRequest extends Request implements ValidatesWhenResolved (View source)

Свойства

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

Свойства

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 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 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.	from Request
UploadedFile\|array\|null	file(string $key = null, mixed $default = null) Получить файл из запроса.	from Request
bool	hasFile(string $key) Определить, содержит ли загруженные данные файл.	from Request
bool	isValidFile(mixed $file) Проверить, является ли данный файл допустимым экземпляром файла.	from Request
bool	hasHeader(string $key) Определить, задан ли заголовок в запросе.	from Request
string\|array	header(string $key = null, string\|array\|null $default = null) Получить заголовок из запроса.	from Request
string\|array	server(string $key = null, string\|array\|null $default = null) Получить переменную сервера из запроса.	from Request
string\|array	old(string $key = null, string\|array\|null $default = null) Получить старое значение входных данных.	from Request
void	flash(string $filter = null, array $keys = []) Передать входные данные текущего запроса в сессию.	from Request
void	flashOnly(array\|mixed $keys) Передать в сессию только некоторые входные данные.	from Request
void	flashExcept(array\|mixed $keys) Передать в сессию только некоторые входные данные.	from Request
void	flush() Очистить все старые входные данные из сессии.	from Request
string\|array	retrieveItem(string $source, string $key, string\|array\|null $default) Получить элемент параметра из заданного источника.	from Request
void	merge(array $input) Объединить новые входные данные в массив входных данных текущего запроса.	from Request
void	replace(array $input) Заменить входные данные для текущего запроса.	from Request
mixed	json(string $key = null, mixed $default = null) Получить JSON-загрузку для запроса.	from Request
ParameterBag	getInputSource() Получить источник входных данных для запроса.	from Request
static bool	matchesType(string $actual, string $type) Определить, совпадают ли заданные типы содержимого.	from Request
bool	isJson() Определить, отправляет ли запрос JSON.	from Request
bool	expectsJson() Определить, ожидает ли текущий запрос, вероятно, JSON-ответ.	from Request
bool	wantsJson() Определить, запрашивает ли текущий запрос JSON в ответ.	from Request
bool	accepts(string\|array $contentTypes) Определяет, принимает ли текущий запрос заданный тип содержимого.	from Request
string\|null	prefers(string\|array $contentTypes) Возвращает наиболее подходящий тип содержимого из заданного массива на основе согласования типов содержимого.	from Request
bool	acceptsJson() Определяет, принимает ли запрос JSON.	from Request
bool	acceptsHtml() Определяет, принимает ли запрос HTML.	from Request
string	format(string $default = 'html') Получить ожидаемый формат данных в ответе.	from Request
string\|null	bearerToken() Получить токен доступа из заголовков запроса.	from Request
static Request	createFromBase(Request $request) Создать запрос Illuminate из экземпляра Symfony.	from Request
duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null) {@inheritdoc}	from Request
mixed	filterFiles(mixed $files) Отфильтровать заданный массив файлов, удалив пустые значения.	from Request
Store	session() Получить сеанс, связанный с запросом.	from Request
mixed	user(string\|null $guard = null) Получить пользователя, производящего запрос.	from Request
Route\|object\|string	route(string\|null $param = null) Получить маршрут, обрабатывающий запрос.	from 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
void	prepareForValidation() Подготовить данные для проверки.	из 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()

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

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

Request

END_OF_DOCUMENT_MARKER

$this instance()

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

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

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

Определить, соответствует ли текущий 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)

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

Параметры

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

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

string|array

array allFiles()

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

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

array

protected array convertUploadedFiles(array $files)

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

Параметры

array

$files

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

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

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

protected mixed filterFiles(mixed $files)

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

Параметры

mixed

$files

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

mixed

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

Подготовка данных для валидации.

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

void

protected Validator getValidatorInstance()

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

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

Validator

protected void failedValidation(Validator $validator)

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

Параметры

Validator

$validator

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

void

Исключения

ValidationException

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