Запрос

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

Свойства

protected string	$json	Декодированное содержимое JSON запроса.
protected Closure	$userResolver	Обратный вызов для определения пользователя.
protected Closure	$routeResolver	Обратный вызов для определения маршрута.

Методы

static Request	capture() Создать новый запрос Illuminate HTTP из переменных сервера.
$this	instance() Возвратить экземпляр Request.
строка	method() Получить метод запроса.
строка	root() Получить корневой URL приложения.
строка	url() Получить URL (без строки запроса) для запроса.
строка	fullUrl() Получить полный URL для запроса.
строка	path() Получить текущий путь для запроса.
строка	decodedPath() Получить текущий закодированный путь для запроса.
строка\|null	segment(int $index, string\|null $default = null) Получить сегмент из URI (индекс с 1).
массив	segments() Получить все сегменты для пути запроса.
булево	is() Определить, соответствует ли текущий URI запроса шаблону.
булево	ajax() Определить, является ли запрос результатом AJAX-вызова.
булево	pjax() Определить, является ли запрос результатом PJAX-вызова.
булево	secure() Определить, используется ли HTTPS для запроса.
строка	ip() Возвращает IP-адрес клиента.
массив	ips() Возвращает IP-адреса клиента.
булево	exists(string\|array $key) Определить, содержит ли запрос заданный ключ входных данных.
булево	has(string\|array $key) Определить, содержит ли запрос ненулевое значение для элемента входных данных.
булево	isEmptyString(string $key) Определить, является ли заданный ключ входных данных пустой строкой для "has".
массив	all() Получить все входные данные и файлы для запроса.
строка\|массив	input(string $key = null, string\|array\|null $default = null) Получить элемент входных данных из запроса.
массив	only(array $keys) Получить подмножество элементов из входных данных.
массив	except(array\|mixed $keys) Получить все входные данные, кроме указанного массива элементов.
строка\|массив	query(string $key = null, string\|array\|null $default = null) Получить элемент строки запроса из запроса.
булево	hasCookie(string $key) Определить, установлен ли cookie в запросе.
строка\|массив	cookie(string $key = null, string\|array\|null $default = null) Получить cookie из запроса.
UploadedFile\|массив\|null	file(string $key = null, mixed $default = null) Получить файл из запроса.
булево	hasFile(string $key) Определить, содержит ли загруженные данные файл.
булево	isValidFile(mixed $file) Проверить, является ли заданный файл допустимым экземпляром файла.
строка\|массив	header(string $key = null, string\|array\|null $default = null) Получить заголовок из запроса.
строка\|массив	server(string $key = null, string\|array\|null $default = null) Получить переменную сервера из запроса.
строка\|массив	old(string $key = null, string\|array\|null $default = null) Получить старый элемент входных данных.
пусто	flash(string $filter = null, array $keys = []) Занести входные данные текущего запроса в сессию.
пусто	flashOnly(array\|mixed $keys) Занести в сессию только некоторые входные данные.
пусто	flashExcept(array\|mixed $keys) Занести в сессию только некоторые входные данные.
пусто	flush() Очистить все старые входные данные из сессии.
строка\|массив	retrieveItem(string $source, string $key, string\|array\|null $default) Получить элемент параметра из указанного источника.
пусто	merge(array $input) Объединить новые входные данные в массив входных данных текущего запроса.
пусто	replace(array $input) Заменить входные данные для текущего запроса.
смешанное	json(string $key = null, mixed $default = null) Получить JSON-нагрузку для запроса.
ParameterBag	getInputSource() Получить источник входных данных для запроса.
static булево	matchesType(string $actual, string $type) Определить, совпадают ли заданные типы содержимого.
булево	isJson() Определить, отправляет ли запрос JSON.
булево	wantsJson() Определить, запрашивает ли текущий запрос JSON в ответ.
булево	accepts(string\|array $contentTypes) Определяет, принимает ли текущий запрос указанный тип содержимого.
строка\|null	prefers(string\|array $contentTypes) Возвращает наиболее подходящий тип содержимого из заданного массива на основе согласования содержимого.
булево	acceptsJson() Определяет, принимает ли запрос JSON.
булево	acceptsHtml() Определяет, принимает ли запрос HTML.
строка	format(string $default = 'html') Получить ожидаемый формат данных в ответе.
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() Получить пользователя, отправляющего запрос.
Маршрут\|object\|string	route(string\|null $param = null) Получить маршрут, обрабатывающий запрос.
Closure	getUserResolver() Получить обратный вызов для разрешения пользователя.
$this	setUserResolver(Closure $callback) Установить обратный вызов для разрешения пользователя.
Closure	getRouteResolver() Получить обратный вызов для разрешения маршрута.
$this	setRouteResolver(Closure $callback) Установить обратный вызов для разрешения маршрута.
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 Запрос capture()

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

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

Запрос

$this instance()

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

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

$this

string method()

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

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

string

string root()

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

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

string

string url()

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

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

string

string fullUrl()

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

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

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

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

Параметры

array

$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

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

UploadedFile|array|null file(string $key = null, mixed $default = null)

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

Параметры

string	$key
mixed	$default

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

UploadedFile|array|null

bool hasFile(string $key)

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

Параметры

string

$key

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

bool

protected bool isValidFile(mixed $file)

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

Параметры

mixed

$file

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

bool

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

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

Параметры

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

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

string|array

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

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

Параметры

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

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

string|array

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

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

Параметры

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

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

string|array

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

Внести данные ввода текущего запроса в сессию.

Параметры

string	$filter
array	$keys

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

void

void flashOnly(array|mixed $keys)

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

Параметры

array|mixed

$keys

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

void

void flashExcept(array|mixed $keys)

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

Параметры

array|mixed

$keys

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

void

void flush()

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

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

void

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

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

Параметры

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

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

string|array

void merge(array $input)

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

Параметры

array

$input

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

void

void replace(array $input)

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

Параметры

array

$input

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

void

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

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

Параметры

string	$key
mixed	$default

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

mixed

protected ParameterBag getInputSource()

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

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

ParameterBag

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

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

Параметры

string	$actual
string	$type

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

bool

bool isJson()

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

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

bool

bool wantsJson()

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

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

bool

bool accepts(string|array $contentTypes)

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

Параметры

string|array

$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

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

Store session()

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

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

Store

Исключения

RuntimeException

mixed user()

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

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

mixed

Route|object|string route(string|null $param = null)

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

Параметры

string|null

$param

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

Route|object|string

Closure getUserResolver()

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

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

Closure

$this setUserResolver(Closure $callback)

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

Параметры

Closure

$callback

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

$this

Closure getRouteResolver()

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

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

Closure

$this setRouteResolver(Closure $callback)

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

Параметры

Closure

$callback

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

$this

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