Запрос

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

Трейты

Свойства

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

Методы

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() Создать новый запрос HTTP Illuminate из переменных сервера.
$this	instance() Вернуть экземпляр запроса.
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	fullUrlIs() Определить, соответствует ли текущий URL запроса и строка запроса шаблону.
bool	ajax() Определить, является ли запрос результатом вызова AJAX.
bool	pjax() Определить, является ли запрос результатом вызова PJAX.
bool	secure() Определить, происходит ли запрос по протоколу HTTPS.
string	ip() Возвращает IP-адрес клиента.
array	ips() Возвращает IP-адреса клиента.
bool	exists(string\|array $key) Определить, содержит ли запрос заданный ключ входных данных.
bool	has(string\|array $key) Определить, содержит ли запрос ненулевое значение для входного элемента.
bool	isEmptyString(string $key) Определить, является ли заданный ключ входных данных пустой строкой для «has».
array	all() Получить все входные данные и файлы для запроса.
string\|array	input(string $key = null, string\|array\|null $default = null) Получить элемент входных данных из запроса.
array	only(array\|mixed $keys) Получить подмножество, содержащее предоставленные ключи со значениями из входных данных.
array	except(array\|mixed $keys) Получить все входные данные за исключением указанного массива элементов.
array	intersect(array\|mixed $keys) Пересечение массива элементов с входными данными.
string\|array	query(string $key = null, string\|array\|null $default = null) Получить элемент строки запроса из запроса.
bool	hasCookie(string $key) Определить, установлен ли cookie в запросе.
string\|array	cookie(string $key = null, string\|array\|null $default = null) Получить cookie из запроса.
array	allFiles() Получить массив всех файлов в запросе.
array	convertUploadedFiles(array $files) Преобразовать заданный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles.
UploadedFile\|array\|null	file(string $key = null, mixed $default = null) Получить файл из запроса.
bool	hasFile(string $key) Определить, содержит ли загруженные данные файл.
bool	isValidFile(mixed $file) Проверить, является ли заданный файл допустимым экземпляром файла.
bool	hasHeader(string $key) Определить, установлен ли заголовок в запросе.
string\|array	header(string $key = null, string\|array\|null $default = null) Получить заголовок из запроса.
string\|array	server(string $key = null, string\|array\|null $default = null) Получить переменную сервера из запроса.
string\|array	old(string $key = null, string\|array\|null $default = null) Получить старый элемент входных данных.
void	flash(string $filter = null, array $keys = []) Сохранить входные данные текущего запроса в сессии.
void	flashOnly(array\|mixed $keys) Сохранить только некоторые входные данные в сессии.
void	flashExcept(array\|mixed $keys) Сохранить только некоторые входные данные в сессии.
void	flush() Очистить все старые входные данные из сессии.
string\|array	retrieveItem(string $source, string $key, string\|array\|null $default) Получить элемент параметра из заданного источника.
void	merge(array $input) Объединить новые входные данные в текущий массив входных данных запроса.

void	replace(array $input) Заменить входные данные для текущего запроса.
mixed	json(string $key = null, mixed $default = null) Получить JSON-полезную нагрузку для запроса.
ParameterBag	getInputSource() Получить источник входных данных для запроса.
static bool	matchesType(string $actual, string $type) Определить, совпадают ли заданные типы контента.
bool	isJson() Определить, отправляет ли запрос JSON.
bool	wantsJson() Определить, запрашивает ли текущий запрос JSON в ответ.
bool	accepts(string\|array $contentTypes) Определяет, принимает ли текущий запрос заданный тип контента.
string\|null	prefers(string\|array $contentTypes) Возвращает наиболее подходящий тип контента из заданного массива на основе согласования типов контента.
bool	acceptsJson() Определяет, принимает ли запрос JSON.
bool	acceptsHtml() Определяет, принимает ли запрос HTML.
string	format(string $default = 'html') Получить ожидаемый формат данных в ответе.
string\|null	bearerToken() Получить токен bearer из заголовков запроса.
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}
Store	session() Получить сеанс, связанный с запросом.
mixed	user(string\|null $guard = null) Получить пользователя, который совершает запрос.
Route\|object\|string	route(string\|null $param = null) Получить маршрут, обрабатывающий запрос.
string	fingerprint() Получить уникальный отпечаток запроса/маршрута/IP-адреса.
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 void macro(string $name, callable $macro)

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

