Абстрактный класс Phalcon\Http\Message\AbstractRequest

Source on GitHub

Пространство имен	Phalcon\Http\Message
Использует	Phalcon\Collection, Phalcon\Http\Message\Exception\InvalidArgumentException, Psr\Http\Message\UriInterface
Расширяет	AbstractMessage

Метод запроса

Свойства

/**
 * Извлекает HTTP-метод запроса.
 *
 * @var string
 */
protected method = GET;

/**
 * Запрос-цель, если он был предоставлен или рассчитан.
 *
 * @var null|string
 */
protected requestTarget;

/**
 * Извлекает экземпляр URI.
 *
 * Этот метод должен возвращать экземпляр UriInterface.
 *
 * @see http://tools.ietf.org/html/rfc3986#section-4.3
 *
 * @var UriInterface
 */
protected uri;

Методы

public function getMethod(): string

public function getRequestTarget(): string;

Получает цель запроса сообщения.

Извлекает цель запроса сообщения либо в том виде, в котором оно будет отображаться (для клиентов), так же, как оно отображалось в запросе (для серверов), или в том виде, в котором оно было указано для экземпляра (см. WithRequestTarget ()).

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

public function getUri(): UriInterface

public function withMethod( mixed $method ): object;

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

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

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

public function withRequestTarget( mixed $requestTarget ): object;

Возвратите экземпляр с определенной целью запроса.

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

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

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

public function withUri( UriInterface $uri, mixed $preserveHost = bool ): object;

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

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

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

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

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

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

final protected function processMethod( mixed $method = string ): string;

Проверить метод

final protected function processUri( mixed $uri ): UriInterface;

Устанавливает действительный Uri