CloudCastle Curl

Uri
in package
implements Stringable

FinalYes

Неизменяемый разобранный URI.

Хранит компоненты адреса (схему, учётные данные, хост, порт, путь, запрос, фрагмент), даёт доступ к ним, позволяет менять запрос и умеет разрешать относительную ссылку из ответа-перенаправления по правилам RFC 3986.

Table of Contents

Interfaces

Stringable

Methods

__toString()  : string
Собрать URI обратно в строку.
host()  : string
Хост URI (в нижнем регистре).
parse()  : self
Разобрать URL в объект.
path()  : string
Путь URI.
port()  : int|null
Порт URI.
query()  : string
Строка запроса URI.
resolve()  : self
Разрешить ссылку из заголовка `Location` относительно текущего URI (RFC 3986).
scheme()  : string
Схема URI (в нижнем регистре).
userInfo()  : string
Учётные данные URI (`user:pass`).
withoutUserInfo()  : self
Копия URI без учётных данных пользователя.
withQueryParams()  : self
Копия URI с добавленными параметрами запроса.

Methods

__toString()

Собрать URI обратно в строку.

public __toString() : string
Attributes
#[Override]
Return values
string

строковое представление URI

host()

Хост URI (в нижнем регистре).

public host() : string
Return values
string

хост или пустая строка

parse()

Разобрать URL в объект.

public static parse(string $url) : self
Parameters
$url : string

абсолютный URL

Tags
throws
RequestException

если URL не разбирается

Return values
self

разобранный URI

path()

Путь URI.

public path() : string
Return values
string

путь (может быть пустым)

port()

Порт URI.

public port() : int|null
Return values
int|null

порт или null, если не задан

query()

Строка запроса URI.

public query() : string
Return values
string

запрос без ведущего ?

resolve()

Разрешить ссылку из заголовка `Location` относительно текущего URI (RFC 3986).

public resolve(string $location) : self

Абсолютная ссылка возвращается как есть; относительная дополняется схемой, хостом и (при необходимости) базовым путём текущего URI.

Parameters
$location : string

значение заголовка Location

Tags
throws
RequestException

если ссылка не разбирается

Return values
self

URI цели перенаправления

scheme()

Схема URI (в нижнем регистре).

public scheme() : string
Return values
string

схема (http, https или пустая строка)

userInfo()

Учётные данные URI (`user:pass`).

public userInfo() : string
Return values
string

учётные данные или пустая строка

withoutUserInfo()

Копия URI без учётных данных пользователя.

public withoutUserInfo() : self
Return values
self

новый URI без userInfo

withQueryParams()

Копия URI с добавленными параметрами запроса.

public withQueryParams(array<string, scalar|array<string|int, scalar>> $params) : self

Существующие параметры сохраняются; переданные значения дополняют строку запроса. Массивы кодируются в формате key[0]=... (RFC 3986, rawurlencode).

Parameters
$params : array<string, scalar|array<string|int, scalar>>

параметры запроса

Return values
self

новый URI со слитой строкой запроса

On this page

Search results