Parameters

string	$name
callable	$macro

Return Value

void

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 для запроса.

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

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)

Извлечь cookie из запроса.

Параметры

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

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

string|array

array allFiles()

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

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

array

protected array convertUploadedFiles(array $files)

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

Параметры

array

$files

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

array

UploadedFile|массив|null file(строка $key = null, смешанный $default = null)

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

Параметры

строка	$key
смешанный	$default

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

UploadedFile|массив|null

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

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

Параметры

строка

$key

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

логическое

защищенное логическое isValidFile(смешанный $file)

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

Параметры

смешанный

$file

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

логическое

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

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

Параметры

строка

$key

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

логическое

строка|массив header(строка $key = null, строка|массив|null $default = null)

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

Параметры

строка	$key
строка\|массив\|null	$default

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

строка|массив

строка|массив server(строка $key = null, строка|массив|null $default = null)

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

Параметры

строка	$key
строка\|массив\|null	$default

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

строка|массив

строка|массив old(строка $key = null, строка|массив|null $default = null)

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

Параметры

строка	$key
строка\|массив\|null	$default

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

строка|массив

пустое flash(строка $filter = null, массив $keys = [])

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

Параметры

строка	$filter
массив	$keys

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

пустое

пустое flashOnly(массив|смешанный $keys)

Переместить в сессию только некоторые данные ввода.

Параметры

массив|смешанный

$keys

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

пустое

пустое flashExcept(массив|смешанный $keys)

Переместить в сессию только некоторые данные ввода.

Параметры

массив|смешанный

$keys

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

пустое

пустое flush()

Очистить все старые данные ввода из сессии.

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

пустое

защищенное строка|массив retrieveItem(строка $source, строка $key, строка|массив|null $default)

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

Параметры

строка	$source
строка	$key
строка\|массив\|null	$default

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

строка|массив

пустое merge(массив $input)

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

Параметры

массив

$input

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

пустое

пустое replace(массив $input)

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

Параметры

массив

$input

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

пустое

смешанный json(строка $key = null, смешанный $default = null)

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

Параметры

строка	$key
смешанный	$default

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

смешанный

защищенное ParameterBag getInputSource()

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

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

ParameterBag

статическое логическое matchesType(строка $actual, строка $type)

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

Параметры

строка	$actual
строка	$type

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

логическое

логическое isJson()

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

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

логическое

логическое wantsJson()

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

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

логическое

логическое accepts(строка|массив $contentTypes)

Определяет, принимает ли текущий запрос заданный тип содержимого.

Параметры

строка|массив

$contentTypes

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

логическое

строка|null prefers(строка|массив $contentTypes)

Возвращает наиболее подходящий тип содержимого из заданного массива на основе переговоров о содержимом.

Параметры

строка|массив

$contentTypes

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

строка|null

логическое acceptsJson()

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

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

логическое

логическое acceptsHtml()

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

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

логическое

строка format(строка $default = 'html')

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

Параметры

строка

$default

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

строка

строка|null bearerToken()

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

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

строка|null

static Запрос createFromBase(Запрос $request)

Создать объект Illuminate request из экземпляра Symfony.

Параметры

Запрос

$request

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

Запрос

duplicate(массив $query = null, массив $request = null, массив $attributes = null, массив $cookies = null, массив $files = null, массив $server = null)

{@inheritdoc}

Параметры

массив	$query
массив	$request
массив	$attributes
массив	$cookies
массив	$files
массив	$server

Хранилище session()

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

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

Хранилище

Исключения

RuntimeException

смешанный тип user(строка|null $guard = null)

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

Параметры

строка|null

$guard

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

смешанный тип

Маршрут|объект|строка route(строка|null $param = null)

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

Параметры

строка|null

$param

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

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

строка fingerprint()

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

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

строка

Исключения

RuntimeException

Замыкание getUserResolver()

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

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

Замыкание

$this setUserResolver(Замыкание $callback)

Установить обратный вызов для разрешения пользователя.

Параметры

Замыкание

$callback

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

$this

Замыкание getRouteResolver()

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

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

Замыкание

$this setRouteResolver(Замыкание $callback)

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

Параметры

Замыкание

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