Запрос

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

Трейты

Свойства

статический защищённый массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищённый ParameterBag\|null	$json	Декодированное JSON-содержимое запроса.
защищённый массив	$convertedFiles	Все преобразованные файлы для запроса.
защищённый Closure	$userResolver	Обратный вызов для получения пользователя.
защищённый Closure	$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	acceptsAnyContentType() Определить, принимает ли текущий запрос любой тип содержимого.	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(string\|array $keys) Определить, содержит ли запрос любой из заданных элементов ввода.	from InteractsWithInput
bool	filled(string\|array $key) Определить, содержит ли запрос значение, отличное от пустого, для элемента ввода.	from InteractsWithInput
bool	anyFilled(string\|array $keys) Определить, содержит ли запрос значение, отличное от пустого, для любого из заданных элементов ввода.	from InteractsWithInput
bool	isEmptyString(string $key) Определить, является ли заданный ключ ввода пустой строкой для "has".	from InteractsWithInput
array	keys() Получить ключи для всех элементов ввода и файлов.	from InteractsWithInput
array	all(array\|mixed $keys = null) Получить все элементы ввода и файлы для запроса.	from InteractsWithInput
string\|array\|null	input(string\|null $key = null, string\|array\|null $default = null) Получить элемент ввода из запроса.	from InteractsWithInput
array	only(array\|mixed $keys) Получить подмножество, содержащее предоставленные ключи со значениями из данных ввода.	from InteractsWithInput

массив	except(массив\|смешанный $keys) Получить все входные данные, за исключением указанного массива элементов.	из InteractsWithInput
строка\|массив	query(строка $key = null, строка\|массив\|null $default = null) Извлечь элемент строки запроса из запроса.	из InteractsWithInput
строка\|массив	post(строка $key = null, строка\|массив\|null $default = null) Извлечь элемент тела запроса из запроса.	из InteractsWithInput
булево	hasCookie(строка $key) Определить, установлен ли cookie в запросе.	из InteractsWithInput
строка\|массив	cookie(строка $key = null, строка\|массив\|null $default = null) Извлечь cookie из запроса.	из InteractsWithInput
массив	allFiles() Получить массив всех файлов в запросе.	из InteractsWithInput
массив	convertUploadedFiles(массив $files) Преобразовать предоставленный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles.	из InteractsWithInput
булево	hasFile(строка $key) Определить, содержит ли загруженные данные файл.	из InteractsWithInput
булево	isValidFile(смешанный $file) Проверить, является ли данный файл допустимым экземпляром файла.	из InteractsWithInput
UploadedFile\|массив\|null	file(строка $key = null, смешанный $default = null) Извлечь файл из запроса.	из InteractsWithInput
строка\|массив	retrieveItem(строка $source, строка $key, строка\|массив\|null $default) Извлечь элемент параметра из заданного источника.	из InteractsWithInput
статический void	macro(строка $name, объект\|вызов $macro) Зарегистрировать пользовательский макрос.	из Macroable
статический void	mixin(объект $mixin) Смешать другой объект в класс.	из Macroable
статический булево	hasMacro(строка $name) Проверяет, зарегистрирован ли макрос.	из Macroable
статический смешанный	__callStatic(строка $method, массив $parameters) Динамически обрабатывать вызовы класса.	из Macroable
смешанный	__call(строка $method, массив $parameters) Динамически обрабатывать вызовы класса.	из Macroable
статический Request	capture() Создать новый запрос Illuminate HTTP из переменных сервера.
$this	instance() Возвращает экземпляр Request.
строка	method() Получить метод запроса.
строка	root() Получить корневой URL приложения.
строка	url() Получить URL (без строки запроса) для запроса.
строка	fullUrl() Получить полный URL для запроса.
строка	fullUrlWithQuery(массив $query) Получить полный URL для запроса с добавленными параметрами строки запроса.
строка	path() Получить текущую информацию о пути для запроса.
строка	decodedPath() Получить текущую декодированную информацию о пути для запроса.
строка\|null	segment(целое $index, строка\|null $default = null) Получить сегмент из URI (индекс, начинающийся с 1).
массив	segments() Получить все сегменты для пути запроса.
булево	is(динамический $patterns) Определить, соответствует ли текущий URI запроса шаблону.
булево	routeIs(динамический $patterns) Определить, соответствует ли имя маршрута заданному шаблону.
булево	fullUrlIs(динамический $patterns) Определить, соответствует ли текущий URL запроса и строка запроса шаблону.
булево	ajax() Определить, является ли запрос результатом вызова AJAX.
булево	pjax() Определить, является ли запрос результатом вызова PJAX.
булево	secure() Определить, используется ли HTTPS для запроса.
строка	ip() Получить IP-адрес клиента.
массив	ips() Получить IP-адреса клиента.
строка	userAgent() Получить пользовательского агента клиента.
Request	merge(массив $input) Объединить новые входные данные в текущий массив входных данных запроса.
Request	replace(массив $input) Заменить входные данные для текущего запроса.
смешанный	get(строка $key, смешанный $default = null) Этот метод принадлежит Symfony HttpFoundation и обычно не нужен при использовании Laravel.
ParameterBag\|смешанный	json(строка $key = null, смешанный $default = null) Получить JSON-тело запроса.

