Запрос
класс Запрос расширяет Request, реализует Arrayable, ArrayAccess (Просмотр исходного кода)
Трейты
| Взаимодействие с типами содержимого | |
| Взаимодействие со всплывающими данными | |
| Взаимодействие с входными данными | |
| Макросовместимый |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Макросовместимый |
| защищённый ParameterBag|null | $json | Декодированное JSON-содержимое запроса. | |
| защищённый массив | $convertedFiles | Все преобразованные файлы для запроса. | |
| защищённый Closure | $userResolver | Обратный вызов для разрешения пользователя. | |
| защищённый Closure | $routeResolver | Обратный вызов для разрешения маршрута. |
Методы
| 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 |
| static bool | matchesType(string $actual, string $type)
Определить, совпадают ли заданные типы содержимого. | из InteractsWithContentTypes |
| string | format(string $default = 'html')
Получить ожидаемый формат данных в ответе. | из InteractsWithContentTypes |
| string|array|null | 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, callable $default = null)
Применить обратный вызов, если запрос содержит заданный ключ элемента ввода. | из 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, callable $default = null)
Применить обратный вызов, если запрос содержит ненулевое значение для заданного ключа элемента ввода. | из InteractsWithInput |
| bool | missing(string|array $key)
Определить, отсутствует ли заданный ключ элемента ввода в запросе. | из InteractsWithInput |
| bool | isEmptyString(string $key)
Определить, является ли заданный ключ элемента ввода пустой строкой для "has". | из InteractsWithInput |
| array | keys()
Получить ключи для всех входных данных и файлов. | from InteractsWithInput |
| array | all(array|mixed|null $keys = null)
Получить все входные данные и файлы для запроса. | from InteractsWithInput |
| mixed | input(string|null $key = null, mixed $default = null)
Извлечь элемент входных данных из запроса. | from InteractsWithInput |
| bool | boolean(string|null $key = null, bool $default = false)
Извлечь входные данные в виде булевого значения. | from InteractsWithInput |
| Carbon|null | date(string $key, string|null $format = null, string|null $tz = null)
Извлечь входные данные из запроса в виде экземпляра Carbon. | from InteractsWithInput |
| Collection | collect(array|string|null $key = null)
Извлечь входные данные из запроса в виде коллекции. | from InteractsWithInput |
| array | only(array|mixed $keys)
Получить подмножество, содержащее указанные ключи со значениями из входных данных. | from InteractsWithInput |
| array | except(array|mixed $keys)
Получить все входные данные, за исключением указанного массива элементов. | from InteractsWithInput |
| string|array|null | query(string|null $key = null, string|array|null $default = null)
Извлечь элемент строки запроса из запроса. | from InteractsWithInput |
| string|array|null | post(string|null $key = null, string|array|null $default = null)
Извлечь элемент полезной нагрузки запроса из запроса. | from InteractsWithInput |
| bool | hasCookie(string $key)
Определить, установлен ли cookie в запросе. | from InteractsWithInput |
| string|array|null | cookie(string|null $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|UploadedFile[]|array|null | file(string|null $key = null, mixed $default = null)
Извлечь файл из запроса. | from InteractsWithInput |
| string|array|null | retrieveItem(string $source, string $key, string|array|null $default)
Извлечь элемент параметра из заданного источника. | from InteractsWithInput |
| void | dd(mixed ...$keys)
Вывести элементы запроса и завершить скрипт. | from InteractsWithInput |
| $this | dump(mixed $keys = [])
Вывести элементы. | from InteractsWithInput |
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name)
Проверить, зарегистрирован ли макрос. | from Macroable |
| static void | flushMacros()
Очистить существующие макросы. | 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()
Вернуть экземпляр Request. | |
| string | method()
Получить метод запроса. | |
| string | root()
Получить корневой URL для приложения. | |
| string | url()
Получить URL (без строки запроса) для запроса. | |
| string | fullUrl()
Получить полный URL для запроса. | |
| string | fullUrlWithQuery(array $query)
Получить полный URL для запроса с добавленными параметрами строки запроса. |
| string | fullUrlWithoutQuery($keys)
Получить полный 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 | mergeIfMissing(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. | |
| Request | 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) Без описания |
Подробности
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.
static bool matchesType(string $actual, string $type)
Определить, совпадают ли заданные типы контента.
string format(string $default = 'html')
Получить ожидаемый формат данных в ответе.
string|array|null 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, callable $default = null)
Применить обратный вызов, если запрос содержит заданный ключ элемента ввода.
bool filled(string|array $key)
Определить, содержит ли запрос ненулевое значение для элемента ввода.
bool isNotFilled(string|array $key)
Определить, содержит ли запрос пустое значение для элемента ввода.
bool anyFilled(string|array $keys)
Определите, содержит ли запрос ненулевое значение для любого из заданных входных данных.
$this|mixed whenFilled(string $key, callable $callback, callable $default = null)
Примените обратный вызов, если запрос содержит ненулевое значение для заданного ключа элемента ввода.
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.
Carbon|null date(string $key, string|null $format = null, string|null $tz = null)
Извлечь входные данные из запроса в качестве экземпляра Carbon.
Collection collect(array|string|null $key = null)
Извлечь входные данные из запроса в виде коллекции.
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)
Проверить, является ли предоставленный файл допустимым экземпляром файла.
Загруженный файл|Загруженный файл[]|массив|null file(строка|null $key = null, смешанное $default = null)
Получить файл из запроса.
protected строка|массив|null retrieveItem(строка $source, строка $key, строка|массив|null $default)
Получить элемент параметра из указанного источника.
void dd(смешанное ...$keys)
Вывести элементы запроса и завершить скрипт.
$this dump(смешанное $keys = [])
Вывести элементы.
static void macro(строка $name, объект|вызываемый $macro)
Зарегистрировать пользовательское макро.
static void mixin(объект $mixin, bool $replace = true)
Добавить другой объект в класс.
static bool hasMacro(строка $name)
Проверяет, зарегистрировано ли макро.
static void flushMacros()
Очистить существующие макросы.
static смешанное __callStatic(строка $method, массив $parameters)
Динамически обрабатывает вызовы класса.
смешанное __call(строка $method, массив $parameters)
Динамически обрабатывает вызовы класса.
static Запрос capture()
Создать новый запрос HTTP Illuminate из переменных сервера.
$this instance()
Возвратить экземпляр запроса.
строка method()
Получить метод запроса.
строка root()
Получить корневой URL приложения.
строка url()
Получить URL (без строки запроса) для запроса.
строка fullUrl()
Получить полный URL для запроса.
строка fullUrlWithQuery(массив $query)
Получить полный URL для запроса с добавленными параметрами строки запроса.
строка fullUrlWithoutQuery($keys)
Получить полный URL для запроса без указанных параметров строки запроса.
строка path()
Получить текущий путь информации для запроса.
строка decodedPath()
Получить текущую декодированную информацию о пути для запроса.
строка|null segment(целое $index, строка|null $default = null)
Получить сегмент из URI (индекс с основанием 1).
массив segments()
Получить все сегменты для пути запроса.
bool is(смешанное ...$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()
Получить user agent клиента.
$this merge(array $input)
Объединить новые данные в массив входных данных текущего запроса.
$this mergeIfMissing(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 Request createFrom(Request $from, Request|null $to = null)
Создать новый экземпляр запроса из указанного запроса Laravel.
static Request createFromBase(Request $request)
Создать запрос Illuminate из экземпляра Symfony.
Request 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()
Получить сессию, связанную с запросом.
Store|null getSession()
Получить сессию, связанную с запросом.
void setLaravelSession(Session $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/8.x/Illuminate/Http/Request.html