Documentation

Uri

in package

• Lwt

implements Conditionable, UriInterface

Tags

phpstan-import-type

ComponentMap from UriString

phpstan-import-type

InputComponentMap from UriString

Table of Contents

Interfaces

Conditionable

UriInterface

Constants

ASCII  = " eiasntrolud][cmp'\ng|hv.fb,:=-q10C2*yx)(L9AS/P\"EjMIk3>5T<D4}B{8FwR67UGN;JzV#HOW_&!K?XQ%Y\\\tZ+~^\$@`\x00\x01\x02\x03\x04\x05\x06\x07\x08\v\f\r\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f"

All ASCII letters sorted by typical frequency of occurrence.

MAXIMUM_CACHED_ITEMS  = 100

Maximum number of cached items.

REGEXP_BINARY  = ',(;|^)base64$,'

Base64 content regular expression pattern.

REGEXP_FILE_PATH  = ',^(?<delim>/)?(?<volume>[a-zA-Z])(?:[:|\|]|%7C)(?<rest>.*)?,'

Regular expression pattern to for file URI.

REGEXP_HOST_PORT  = ',^(?<host>(\[.*]|[^:])*)(:(?<port>[^/?#]*))?$,x'

RFC3986 IPvFuture host and port component.

REGEXP_INVALID_CHARS  = '/[\x00-\x1f\x7f]/'

RFC3986 invalid characters.

REGEXP_MIMETYPE  = ',^\w+/[-.\w]+(?:\+[-.\w]+)?$,'

Mimetype regular expression pattern.

REGEXP_WINDOW_PATH  = ',^(?<root>[a-zA-Z][:|\|]),'

Windows filepath regular expression pattern.

Properties

$authority  : string|null

$fragment  : string|null

$host  : string|null

$origin  : string|null

$pass  : string|null

$path  : string

$port  : int|null

$query  : string|null

$scheme  : string|null

$uriAsciiString  : string

$uriUnicodeString  : string

$user  : string|null

$userInfo  : string|null

Methods

__debugInfo()  : ComponentMap

__toString()  : string

Returns the string representation as a URI reference.

createFromBaseUri()  : static

DEPRECATION WARNING! This method will be removed in the next major point release.

createFromComponents()  : self

DEPRECATION WARNING! This method will be removed in the next major point release.

createFromDataPath()  : self

DEPRECATION WARNING! This method will be removed in the next major point release.

createFromServer()  : self

DEPRECATION WARNING! This method will be removed in the next major point release.

createFromString()  : self

DEPRECATION WARNING! This method will be removed in the next major point release.

createFromUnixPath()  : self

DEPRECATION WARNING! This method will be removed in the next major point release.

createFromUri()  : self

DEPRECATION WARNING! This method will be removed in the next major point release.

createFromWindowsPath()  : self

DEPRECATION WARNING! This method will be removed in the next major point release.

equals()  : bool

fromBaseUri()  : self

DEPRECATION WARNING! This method will be removed in the next major point release.

fromComponents()  : self

Create a new instance from a hash representation of the URI similar to PHP parse_url function result.

fromData()  : self

Create a new instance from a data URI string.

fromFileContents()  : self

Create a new instance from a data file path.

fromRfc8089()  : static

Creates a new instance from a RFC8089 compatible URI.

fromServer()  : self

Create a new instance from the environment.

fromTemplate()  : self

Creates a new instance from a template.

fromUnixPath()  : self

Create a new instance from a Unix path string.

fromWindowsPath()  : self

Create a new instance from a local Windows path string.

getAuthority()  : string|null

Retrieve the authority component of the URI.

getComponents()  : ComponentMap

DEPRECATION WARNING! This method will be removed in the next major point release.

getFragment()  : string|null

Retrieve the fragment component of the URI.

getHost()  : string|null

Retrieve the host component of the URI.

getOrigin()  : string|null

getPassword()  : string|null

getPath()  : string

Retrieve the path component of the URI.

getPort()  : int|null

Retrieve the port component of the URI.

getQuery()  : string|null

Retrieve the query string of the URI.

getScheme()  : string|null

Retrieve the scheme component of the URI.

getUnicodeHost()  : string|null

getUserInfo()  : string|null

Retrieve the user information component of the URI.

getUsername()  : string|null

Returns the user component encoded value.

isAbsolute()  : bool

Tells whether the URI is absolute.

isAbsolutePath()  : bool

