Финальный класс Phalcon\Http\Message\Uri

Source on GitHub

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

PSR-7 Uri

Свойства

/**
 * Возвращает фрагмент URL
 *
 * @return string
 */
private fragment = ;

/**
 * Получить хост-компонент URI.
 *
 * Если хост отсутствует, этот метод ДОЛЖЕН вернуть пустую строку.
 *
 * Возвращенное значение ДОЛЖНО быть нормализовано в нижний регистр 
 * в соответствии с RFC 3986, раздел 3.2.2.
 *
 * @see http://tools.ietf.org/html/rfc3986#section-3.2.2
 *
 * @return string
 */
private host = ;

/**
 * @var string
 */
private pass = ;

/**
 * Возвращает путь URL
 *
 * @return string
 */
private path = ;

/**
 * Получите компонент порта URI.
 *
 * Если порт присутствует, и он нестандартен для текущей схемы, этот метод
 * ДОЛЖЕН вернуть его как целое число. Если порт является стандартным портом, 
 * используемым в текущей схеме, этот метод ДОЛЖЕН возвратить ноль.
 *
 * Если порт отсутствует и схема отсутствует, этот метод ДОЛЖЕН
 * вернуть нулевое значение.
 *
 * Если порт отсутствует, но присутствует схема, этот метод МОЖЕТ вернуть 
 * стандартный порт для этой схемы, но ДОЛЖЕН вернуть ноль.
 *
 * @return int|null
 */
private port;

/**
 * Возвращает запрос URL
 *
 * @return string
 */
private query = ;

/**
 * Получить компонент схемы URI.
 *
 * Если схема отсутствует, этот метод ДОЛЖЕН вернуть пустую строку.
 *
 * Возвращенное значение ДОЛЖНО быть нормализовано в нижний регистр,
 * согласно RFC 3986, раздел 3.1.
 *
 * Конечный символ «:» не является частью схемы и НЕ ДОЛЖЕН
 * добавляться.
 *
 * @see https://tools.ietf.org/html/rfc3986#section-3.1
 *
 * @return string
 */
private scheme = https;

/**
 * @var string
 */
private user = ;

Методы

public function __construct( string $uri = string );

Конструктор

public function __toString(): string;

Вернуть строковое представление в виде ссылки на URI.

В зависимости от того, какие компоненты URI присутствуют, результирующая строка является либо полным URI, либо относительной ссылкой в соответствии с RFC 3986, раздел 4.1. Метод объединяет различные компоненты URI, используя соответствующие разделители

public function getAuthority(): string;

Получите компонент полномочий URI.

public function getFragment()

public function getHost()

public function getPath()

public function getPort()

public function getQuery()

public function getScheme()

public function getUserInfo(): string;

Получить компонент информации о пользователях из URI.

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

Если пользователь присутствует в URI, это вернет это значение; Кроме того, если пароль также присутствует, он будет добавлен к пользовательскому значению с двоеточием («:»), разделяющим значения.

Конечный символ «@» не является частью информации пользователя и НЕ ДОЛЖЕН добавляться.

public function withFragment( mixed $fragment ): Uri;

Вернуть экземпляр с указанным фрагментом URI.

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

Пользователи могут предоставлять как закодированные, так и декодированные символы фрагмента. Реализации обеспечивают правильную кодировку, как описано в getFragment ().

Пустое значение фрагмента эквивалентно удалению фрагмента.

public function withHost( mixed $host ): Uri;

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

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

Пустое значение хоста эквивалентно удалению хоста.

public function withPath( mixed $path ): Uri;

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

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

Путь может быть пустым или абсолютным (начиная с косой черты) или без корня (не начиная с косой черты). Реализации ДОЛЖНЫ поддерживать все три синтаксиса.

Если путь HTTP предназначен для относительного хоста, а не для пути, то он должен начинаться с косой черты («/»). Предполагается, что пути HTTP, не начинающиеся с косой черты, относятся к некоторому базовому пути, известному приложению или потребителю.

Пользователи могут предоставлять как закодированные, так и декодированные символы пути. Реализации обеспечивают правильную кодировку, как описано в getPath ().

public function withPort( mixed $port ): Uri;

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

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

Реализации ДОЛЖНЫ выдавать исключение для портов за пределами установленных диапазонов портов TCP и UDP.

Нулевое значение, предоставленное для порта, эквивалентно удалению информации о порте.

public function withQuery( mixed $query ): Uri;

Вернуть экземпляр с указанной строкой запроса.

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

Пользователи могут предоставлять как закодированные, так и декодированные символы запроса. Реализации обеспечивают правильную кодировку, как описано в getQuery ().

Пустое значение строки запроса эквивалентно удалению строки запроса.

public function withScheme( mixed $scheme ): Uri;

Вернуть экземпляр с указанной схемой.

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

Реализации ДОЛЖНЫ поддерживать схемы «http» и «https» без учета регистра и МОГУТ приспосабливаться к другим схемам, если это необходимо.

Пустая схема эквивалентна удалению схемы.

public function withUserInfo( mixed $user, mixed $password = null ): Uri;

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