Запрос
класс Запрос расширяет Запрос реализует Arrayable, ArrayAccess (Просмотреть исходный код)
Трейты
| ВзаимодействуетСТипамиКонтента |
| ВзаимодействуетСФлэшДанными |
| ВзаимодействуетССодержимымВвода |
| Макроспособный |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Макроспособный |
| защищенная строка | $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 | acceptsJson() Определяет, принимает ли запрос JSON. | from InteractsWithContentTypes |
| bool | acceptsHtml() Определяет, принимает ли запрос HTML. | from InteractsWithContentTypes |
| string | format(string $default = 'html') Получить ожидаемый формат данных в ответе. | from InteractsWithContentTypes |
| string|array | old(string $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 | server(string $key = null, string|array|null $default = null) Получить переменную сервера из запроса. | from InteractsWithInput |
| bool | hasHeader(string $key) Определить, установлено ли заголовок в запросе. | from InteractsWithInput |
| string|array | header(string $key = null, string|array|null $default = null) Получить заголовок из запроса. | from InteractsWithInput |
| string|null | bearerToken() Получить токен bearer из заголовков запроса. | from InteractsWithInput |
| bool | exists(string|array $key) Определить, содержит ли запрос заданный ключ элемента ввода. | from InteractsWithInput |
| bool | has(string|array $key) Определить, содержит ли запрос заданный ключ элемента ввода. | from InteractsWithInput |
| bool | hasAny($keys) Определить, содержит ли запрос любой из заданных элементов ввода. | from InteractsWithInput |
| bool | filled(string|array $key) Определить, содержит ли запрос значение, отличное от пустого, для элемента ввода. | from InteractsWithInput |
| bool | isEmptyString(string $key) Определить, является ли заданный ключ ввода пустой строкой для "has". | from InteractsWithInput |
| array | keys() Получить ключи для всех элементов ввода и файлов. | from InteractsWithInput |
| array | all(array|mixed $keys = null) Получить все элементы ввода и файлы для запроса. | from InteractsWithInput |
| string|array | input(string $key = null, string|array|null $default = null) Получить элемент ввода из запроса. | from InteractsWithInput |
| array | only(array|mixed $keys) Получить подмножество, содержащее предоставленные ключи со значениями из данных ввода. | from InteractsWithInput |
| array | except(array|mixed $keys) Получить все элементы ввода, за исключением указанного массива элементов. | from InteractsWithInput |
| string|array | query(string $key = null, string|array|null $default = null) Получить элемент строки запроса из запроса. | from InteractsWithInput |
| string|array | post(string $key = null, string|array|null $default = null) Получить элемент полезной нагрузки запроса из запроса. | from InteractsWithInput |
| bool | hasCookie(string $key) Определить, установлен ли cookie в запросе. | from InteractsWithInput |
| string|array | cookie(string $key = null, string|array|null $default = null) Получить cookie из запроса. | from InteractsWithInput |
| array | allFiles() Получить массив всех файлов в запросе. | from InteractsWithInput |
| array | convertUploadedFiles(array $files) Преобразовать массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles. | from InteractsWithInput |
| bool | hasFile(string $key) Определить, содержит ли загруженный файл данные. | from InteractsWithInput |
| bool | isValidFile(mixed $file) Проверить, является ли данный файл допустимым экземпляром файла. | from InteractsWithInput |
| UploadedFile|array|null | file(string $key = null, mixed $default = null) Получить файл из запроса. | from InteractsWithInput |
| string|array | retrieveItem(string $source, string $key, string|array|null $default) Получить элемент параметра из заданного источника. | from InteractsWithInput |
| static void | macro(string $name, object|callable $macro) Зарегистрировать пользовательское макро. | from Macroable |
| static void | mixin(object $mixin) Включить другой объект в класс. | 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(dynamic $patterns) Определить, соответствует ли текущий URI запроса шаблону. | |
| bool | routeIs(dynamic $patterns) Определить, соответствует ли имя маршрута заданному шаблону. | |
| bool | fullUrlIs(dynamic $patterns) Определить, соответствует ли текущий URL запроса и строка запроса шаблону. | |
| bool | ajax() Определить, является ли запрос результатом AJAX-вызова. | |
| bool | pjax() Определить, является ли запрос результатом PJAX-вызова. | |
| bool | secure() Определить, передаётся ли запрос по HTTPS. | |
| string | ip() Получить IP-адрес клиента. | |
| array | ips() Получить IP-адреса клиента. | |
| string | userAgent() Получить пользовательский агент клиента. | |
| void | merge(array $input) Объединить новые входные данные в массив входных данных текущего запроса. | |
| void | replace(array $input) Заменить входные данные для текущего запроса. | |
| mixed | json(string $key = null, mixed $default = null) Получить JSON-данные для запроса. | |
| ParameterBag | getInputSource() Получить источник входных данных для запроса. | |
| 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() Получить сеанс, связанный с запросом. | |
| void | setLaravelSession(Session $session) Установить экземпляр сеанса в запросе. |
| mixed | user(string|null $guard = null) Получить пользователя, производящего запрос. | |
| Маршрут|object|string | route(string|null $param = null) Получить маршрут, обрабатывающий запрос. | |
| string | fingerprint() Получить уникальный отпечаток для запроса/маршрута/IP-адреса. | |
| $this | setJson(array $json) Установить JSON-payload для запроса. | |
| 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) Получить элемент входных данных из запроса. | |
| array | validate(array $rules, array $messages = [], array $customAttributes = []) Без описания |
Подробности
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|array old(string $key = null, string|array|null $default = null)
Получить предыдущее значение входного элемента.
void flash()
Сохранить входные данные текущего запроса в сессии.
void flashOnly(array|mixed $keys)
Сохранить только некоторые входные данные в сессии.
void flashExcept(array|mixed $keys)
Сохранить только некоторые входные данные в сессии.
void flush()
Очистить все старые входные данные из сессии.
string|array server(string $key = null, string|array|null $default = null)
Получить переменную сервера из запроса.
bool hasHeader(string $key)
Определить, установлена ли заголовок в запросе.
строка|массив header(строка $key = null, строка|массив|null $default = null)
Получить заголовок из запроса.
строка|null bearerToken()
Получить токен bearer из заголовков запроса.
bool exists(строка|массив $key)
Определить, содержит ли запрос заданный ключ элемента ввода.
bool has(строка|массив $key)
Определить, содержит ли запрос заданный ключ элемента ввода.
bool hasAny($keys)
Определить, содержит ли запрос любой из заданных элементов ввода.
bool filled(строка|массив $key)
Определить, содержит ли запрос непустое значение для элемента ввода.
protected bool isEmptyString(строка $key)
Определить, является ли заданный ключ элемента ввода пустой строкой для "has".
массив keys()
Получить ключи для всех элементов ввода и файлов.
массив all(массив|смешанный $keys = null)
Получить все элементы ввода и файлы для запроса.
строка|массив input(строка $key = null, строка|массив|null $default = null)
Получить элемент ввода из запроса.
массив only(массив|смешанный $keys)
Получить подмножество, содержащее предоставленные ключи со значениями из данных ввода.
массив except(массив|смешанный $keys)
Получить все элементы ввода, кроме указанного массива элементов.
строка|массив query(строка $key = null, строка|массив|null $default = null)
Получить элемент строки запроса из запроса.
строка|массив post(строка $key = null, строка|массив|null $default = null)
Получить элемент тела запроса из запроса.
bool hasCookie(строка $key)
Определить, установлен ли куки в запросе.
строка|массив cookie(строка $key = null, строка|массив|null $default = null)
Получить куки из запроса.
массив allFiles()
Получить массив всех файлов в запросе.
protected массив convertUploadedFiles(массив $files)
Преобразовать заданный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles.
bool hasFile(строка $key)
Определить, содержит ли загруженные данные файл.
protected bool isValidFile(смешанный $file)
Проверить, является ли заданный файл допустимым экземпляром файла.
ЗагруженныйФайл|массив|null file(строка $key = null, смешанный $default = null)
Получить файл из запроса.
protected строка|массив retrieveItem(строка $source, строка $key, строка|массив|null $default)
Получить элемент параметра из заданного источника.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макрос.
static void mixin(object $mixin)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макрос.
static mixed __callStatic(string $method, array $parameters)
Динамически обработать вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обработать вызовы класса.
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(dynamic $patterns)
Определить, соответствует ли текущий URI запроса шаблону.
bool routeIs(dynamic $patterns)
Определить, соответствует ли имя маршрута заданному шаблону.
bool fullUrlIs(dynamic $patterns)
Определить, соответствует ли текущий URL запроса и строка запроса шаблону.
bool ajax()
Определить, является ли запрос результатом вызова AJAX.
bool pjax()
Определить, является ли запрос результатом вызова PJAX.
bool secure()
Определить, осуществляется ли запрос по протоколу HTTPS.
string ip()
Получить IP-адрес клиента.
array ips()
Получить IP-адреса клиентов.
string userAgent()
Получить user agent клиента.
void merge(array $input)
Объединить новые данные в текущий массив данных запроса.
void replace(array $input)
Заменить входные данные для текущего запроса.
mixed json(string $key = null, mixed $default = null)
Получить JSON-загрузку для запроса.
protected ParameterBag getInputSource()
Получить источник входных данных для запроса.
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}
protected mixed filterFiles(mixed $files)
Отфильтровать предоставленный массив файлов, удалив любые пустые значения.
Store session()
Получить сеанс, связанный с запросом.
void setLaravelSession(Session $session)
Установить экземпляр сеанса в запросе.
mixed user(string|null $guard = null)
Получить пользователя, который делает запрос.
Route|object|string route(string|null $param = null)
Получить маршрут, обрабатывающий запрос.
string fingerprint()
Получить уникальный отпечаток запроса/маршрута/IP-адреса.
$this setJson(array $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)
Проверить, установлено ли элемент входных данных в запросе.
смешанный __get(string $key)
Получить элемент ввода из запроса.
массив validate(array $rules, array $messages = [], array $customAttributes = [])
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Http/Request.html
