Запрос

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

Трейты

Свойства

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

Методы

static bool	matchesType(string $actual, string $type) Определить, совпадают ли заданные типы содержимого.	из InteractsWithContentTypes
bool	isJson() Определить, отправляет ли запрос JSON.	из InteractsWithContentTypes
bool	expectsJson() Определить, ожидает ли текущий запрос, вероятно, JSON-ответ.	из InteractsWithContentTypes
bool	wantsJson() Определить, запрашивает ли текущий запрос JSON.	из InteractsWithContentTypes
bool	accepts(string\|array $contentTypes) Определяет, принимает ли текущий запрос заданный тип содержимого.	из InteractsWithContentTypes
string\|null	prefers(string\|array $contentTypes) Возвращает наиболее подходящий тип содержимого из заданного массива на основе согласования содержимого.	из InteractsWithContentTypes
bool	acceptsAnyContentType() Определить, принимает ли текущий запрос любой тип содержимого.	из InteractsWithContentTypes
bool	acceptsJson() Определяет, принимает ли запрос JSON.	из InteractsWithContentTypes
bool	acceptsHtml() Определяет, принимает ли запрос HTML.	из InteractsWithContentTypes
string	format(string $default = 'html') Получить ожидаемый формат данных в ответе.	из InteractsWithContentTypes
string\|array	old(string $key = null, string\|array\|null $default = null) Получить элемент ввода из кэша.	из InteractsWithFlashData
void	flash() Сохранить ввод текущего запроса в сессию.	из InteractsWithFlashData
void	flashOnly(array\|mixed $keys) Сохранить только некоторые элементы ввода в сессию.	из InteractsWithFlashData
void	flashExcept(array\|mixed $keys) Сохранить только некоторые элементы ввода в сессию.	из InteractsWithFlashData
void	flush() Очистить все старые данные ввода из сессии.	из InteractsWithFlashData
string\|array\|null	server(string $key = null, string\|array\|null $default = null) Получить переменную сервера из запроса.	из InteractsWithInput
bool	hasHeader(string $key) Определить, установлено ли заголовок в запросе.	из InteractsWithInput
string\|array\|null	header(string $key = null, string\|array\|null $default = null) Получить заголовок из запроса.	из InteractsWithInput
string\|null	bearerToken() Получить токен-носитель из заголовков запроса.	из InteractsWithInput
bool	exists(string\|array $key) Определить, содержит ли запрос заданный ключ элемента ввода.	из InteractsWithInput
bool	has(string\|array $key) Определить, содержит ли запрос заданный ключ элемента ввода.	из InteractsWithInput
bool	hasAny(string\|array $keys) Определить, содержит ли запрос любой из заданных элементов ввода.	из InteractsWithInput
bool	filled(string\|array $key) Определить, содержит ли запрос непустое значение для элемента ввода.	из InteractsWithInput
bool	anyFilled(string\|array $keys) Определить, содержит ли запрос непустое значение для любого из заданных элементов ввода.	из InteractsWithInput
bool	isEmptyString(string $key) Определить, является ли заданный ключ ввода пустой строкой для "has".	из InteractsWithInput
array	keys() Получить ключи всех элементов ввода и файлов.	из InteractsWithInput
array	all(array\|mixed $keys = null) Получить все элементы ввода и файлы для запроса.	из InteractsWithInput
string\|array\|null	input(string\|null $key = null, string\|array\|null $default = null) Получить элемент ввода из запроса.	из InteractsWithInput
array	only(array\|mixed $keys) Получить подмножество, содержащее предоставленные ключи со значениями из данных ввода.	из InteractsWithInput

массив	except(массив\|смешанный $keys) Получить все входные данные, кроме указанного массива элементов.	из InteractsWithInput
строка\|массив\|null	query(строка $key = null, строка\|массив\|null $default = null) Получить элемент строки запроса из запроса.	из InteractsWithInput
строка\|массив\|null	post(строка $key = null, строка\|массив\|null $default = null) Получить элемент данных запроса из запроса.	из InteractsWithInput
логическое значение	hasCookie(строка $key) Определить, установлен ли cookie в запросе.	из InteractsWithInput
строка\|массив\|null	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
строка\|массив\|null	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
статический Запрос	capture() Создание нового запроса Illuminate HTTP из переменных сервера.
$this	instance() Возврат экземпляра Запроса.
строка	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() Получение пользовательского агента клиента.
Запрос	merge(массив $input) Слияние новых входных данных в текущий массив входных данных запроса.
Запрос	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, mixed $default = 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|null server(string $key = null, string|array|null $default = null)

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

Параметры

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

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

string|array|null

bool hasHeader(string $key)

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

Параметры

string

$key

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

bool

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

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

Параметры

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

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

string|array|null

string|null bearerToken()

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

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

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|null query(string $key = null, string|array|null $default = null)

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

Параметры

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

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

string|array|null

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

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

Параметры

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

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

string|array|null

bool hasCookie(string $key)

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

Параметры

string

$key

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

bool

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

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

Параметры

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

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

string|array|null

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|null retrieveItem(string $source, string $key, string|array|null $default)

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

Parameters

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

Return Value

string|array|null

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

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

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

END_OF_DOCUMENT_MARKER

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

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

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

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, mixed $default = null)

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

Параметры

string\|null	$param
mixed	$default

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

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.7/Illuminate/Http/Request.html