Класс Request

Реализует методы для HTTP-запросов.

Используется Cake\Http\Client для хранения информации о запросе для отправки запросов.

Пространство имён: Cake\Http\Client

Константы

string

METHOD_DELETE
```
'DELETE'
```
Метод HTTP DELETE
string

METHOD_GET
```
'GET'
```
Метод HTTP GET
string

METHOD_HEAD
```
'HEAD'
```
Метод HTTP HEAD
string

METHOD_OPTIONS
```
'OPTIONS'
```
Метод HTTP OPTIONS
string

METHOD_PATCH
```
'PATCH'
```
Метод HTTP PATCH
string

METHOD_POST
```
'POST'
```
Метод HTTP POST
string

METHOD_PUT
```
'PUT'
```
Метод HTTP PUT
string

METHOD_TRACE
```
'TRACE'
```
Метод HTTP TRACE
int

STATUS_ACCEPTED
```
202
```
Код HTTP 202
int

STATUS_CREATED
```
201
```
Код HTTP 201
int

STATUS_FOUND
```
302
```
Код HTTP 302
int

STATUS_MOVED_PERMANENTLY
```
301
```
Код HTTP 301
int

STATUS_NON_AUTHORITATIVE_INFORMATION
```
203
```
Код HTTP 203
int

STATUS_NO_CONTENT
```
204
```
Код HTTP 204
int

STATUS_OK
```
200
```
Код HTTP 200
int

STATUS_PERMANENT_REDIRECT
```
308
```
Код HTTP 308
int

STATUS_SEE_OTHER
```
303
```
Код HTTP 303
int

STATUS_TEMPORARY_REDIRECT
```
307
```
Код HTTP 307

Краткое описание свойств

$_cookies protected

array

Массив куки в ответе.
$headerNames protected

array

Сопоставление нормализованного имени заголовка с исходным именем, использованным для регистрации заголовка.
$headers protected

array

Список всех зарегистрированных заголовков в формате ключ => массив значений.

END_OF_DOCUMENT_MARKER

Краткое описание методов

__construct() public

Конструктор
addHeaders() protected

Добавить массив заголовков в запрос.
cookies() public

Получить все куки
getBody() public

Получить тело сообщения.
getHeader() public

Извлекает значение заголовка сообщения по заданному имени, не чувствительному к регистру.
getHeaderLine() public

Извлекает строку, содержащую значения заголовка, разделенные запятыми.
getHeaders() public

Извлекает все заголовки сообщения.
getMethod() public

Извлекает HTTP-метод запроса.
getProtocolVersion() public

Извлекает HTTP-версию протокола в виде строки.
getRequestTarget() public

Извлекает целевой объект запроса сообщения.
getUri() public

Извлекает экземпляр URI.
hasHeader() public

Проверяет наличие заголовка по заданному имени, не чувствительному к регистру.
setContent() protected

Установить тело/полезную нагрузку для сообщения.
withAddedHeader() public

Возвращает экземпляр с добавленным заголовком со значением.
withBody() public

Возвращает экземпляр со значением тела сообщения.
withHeader() public

Возвращает экземпляр с заданным заголовком, заменяя все существующие значения заголовков с тем же именем, нечувствительным к регистру.
withMethod() public

Возвращает экземпляр с заданным HTTP-методом.
withProtocolVersion() public

Возвращает экземпляр со значением HTTP-версии протокола.
withRequestTarget() public

Создает новый экземпляр с определённым целевым объектом запроса.
withUri() public

Возвращает экземпляр с предоставленным URI.
withoutHeader() public

Возвращает экземпляр без указанного заголовка.

Подробное описание методов

__construct() public

__construct(string $url = '', string $method = self::METHOD_GET, array $headers = [], array|string|null $data = null)

Конструктор

Предоставляет обратную совместимость по умолчанию для некоторых свойств.

Параметры

string $url необязательно: URL запроса
string $method необязательно: Метод HTTP, который использовать.
array $headers необязательно: HTTP-заголовки для установки.
array|string|null $data необязательно: Тело запроса для использования.

addHeaders() protected

addHeaders(array<string, string> $headers): void

Добавить массив заголовков к запросу.

Параметры

array<string, string> $headers: Заголовки для добавления.

Возвращает

void

cookies() public

cookies(): array

Получить все куки

Возвращает

array

getBody() public

getBody(): StreamInterface

Получить тело сообщения.

Возвращает

StreamInterface

getHeader() public

getHeader(string $header): string[]

Извлекает значение заголовка сообщения по заданному имени, не чувствительному к регистру.

