Запрос

класс Запрос расширяет 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\|null $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\|null	server(string\|null $key = null, string\|array\|null $default = null) Получить переменную сервера из запроса.	from InteractsWithInput
bool	hasHeader(string $key) Определить, задан ли заголовок в запросе.	from InteractsWithInput
string\|array\|null	header(string\|null $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\|null $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

array	except(array\|mixed $keys) Получить все входные данные, кроме указанного массива элементов.	из InteractsWithInput
string\|array\|null	query(string\|null $key = null, string\|array\|null $default = null) Получить элемент строки запроса из запроса.	из InteractsWithInput
string\|array\|null	post(string\|null $key = null, string\|array\|null $default = null) Получить элемент данных запроса из запроса.	из InteractsWithInput
bool	hasCookie(string $key) Определить, установлен ли cookie в запросе.	из InteractsWithInput
string\|array\|null	cookie(string\|null $key = null, string\|array\|null $default = null) Получить cookie из запроса.	из InteractsWithInput
array	allFiles() Получить массив всех файлов в запросе.	из InteractsWithInput
array	convertUploadedFiles(array $files) Преобразовать заданный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles.	из InteractsWithInput
bool	hasFile(string $key) Определить, содержат ли загруженные данные файл.	из InteractsWithInput
bool	isValidFile(mixed $file) Проверить, является ли заданный файл допустимым экземпляром файла.	из InteractsWithInput
UploadedFile\|UploadedFile[]\|array\|null	file(string\|null $key = null, mixed $default = null) Получить файл из запроса.	из InteractsWithInput
string\|array\|null	retrieveItem(string $source, string $key, string\|array\|null $default) Получить элемент параметра из заданного источника.	из InteractsWithInput
static void	macro(string $name, object\|callable $macro) Регистрация пользовательского макроса.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Включение другого объекта в класс.	из 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(mixed ...$patterns) Определение, соответствует ли текущий URI шаблону.
bool	routeIs(mixed ...$patterns) Определение, соответствует ли имя маршрута заданному шаблону.
bool	fullUrlIs(mixed ...$patterns) Определение, соответствует ли текущий URL и строка запроса шаблону.
bool	ajax() Определение, является ли запрос результатом вызова AJAX.
bool	pjax() Определение, является ли запрос результатом вызова PJAX.
bool	prefetch() Определение, является ли запрос результатом вызова prefetch.
bool	secure() Определение, происходит ли запрос по HTTPS.
string\|null	ip() Получение IP-адреса клиента.
array	ips() Получение IP-адресов клиента.
string	userAgent() Получение пользовательского агента клиента.
$this	merge(array $input) Объединение новых входных данных в текущий массив входных данных запроса.
$this	replace(array $input) Замена входных данных для текущего запроса.
mixed	get(string $key, mixed $default = null) Этот метод принадлежит Symfony HttpFoundation и обычно не требуется при использовании Laravel.

ParameterBag\|mixed	json(string\|null $key = null, mixed $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) Получить элемент ввода из запроса.

Подробности

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

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

Parameters

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

Return Value

string|array

END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

string|array|null

bool hasHeader(string $key)

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

Параметры

string

$key

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

bool

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

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

Параметры

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

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

string|array|null

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|null $keys = null)

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

Параметры

array|mixed|null

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

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

Параметры

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

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

string|array|null

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

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

Параметры

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

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

string|array|null

bool hasCookie(string $key)

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

Параметры

string

$key

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

bool

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

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

Параметры

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

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

string|array|null

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|UploadedFile[]|array|null file(string|null $key = null, mixed $default = null)

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

Параметры

string\|null	$key
mixed	$default

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

UploadedFile|UploadedFile[]|array|null

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

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

Параметры

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

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

string|array|null

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

Параметры

string	$name
object\|callable	$macro

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

void

static void mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

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(mixed ...$patterns)

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

Параметры

mixed

...$patterns

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

bool

bool routeIs(mixed ...$patterns)

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

Параметры

mixed

...$patterns

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

bool

bool fullUrlIs(mixed ...$patterns)

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

Параметры

mixed

...$patterns

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

bool

bool ajax()

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

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

bool

bool pjax()

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

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

bool

bool prefetch()

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

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

bool

bool secure()

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

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

bool

string|null ip()

Получить IP-адрес клиента.

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

string|null

array ips()

Получить IP-адреса клиента.

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

array

string userAgent()

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

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

string

$this merge(array $input)

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

Параметры

array

$input

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

$this

$this replace(array $input)

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

Параметры

array

$input

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

$this

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

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

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

Параметры

string	$key
mixed	$default

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

mixed

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

Получить JSON-данные запроса.

Параметры

string\|null	$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(строка|null $param = null, смешанный $default = null)

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

Параметры

строка\|null	$param
смешанный	$default

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

Маршрут|объект|строка

строка fingerprint()

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

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

строка

Исключения

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

массив toArray()

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

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

массив

логическое offsetExists(строка $offset)

Определить, существует ли заданный смещение.

Параметры

строка

$offset

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

логическое

смешанный offsetGet(строка $offset)

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

Параметры

строка

$offset

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

смешанный

пустое значение offsetSet(строка $offset, смешанный $value)

Установить значение по заданному смещению.

Параметры

строка	$offset
смешанный	$value

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

пустое значение

пустое значение offsetUnset(строка $offset)

Удалить значение по заданному смещению.

Параметры

строка

$offset

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

пустое значение

логическое __isset(строка $key)

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

Параметры

строка

$key

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

логическое

смешанный __get(строка $key)

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

Параметры

строка

$key

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

смешанный

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