Tells whether the URI is an absolute path.

isCrossOrigin()  : bool

Tells whether two URI do not share the same origin.

isDomainHost()  : bool

isIpHost()  : bool

isIpv4Host()  : bool

isIpv6Host()  : bool

isIpvFutureHost()  : bool

isLocalFile()  : bool

Tells whether the `file` scheme base URI represents a local file.

isNetworkPath()  : bool

Tells whether the URI is a network path.

isOpaque()  : bool

Tells whether the URI is opaque or not.

isRegisteredNameHost()  : bool

isRelativePath()  : bool

Tells whether the URI is a relative path.

isSameDocument()  : bool

Tells whether both URIs refer to the same document.

isSameOrigin()  : bool

jsonSerialize()  : string

Returns the string representation as a URI reference.

new()  : self

Create a new instance from a string.

normalize()  : static

Normalize a URI by applying non-destructive and destructive normalization rules as defined in RFC3986 and RFC3987.

parse()  : self|null

Returns a new instance from a URI and a Base URI.or null on failure.

relativize()  : static

Relativize a URI according to a base URI.

resolve()  : static

Resolves a URI against a base URI using RFC3986 rules.

toAsciiString()  : string

Returns the string representation as a URI reference.

toComponents()  : ComponentMap

Returns an associative array containing all the URI components.

toDisplayString()  : string

Returns the human-readable string representation of the URI as an IRI.

toFileContents()  : int|null

Save the data to a specific file.

toRfc8089()  : string|null

Returns a string representation of a File URI according to RFC8089.

toString()  : string

Returns the string representation as a URI reference.

toUnicodeString()  : string

Returns the string representation as a URI reference.

toUnixPath()  : string|null

Returns the Unix filesystem path.

toWindowsPath()  : string|null

Returns the Windows filesystem path.

tryNew()  : self|null

Create a new instance from a string or a stringable structure or returns null on failure.

when()  : static

Apply the callback if the given "condition" is (or resolves to) true.

withFragment()  : static

Return an instance with the specified URI fragment.

withHost()  : static

Return an instance with the specified host.

withPassword()  : static

withPath()  : static

Return an instance with the specified path.

withPort()  : static

Return an instance with the specified port.

withQuery()  : static

Return an instance with the specified query string.

withScheme()  : static

Return an instance with the specified scheme.

withUserInfo()  : static

Return an instance with the specified user information.

withUsername()  : static

__construct()  : mixed

assertValidPath()  : void

Assert the path is a compliant with RFC2397.

assertValidRfc3986Uri()  : void

assert the URI internal state is valid.

assertValidState()  : void

assert the URI scheme is valid.

fetchHostname()  : array{0: string|null, 1: int|null}

Returns the environment host.

fetchRequestUri()  : array<int, string|null>

Returns the environment path.

fetchScheme()  : string

Returns the environment scheme.

fetchUserInfo()  : array<string|int, mixed>

Returns the environment user info.

filterString()  : string|null

Filter a string.

formatDataPath()  : string

Filter the Path component.

formatFilePath()  : string

Format the path component for the URI scheme file.

formatHost()  : string|null

Validate and Format the Host component.

formatPath()  : string

Format the Path component.

formatPathWithEmptyBaseQuery()  : string

Formatting the path to keep a resolvable URI.

formatPort()  : int|null

Format the Port component.

formatRelativePath()  : string

Formatting the path to keep a valid URI.

formatScheme()  : string|null

Format the Scheme and Host component.

getSegments()  : array<string|int, string>

returns the path segments.

isNonEmptyHostUri()  : bool

URI validation for URI schemes which disallow the empty '' host.

isNonEmptyHostUriWithoutFragment()  : bool

URI validation for URIs schemes which disallow the empty '' host and forbids the fragment component.

isNonEmptyHostUriWithoutFragmentAndQuery()  : bool

URI validation for URIs schemes which disallow the empty '' host and forbids fragment and query components.

isUriWithSchemeAndPathOnly()  : bool

URI validation for URI schemes which allows only scheme and path components.

isUriWithSchemeHostAndPathOnly()  : bool

URI validation for URI schemes which allows only scheme, host and path components.

isValidBlob()  : bool

isValidMailto()  : bool

relativizePath()  : string

Relatives the URI for an authority-less target URI.

setOrigin()  : string|null

Sets the URI origin.

validateEmailList()  : bool

validateParameter()  : bool

Validate mediatype parameter.