Этот метод возвращает массив всех значений заголовка с заданным именем заголовка, не чувствительным к регистру.

Если заголовок отсутствует в сообщении, этот метод ДОЛЖЕН вернуть пустой массив.

Параметры

string $header: Имя поля заголовка, не чувствительное к регистру.

Возвращает

string[]

getHeaderLine() public

getHeaderLine(string $name): string

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

Этот метод возвращает все значения заголовка с заданным именем заголовка, не чувствительным к регистру, как строку, конкатенированную вместе с использованием запятой.

ПРИМЕЧАНИЕ. Не все значения заголовков могут быть корректно представлены с помощью конкатенации запятыми. Для таких заголовков используйте getHeader() вместо этого и укажите свой разделитель при конкатенации.

Если заголовок отсутствует в сообщении, этот метод ДОЛЖЕН вернуть пустую строку.

Параметры

string $name: Имя поля заголовка, не чувствительное к регистру.

Возвращает

string

getHeaders() public

getHeaders(): array

Возвращает все заголовки сообщения.

Ключи представляют имя заголовка, как оно будет отправлено по сети, а каждое значение — массив строк, связанных с заголовком.

// Представить заголовки в виде строки foreach ($message->getHeaders() as $name => $values) { echo $name . ": " . implode(", ", $values); }

// Выводить заголовки поочередно: foreach ($message->getHeaders() as $name => $values) { foreach ($values as $value) { header(sprintf('%s: %s', $name, $value), false); } }

Возвращает

array

getMethod() public

getMethod(): string

Возвращает HTTP-метод запроса.

Возвращает

string

getProtocolVersion() public

getProtocolVersion(): string

Возвращает HTTP-версию протокола в виде строки.

Строка ДОЛЖНА содержать только номер версии HTTP (например, "1.1", "1.0").

Возвращает

string

getRequestTarget() public

getRequestTarget(): string

Возвращает целевой параметр сообщения.

Возвращает целевой параметр запроса в том виде, в котором он отобразится (для клиентов), как он появился при запросе (для серверов) или как он был указан для экземпляра (см. сRequestTarget()).

В большинстве случаев это будет исходная форма URI, составленного URI, если не было предоставлено значение конкретной реализации (см. сRequestTarget() ниже).

Если доступен никакой URI, и никакой целевой параметр запроса не был указан специально, этот метод ДОЛЖЕН вернуть строку "/".

Возвращает

string

getUri() public

getUri(): UriInterface

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

Этот метод ДОЛЖЕН вернуть экземпляр UriInterface.

Возвращает

UriInterface

Ссылки

http://tools.ietf.org/html/rfc3986#section-4.3

hasHeader() public

hasHeader(string $header): bool

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

Параметры

string $header: Имя заголовка, не чувствительное к регистру.

Возвращает

bool

setContent() protected

setContent(array|string $content): $this

Установить тело/данные для сообщения.

Массив данных будет сериализован с помощью {@link \Cake\Http\FormData}, и тип контента будет установлен.

Параметры

array|string $content: Тело запроса.

Возвращает

$this

withAddedHeader() public

withAddedHeader(string $name, string|string[] $value): static

Возвращает экземпляр с добавленным заголовком со значением.

Существующие значения указанного заголовка будут сохранены. Новые значения будут добавлены к существующему списку. Если заголовок ранее не существовал, он будет добавлен.

Этот метод ДОЛЖЕН быть реализован таким образом, чтобы сохранить неизменяемость сообщения, и ДОЛЖЕН вернуть экземпляр с новым заголовком и/или значением.

Параметры

string $name: Имя поля заголовка, не чувствительное к регистру, для добавления.
string|string[] $value: Значение(я) заголовка.

Возвращает

static

Исключения

Exception\InvalidArgumentException
При неверных именах или значениях заголовков.

withBody() public

withBody(StreamInterface $body): static

Возвращает экземпляр с указанным телом сообщения.

Тело ДОЛЖНО быть объектом StreamInterface.

Этот метод ДОЛЖЕН быть реализован таким образом, чтобы сохранить неизменяемость сообщения, и ДОЛЖЕН вернуть новый экземпляр с новым потоком тела.

Параметры

StreamInterface $body: Тело.

Возвращает

static

Исключения

Exception\InvalidArgumentException
При неверном теле.

withHeader() public

withHeader(string $name, string|string[] $value): static

Возвращает экземпляр с предоставленным заголовком, заменяя любые существующие значения любых заголовков с тем же именем, не чувствительным к регистру.

