Запрос

класс Запрос расширяет Запрос реализует 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() Создать новый запрос Illuminate HTTP из переменных сервера.
$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-payload для запроса.
ParameterBag	getInputSource() Получить источник входных данных для запроса.
static bool	matchesType(string $actual, string $type) Определить, совпадают ли заданные типы контента.
bool	isJson() Определить, отправляет ли запрос JSON.
bool	expectsJson() Определить, ожидает ли текущий запрос, вероятно, 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}
mixed	filterFiles(mixed $files) Отфильтровать заданный массив файлов, удаляя пустые значения.
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()

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

Return Value

Request

$this instance()

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

Return Value

$this

string method()

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

Return Value

string

string root()

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

Return Value

string

END_OF_DOCUMENT_MARKER

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 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.

Параметры

массив

$files

Значение результата

массив

UploadedFile|массив|null file(string $key = null, mixed $default = null)

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

Параметры

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

Значение результата

UploadedFile|массив|null

bool hasFile(string $key)

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

Параметры

строка

$key

Значение результата

bool

protected bool isValidFile(mixed $file)

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

Параметры

смешанное

$file

Значение результата

bool

bool hasHeader(string $key)

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

Параметры

строка

$key

Значение результата

bool

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

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

Параметры

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

Значение результата

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

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

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

Параметры

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

Значение результата

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

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

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

Параметры

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

Значение результата

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

void flash(string $filter = null, array $keys = [])

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

Параметры

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

Значение результата

void

void flashOnly(array|смешанное $keys)

Сохранить только некоторые данные ввода в сессии.

Параметры

массив|смешанное

$keys

Значение результата

void

void flashExcept(array|смешанное $keys)

Сохранить только некоторые данные ввода в сессии.

Параметры

массив|смешанное

$keys

Значение результата

void

void flush()

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

Значение результата

void

protected строка|массив retrieveItem(string $source, string $key, string|array|null $default)

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

Параметры

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

Значение результата

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

void merge(array $input)

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

Параметры

массив

$input

Значение результата

void

void replace(array $input)

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

Параметры

массив

$input

Значение результата

void

смешанное json(string $key = null, mixed $default = null)

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

Параметры

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

Значение результата

смешанное

protected ParameterBag getInputSource()

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

Значение результата

ParameterBag

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

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

Параметры

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

Значение результата

bool

bool isJson()

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

Значение результата

bool

bool expectsJson()

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

Значение результата

bool

bool wantsJson()

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

Значение результата

bool

bool accepts(string|array $contentTypes)

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

Параметры

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

$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|null bearerToken()

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

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

string|null

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

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

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

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

Хранилище

Исключения

RuntimeException

mixed user(string|null $guard = null)

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

Параметры

string|null

$guard

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

mixed

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

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

Параметры

string|null

$param

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

Маршрут|object|string

string fingerprint()

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

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

string

Исключения

RuntimeException

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

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

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

Замыкание

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

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

Параметры

Замыкание

$callback

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

$this

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

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

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

Замыкание

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

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

Параметры

Замыкание

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