ParameterBag	getInputSource() Получить источник входных данных для запроса.
static Request	createFrom(Request $from, Request\|null $to = null) Создать новый экземпляр запроса из данного запроса Laravel.
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() Получить сессию, связанную с запросом.
Store\|null	getSession() Получить сессию, связанную с запросом.
void	setLaravelSession(Session $session) Установить экземпляр сессии в запросе.
mixed	user(string\|null $guard = null) Получить пользователя, выполняющего запрос.
Route\|object\|string	route(string\|null $param = null) Получить маршрут, обрабатывающий запрос.
string	fingerprint() Получить уникальный отпечаток запроса/маршрута/IP-адреса.
$this	setJson(ParameterBag $json) Установить JSON-содержимое для запроса.
Closure	getUserResolver() Получить обратный вызов для разрешения пользователя.
$this	setUserResolver(Closure $callback) Установить обратный вызов для разрешения пользователя.
Closure	getRouteResolver() Получить обратный вызов для разрешения маршрута.
$this	setRouteResolver(Closure $callback) Установить обратный вызов для разрешения маршрута.
array	toArray() Получить все входные данные и файлы для запроса.
bool	offsetExists(string $offset) Определить, существует ли заданный смещение.
mixed	offsetGet(string $offset) Получить значение по заданному смещению.
void	offsetSet(string $offset, mixed $value) Установить значение по заданному смещению.
void	offsetUnset(string $offset) Удалить значение по заданному смещению.
bool	__isset(string $key) Проверить, установлен ли элемент входных данных в запросе.
mixed	__get(string $key) Получить элемент входных данных из запроса.

Details

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

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

Parameters

string	$actual
string	$type

Return Value

bool

bool isJson()

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

Return Value

bool

bool expectsJson()

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

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

Return Value

bool

bool acceptsJson()

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

Return Value

bool

bool acceptsHtml()

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

Return Value

bool

string format(string $default = 'html')

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

Parameters

string

$default

Return Value

string

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

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

Parameters

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

Return Value

string|array

void flash()

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

Return Value

void

END_OF_DOCUMENT_MARKER

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

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

Параметры

string|array

$keys

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

bool

bool filled(string|array $key)

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

Параметры

string|array

$key

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

bool

bool anyFilled(string|array $keys)

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

Параметры

string|array

$keys

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

bool

protected bool isEmptyString(string $key)

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

Параметры

string

$key

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

bool

array keys()

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

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

array

array all(array|mixed $keys = null)

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

Параметры

array|mixed

$keys

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

array

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

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

Параметры

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

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

string|array|null

array only(array|mixed $keys)

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

Параметры

array|mixed

$keys

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

array

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

string|array post(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

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

Exceptions

ReflectionException

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

static Request capture()

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

Return Value

Request

$this instance()

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

Return Value

$this

string method()

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

Return Value

string

string root()

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

Return Value

string

string url()

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

Return Value

string

string fullUrl()

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

Return Value

string

string fullUrlWithQuery(array $query)

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

Parameters

array

$query

Return Value

string

string path()

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

Return Value

string

string decodedPath()

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

Return Value

string

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

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

Parameters

int	$index
string\|null	$default

Return Value

string|null

array segments()

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

Return Value

array

bool is(dynamic $patterns)

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

Parameters

dynamic

$patterns

Return Value

bool

bool routeIs(dynamic $patterns)

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

Parameters

dynamic

$patterns

Return Value

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

Request merge(array $input)

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

Параметры

array

$input

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

Request

Request replace(array $input)

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

Параметры

array

$input

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

Request

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

Этот метод принадлежит Symfony HttpFoundation и обычно не нужен при использовании Laravel.

Вместо этого вы можете использовать метод «input».

Параметры

string	$key
mixed	$default

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

mixed

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

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

Параметры

string	$key
mixed	$default

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

ParameterBag|mixed

protected ParameterBag getInputSource()

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

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

ParameterBag

static Request createFrom(Request $from, Request|null $to = null)

Создать новый экземпляр запроса из указанного запроса Laravel.

Параметры

Request	$from
Request\|null	$to

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

Request

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

Store|null getSession()

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

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

Store|null

void setLaravelSession(Session $session)

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

Параметры

Session

$session

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

void

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

$this setJson(ParameterBag $json)

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

Параметры

ParameterBag

$json

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

$this

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

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