Запрос
класс Запрос расширяет Request и реализует Arrayable, ArrayAccess (Просмотреть исходный код)
Трейты
| InteractsWithContentTypes | |
| InteractsWithFlashData | |
| InteractsWithInput | |
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённый ParameterBag|null | $json | Декодированное JSON-содержимое запроса. | |
| защищённый массив | $convertedFiles | Все преобразованные файлы для запроса. | |
| защищённый Closure | $userResolver | Обратный вызов для определения пользователя. | |
| защищённый Closure | $routeResolver | Обратный вызов для определения маршрута. |
Методы
| static bool | matchesType(string $actual, string $type)
Определить, совпадают ли заданные типы содержимого. | из InteractsWithContentTypes |
| bool | isJson()
Определить, отправляет ли запрос данные в формате JSON. | из InteractsWithContentTypes |
| bool | expectsJson()
Определить, ожидает ли текущий запрос, вероятно, ответ в формате JSON. | из InteractsWithContentTypes |
| bool | wantsJson()
Определить, запрашивает ли текущий запрос данные в формате JSON. | из InteractsWithContentTypes |
| bool | accepts(string|array $contentTypes)
Определяет, принимает ли текущий запрос указанный тип содержимого. | из InteractsWithContentTypes |
| string|null | prefers(string|array $contentTypes)
Возвращает наиболее подходящий тип содержимого из заданного массива на основе согласования типов содержимого. | из InteractsWithContentTypes |
| bool | acceptsAnyContentType()
Определить, принимает ли текущий запрос любой тип содержимого. | из InteractsWithContentTypes |
| bool | acceptsJson()
Определяет, принимает ли запрос JSON. | из InteractsWithContentTypes |
| bool | acceptsHtml()
Определяет, принимает ли запрос HTML. | из InteractsWithContentTypes |
| string | format(string $default = 'html')
Получить ожидаемый формат данных в ответе. | из InteractsWithContentTypes |
| string|array | old(string|null $key = null, string|array|null $default = null)
Получить старое значение входного элемента. | из InteractsWithFlashData |
| void | flash()
Передать входные данные текущего запроса в сессию. | из InteractsWithFlashData |
| void | flashOnly(array|mixed $keys)
Передать только некоторые входные данные в сессию. | из InteractsWithFlashData |
| void | flashExcept(array|mixed $keys)
Передать только некоторые входные данные в сессию. | из InteractsWithFlashData |
| void | flush()
Очистить все старые входные данные из сессии. | из InteractsWithFlashData |
| string|array|null | server(string|null $key = null, string|array|null $default = null)
Получить переменную сервера из запроса. | из InteractsWithInput |
| bool | hasHeader(string $key)
Определить, установлено ли заголовок в запросе. | из InteractsWithInput |
| string|array|null | header(string|null $key = null, string|array|null $default = null)
Получить заголовок из запроса. | из InteractsWithInput |
| string|null | bearerToken()
Получить токен доступа из заголовков запроса. | из InteractsWithInput |
| bool | exists(string|array $key)
Определить, содержит ли запрос заданный ключ входного элемента. | из InteractsWithInput |
| bool | has(string|array $key)
Определить, содержит ли запрос заданный ключ входного элемента. | из InteractsWithInput |
| bool | hasAny(string|array $keys)
Определить, содержит ли запрос любой из заданных входных данных. | из InteractsWithInput |
| $this|mixed | whenHas(string $key, callable $callback)
Применить обратный вызов, если запрос содержит заданный ключ входного элемента. | из InteractsWithInput |
| bool | filled(string|array $key)
Определить, содержит ли запрос непустое значение для входного элемента. | из InteractsWithInput |
| bool | isNotFilled(string|array $key)
Определить, содержит ли запрос пустое значение для входного элемента. | из InteractsWithInput |
| bool | anyFilled(string|array $keys)
Определить, содержит ли запрос непустое значение для любого из заданных входных данных. | из InteractsWithInput |
| $this|mixed | whenFilled(string $key, callable $callback)
Применить обратный вызов, если запрос содержит непустое значение для заданного ключа входного элемента. | из InteractsWithInput |
| bool | missing(string|array $key)
Определить, отсутствует ли заданный ключ входного элемента в запросе. | из InteractsWithInput |
| bool | isEmptyString(string $key)
Определить, является ли заданный ключ входного элемента пустой строкой для «has». | из InteractsWithInput |
| array | keys()
Получить ключи для всех входных данных и файлов. | из InteractsWithInput |
| array | all(array|mixed|null $keys = null)
Получить все входные данные и файлы для запроса. | из InteractsWithInput |
| mixed | input(string|null $key = null, mixed $default = null)
Получить элемент входных данных из запроса. | из InteractsWithInput |
| bool | boolean(string|null $key = null, bool $default = false)
Получить входные данные в качестве булевого значения. | из InteractsWithInput |
| array | only(array|mixed $keys)
Получить подмножество, содержащее предоставленные ключи со значениями из входных данных. | из 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()
Определить, является ли запрос результатом предварительного вызова. | |
| bool | secure()
Определить, использует ли запрос HTTPS. | |
| string|null | ip()
Получить IP-адрес клиента. | |
| array | ips()
Получить IP-адреса клиента. | |
| string|null | userAgent()
Получить user agent клиента. | |
| $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|null | 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)
Получить элемент входных данных из запроса. | |
| array | validate(array $rules, mixed $params) Без описания | |
| array | validateWithBag(string $errorBag, array $rules, mixed $params) Без описания | |
| bool | hasValidSignature(bool $absolute = true) Без описания |
Подробности
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 acceptsAnyContentType()
Определить, принимает ли текущий запрос любой тип содержимого.
bool acceptsJson()
Определяет, принимает ли запрос JSON.
bool acceptsHtml()
Определяет, принимает ли запрос HTML.
string format(string $default = 'html')
Получить ожидаемый формат данных в ответе.
string|array old(string|null $key = null, string|array|null $default = null)
Получить элемент ввода из старого запроса.
void flash()
Передать входные данные текущего запроса в сеанс.
void flashOnly(array|mixed $keys)
Передать в сеанс только некоторые данные ввода.
void flashExcept(array|mixed $keys)
Передать в сеанс только некоторые данные ввода.
void flush()
Очистить все старые данные ввода из сеанса.
string|array|null server(string|null $key = null, string|array|null $default = null)
Получить переменную сервера из запроса.
bool hasHeader(string $key)
Определить, установлен ли заголовок в запросе.
string|array|null header(string|null $key = null, string|array|null $default = null)
Получить заголовок из запроса.
string|null bearerToken()
Получить токен bearer из заголовков запроса.
bool exists(string|array $key)
Определить, содержит ли запрос заданный ключ элемента ввода.
bool has(string|array $key)
Определить, содержит ли запрос заданный ключ элемента ввода.
bool hasAny(string|array $keys)
Определить, содержит ли запрос любой из заданных элементов ввода.
$this|mixed whenHas(string $key, callable $callback)
Применить обратный вызов, если запрос содержит заданный ключ элемента ввода.
bool filled(string|array $key)
Определить, содержит ли запрос ненулевое значение для элемента ввода.
bool isNotFilled(string|array $key)
Определить, содержит ли запрос пустое значение для элемента ввода.
bool anyFilled(string|array $keys)
Определить, содержит ли запрос ненулевое значение для любого из заданных элементов ввода.
$this|mixed whenFilled(string $key, callable $callback)
Применить обратный вызов, если запрос содержит ненулевое значение для заданного ключа элемента ввода.
bool missing(string|array $key)
Определить, отсутствует ли заданный ключ элемента ввода в запросе.
protected bool isEmptyString(string $key)
Определить, является ли заданный ключ ввода пустой строкой для "has".
array keys()
Получить ключи для всех элементов ввода и файлов.
array all(array|mixed|null $keys = null)
Получить все входные данные и файлы для запроса.
mixed input(string|null $key = null, mixed $default = null)
Получить элемент входных данных из запроса.
bool boolean(string|null $key = null, bool $default = false)
Получить входные данные в виде булевого значения.
Возвращает true, если значение равно "1", "true", "on", или "yes". В противном случае возвращает false.
array only(array|mixed $keys)
Получить подмножество, содержащее указанные ключи со значениями из входных данных.
array except(array|mixed $keys)
Получить все входные данные, кроме указанного массива элементов.
string|array|null query(string|null $key = null, string|array|null $default = null)
Получить элемент строки запроса из запроса.
string|array|null post(string|null $key = null, string|array|null $default = null)
Получить элемент полезной нагрузки запроса из запроса.
bool hasCookie(string $key)
Определить, установлен ли cookie в запросе.
string|array|null cookie(string|null $key = null, string|array|null $default = null)
Получить cookie из запроса.
array allFiles()
Получить массив всех файлов в запросе.
protected array convertUploadedFiles(array $files)
Преобразовать данный массив Symfony UploadedFiles в пользовательские Laravel UploadedFiles.
bool hasFile(string $key)
Определить, содержит ли загруженные данные файл.
protected bool isValidFile(mixed $file)
Проверить, является ли данный файл допустимой экземпляром файла.
UploadedFile|UploadedFile[]|array|null file(string|null $key = null, mixed $default = null)
Получить файл из запроса.
protected string|array|null retrieveItem(string $source, string $key, string|array|null $default)
Получить элемент параметра из заданного источника.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос.
static void mixin(object $mixin, bool $replace = true)
Добавить другой объект в класс.
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()
Возвращает экземпляр 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|null userAgent()
Получить пользовательский агент клиента.
$this merge(array $input)
Слить новые входные данные в текущий массив входных данных запроса.
$this replace(array $input)
Заменить входные данные для текущего запроса.
mixed get(string $key, mixed $default = null)
Этот метод принадлежит Symfony HttpFoundation и обычно не нужен при использовании Laravel.
Вместо этого вы можете использовать метод "input".
ParameterBag|mixed json(string|null $key = null, mixed $default = null)
Получить JSON-полезную нагрузку для запроса.
protected ParameterBag getInputSource()
Получить источник ввода для запроса.
static Запрос createFrom(Запрос $from, Запрос|null $to = null)
Создать новый экземпляр запроса из заданного Laravel-запроса.
static Запрос createFromBase(Запрос $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)
Отфильтровать заданный массив файлов, удалив пустые значения.
Хранилище session()
Получить сеанс, связанный с запросом.
Хранилище|null getSession()
Получить сеанс, связанный с запросом.
void setLaravelSession(Сеанс $session)
Установить экземпляр сеанса в запросе.
mixed user(string|null $guard = null)
Получить пользователя, производящего запрос.
Маршрут|object|string|null route(string|null $param = null, mixed $default = null)
Получить маршрут, обрабатывающий запрос.
string fingerprint()
Получить уникальный отпечаток запроса/маршрута/IP-адреса.
$this setJson(ParameterBag $json)
Установить JSON-загрузку для запроса.
Замыкание getUserResolver()
Получить обратный вызов для разрешения пользователя.
$this setUserResolver(Замыкание $callback)
Установить обратный вызов для разрешения пользователя.
Замыкание getRouteResolver()
Получить обратный вызов для разрешения маршрута.
$this setRouteResolver(Замыкание $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, mixed $params)
Описание отсутствует
array validateWithBag(string $errorBag, array $rules, mixed $params)
Описание отсутствует
bool hasValidSignature(bool $absolute = true)
Описание отсутствует
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Http/Request.html
