Запрос

класс Запрос наследует Request, реализует Arrayable, ArrayAccess (Просмотреть исходный код)

Трейты

Свойства

статический защищённый массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищённая строка	$json	Декодированное JSON-содержимое запроса.
защищённый массив	$convertedFiles	Все преобразованные файлы для запроса.
защищённая замыкание	$userResolver	Обратный вызов для разрешения пользователя.
защищённая замыкание	$routeResolver	Обратный вызов для разрешения маршрута.

Методы

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

array	convertUploadedFiles(array $files) Преобразовать предоставленный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles.	из InteractsWithInput
bool	hasFile(string $key) Определить, содержит ли загруженные данные файл.	из InteractsWithInput
bool	isValidFile(mixed $file) Проверить, является ли данный файл допустимым экземпляром файла.	из InteractsWithInput
UploadedFile\|array\|null	file(string $key = null, mixed $default = null) Получить файл из запроса.	из InteractsWithInput
string\|array	retrieveItem(string $source, string $key, string\|array\|null $default) Получить элемент параметра из заданного источника.	из InteractsWithInput
static void	macro(string $name, callable $macro) Зарегистрировать пользовательское макрокоманду.	из Macroable
static bool	hasMacro(string $name) Проверить, зарегистрирована ли макрокоманда.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обработать вызовы к классу.	из Macroable
mixed	__call(string $method, array $parameters) Динамически обработать вызовы к классу.	из Macroable
static Request	capture() Создать новый запрос Illuminate HTTP из переменных сервера.
$this	instance() Возвратить экземпляр Request.
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() Определить, соответствует ли текущий URI запроса шаблону.
bool	routeIs(string $name) Проверить, соответствует ли имя маршрута заданной строке.
bool	fullUrlIs() Определить, соответствует ли текущий URL и строка запроса запроса шаблону.
bool	ajax() Определить, является ли запрос результатом вызова AJAX.
bool	pjax() Определить, является ли запрос результатом вызова PJAX.
bool	secure() Определить, осуществляется ли запрос по протоколу HTTPS.
string	ip() Получить IP-адрес клиента.
array	ips() Получить IP-адреса клиентов.
string	userAgent() Получить пользовательский агент клиента.
void	merge(array $input) Объединить новые входные данные в текущий массив входных данных запроса.
void	replace(array $input) Заменить входные данные для текущего запроса.
mixed	json(string $key = null, mixed $default = null) Получить JSON-загрузку для запроса.
ParameterBag	getInputSource() Получить источник входных данных для запроса.
static Request	createFromBase(Request $request) Создать запрос Illuminate из экземпляра Symfony.
duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null) {@inheritdoc}
mixed	filterFiles(mixed $files) Отфильтровать предоставленный массив файлов, удалив любые пустые значения.
Store	session() Получить сеанс, связанный с запросом.
void	setLaravelSession(Session $session) Установить экземпляр сеанса в запросе.
mixed	user(string\|null $guard = null) Получить пользователя, отправляющего запрос.
Route\|object\|string	route(string\|null $param = null) Получить маршрут, обрабатывающий запрос.
string	fingerprint() Получить уникальный отпечаток запроса/маршрута/IP-адреса.
$this	setJson(array $json) Установить JSON-загрузку для запроса.
Closure	getUserResolver() Получить обратный вызов обработчика пользователя.
$this	setUserResolver(Closure $callback) Установить обратный вызов обработчика пользователя.

Closure	getRouteResolver() Получить коллбек обработчика маршрутов.
$this	setRouteResolver(Closure $callback) Установить коллбек обработчика маршрутов.
массив	toArray() Получить все входные данные и файлы для запроса.
bool	offsetExists(string $offset) Определить, существует ли заданный смещение.
смешанный тип	offsetGet(string $offset) Получить значение по заданному смещению.
void	offsetSet(string $offset, mixed $value) Установить значение по заданному смещению.
void	offsetUnset(string $offset) Удалить значение по заданному смещению.
bool	__isset(string $key) Проверить, установлен ли элемент ввода в запросе.
смешанный тип	__get(string $key) Получить элемент ввода из запроса.

Подробности

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

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.

Параметры

array

$files

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

array

bool hasFile(string $key)

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

Параметры

string

$key

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

bool

protected bool isValidFile(mixed $file)

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

Параметры

mixed

$file

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

bool

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

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

Параметры

string	$key
mixed	$default

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

UploadedFile|array|null

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

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

Параметры

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

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

string|array

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

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 routeIs(string $name)

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

Параметры

string

$name

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

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

string userAgent()

Получить user agent клиента.

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

string

void merge(array $input)

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

Параметры

array

$input

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

void

void replace(array $input)

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

Параметры

array

$input

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

void

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

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

Параметры

string	$key
mixed	$default

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

mixed

protected ParameterBag getInputSource()

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

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

ParameterBag

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

void setLaravelSession(Session $session)

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

Параметры

Session

$session

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

void

mixed user(string|null $guard = null)

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

Parameters

string|null

$guard

Return Value

mixed

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

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

Parameters

string|null

$param

Return Value

Маршрут|object|string

string fingerprint()

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

Return Value

string

Exceptions

RuntimeException

$this setJson(array $json)

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

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

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