Хотя имена заголовков не чувствительны к регистру, регистр заголовка будет сохранен этой функцией и возвращен из getHeaders().

Этот метод ДОЛЖЕН быть реализован таким образом, чтобы сохранить неизменяемость сообщения, и ДОЛЖЕН вернуть экземпляр с новым и/или обновленным заголовком и значением.

Параметры

string $name: Имя поля заголовка, не чувствительное к регистру.
string|string[] $value: Значение заголовка.

Возвращает

static

Исключения

Exception\InvalidArgumentException
При неверных именах или значениях заголовков.

withMethod() public

withMethod(string $method): static

Возвращает экземпляр с предоставленным HTTP-методом.

Хотя имена HTTP-методов обычно все заглавные буквы, имена HTTP-методов чувствительны к регистру, и поэтому реализации НЕ ДОЛЖНЫ изменять заданную строку.

Этот метод ДОЛЖЕН быть реализован таким образом, чтобы сохранить неизменяемость сообщения, и ДОЛЖЕН вернуть экземпляр с измененным методом запроса.

Параметры

string $method: Метод, не чувствительный к регистру.

Возвращает

static

Исключения

Exception\InvalidArgumentException
Для недопустимых HTTP-методов.

withProtocolVersion() public

withProtocolVersion(string $version): static

Возвращает экземпляр с указанной версией протокола HTTP.

Строка версии ДОЛЖНА содержать только номер версии HTTP (например, "1.1", "1.0").

Этот метод ДОЛЖЕН быть реализован таким образом, чтобы сохранить неизменяемость сообщения и ДОЛЖЕН вернуть экземпляр с новой версией протокола.

Параметры

string $version: Версия протокола HTTP

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

static

withRequestTarget() public

withRequestTarget(mixed $requestTarget): static

Создаёт новый экземпляр с указанным целевым объектом запроса.

Если запрос требует целевого объекта запроса, отличного от исходного — например, для указания абсолютной, авторизационной или звёздчатой формы — этот метод можно использовать для создания экземпляра с указанным целевым объектом запроса в точности.

Этот метод ДОЛЖЕН быть реализован таким образом, чтобы сохранить неизменяемость сообщения, и ДОЛЖЕН вернуть новый экземпляр с изменённой целью запроса.

Параметры

mixed $requestTarget

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

static

Исключения

Exception\InvalidArgumentException
Если целевой объект запроса недействителен.

Ссылки

http://tools.ietf.org/html/rfc7230#section-2.7 (для различных форм целевых объектов запроса, разрешённых в сообщениях запроса)

withUri() public

withUri(UriInterface $uri, bool $preserveHost = false): static

Возвращает экземпляр с предоставленным URI.

Этот метод по умолчанию обновит заголовок Host возвращаемого запроса, если URI содержит компонент host. Если URI не содержит компонент host, любой существующий заголовок Host будет передан в возвращаемый запрос.

Вы можете выбрать сохранение исходного состояния заголовка Host, установив $preserveHost на true. Когда $preserveHost установлено на true, возвращаемый запрос не будет обновлять заголовок Host возвращаемого сообщения — даже если в сообщении нет заголовка Host. Это означает, что вызов getHeader('Host') для исходного запроса ДОЛЖЕН быть равен результату вызова getHeader('Host') для возвращаемого запроса.

Этот метод ДОЛЖЕН быть реализован таким образом, чтобы сохранить неизменяемость сообщения, и ДОЛЖЕН вернуть экземпляр с новым объектом UriInterface.

Параметры

UriInterface $uri: Новый URI запроса для использования.
bool $preserveHost optional: Сохранить исходное состояние заголовка Host.

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

static

Ссылки

http://tools.ietf.org/html/rfc3986#section-4.3

withoutHeader() public

withoutHeader(string $name): static

Возвращает экземпляр без указанного заголовка.

Разрешение заголовков ДОЛЖНО выполняться без учёта регистра.

Этот метод ДОЛЖЕН быть реализован таким образом, чтобы сохранить неизменяемость сообщения, и ДОЛЖЕН вернуть экземпляр, удаляющий указанный заголовок.

Параметры

string $name: Имя поля заголовка, не учитывающее регистр, которое нужно удалить.

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

static

Подробное описание свойств

`$_cookies` protected

Массив куки в ответе.

Тип

array

`$headerNames` protected

Отображение нормализованного имени заголовка на исходное имя, используемое для регистрации заголовка.

Тип

array

`$headers` protected

Список всех зарегистрированных заголовков в виде ключ => массив значений.

Тип

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Http.Client.Request.html