PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of Uri.php

PSR-7 URI implementation.

param: string $uri URI to parse

UTF-8 aware \parse_url() replacement.

The internal function produces broken output for non ASCII domain names
(IDN) when used with locales other than "C".

On the other hand, cURL understands IDN correctly only when UTF-8 locale
is configured ("C.UTF-8", "en_US.UTF-8", etc.).

param: string $url
return: array|false

__toString() X-Ref

No description

composeComponents($scheme, $authority, $path, $query, $fragment) X-Ref

Composes a URI reference string from its various components.

Usually this method does not need to be called manually but instead is used indirectly via
`Psr\Http\Message\UriInterface::__toString`.

PSR-7 UriInterface treats an empty component the same as a missing component as
getQuery(), getFragment() etc. always return a string. This explains the slight
difference to RFC 3986 Section 5.3.

Another adjustment is that the authority separator is added even when the authority is missing/empty
for the "file" scheme. This is because PHP stream functions like `file_get_contents` only work with
`file:///myfile` but not with `file:/myfile` although they are equivalent according to RFC 3986. But
`file:///` is the more common syntax for the file scheme anyway (Chrome for example redirects to
that format).

param: string $scheme
param: string $authority
param: string $path
param: string $query
param: string $fragment
return: string

isDefaultPort(UriInterface $uri) X-Ref

Whether the URI has the default port of the current scheme.

`Psr\Http\Message\UriInterface::getPort` may return null or the standard port. This method can be used
independently of the implementation.

param: UriInterface $uri
return: bool

isAbsolute(UriInterface $uri) X-Ref

Whether the URI is absolute, i.e. it has a scheme.

An instance of UriInterface can either be an absolute URI or a relative reference. This method returns true
if it is the former. An absolute URI has a scheme. A relative reference is used to express a URI relative
to another URI, the base URI. Relative references can be divided into several forms:
- network-path references, e.g. '//example.com/path'
- absolute-path references, e.g. '/path'
- relative-path references, e.g. 'subpath'

param: UriInterface $uri
return: bool

isNetworkPathReference(UriInterface $uri) X-Ref

Whether the URI is a network-path reference.

A relative reference that begins with two slash characters is termed an network-path reference.

param: UriInterface $uri
return: bool

isAbsolutePathReference(UriInterface $uri) X-Ref

Whether the URI is a absolute-path reference.

A relative reference that begins with a single slash character is termed an absolute-path reference.

param: UriInterface $uri
return: bool

isRelativePathReference(UriInterface $uri) X-Ref

Whether the URI is a relative-path reference.

A relative reference that does not begin with a slash character is termed a relative-path reference.

param: UriInterface $uri
return: bool

isSameDocumentReference(UriInterface $uri, UriInterface $base = null) X-Ref

Whether the URI is a same-document reference.

A same-document reference refers to a URI that is, aside from its fragment
component, identical to the base URI. When no base URI is given, only an empty
URI reference (apart from its fragment) is considered a same-document reference.

param: UriInterface $uri The URI to check
param: UriInterface|null $base An optional base URI to compare against
return: bool

removeDotSegments($path) X-Ref

Removes dot segments from a path and returns the new path.

param: string $path
return: string

resolve(UriInterface $base, $rel) X-Ref

Converts the relative URI into a new URI that is resolved against the base URI.

param: UriInterface $base Base URI
param: string|UriInterface $rel Relative URI
return: UriInterface

withoutQueryValue(UriInterface $uri, $key) X-Ref

Creates a new URI with a specific query string value removed.

Any existing query string values that exactly match the provided key are
removed.

param: UriInterface $uri URI to use as a base.
param: string $key Query string key to remove.
return: UriInterface

withQueryValue(UriInterface $uri, $key, $value) X-Ref

Creates a new URI with a specific query string value.

Any existing query string values that exactly match the provided key are
removed and replaced with the given key value pair.

A value of null will set the query string key without a value, e.g. "key"
instead of "key=value".

param: UriInterface $uri   URI to use as a base.
param: string       $key   Key to set.
param: string|null  $value Value to set
return: UriInterface

withQueryValues(UriInterface $uri, array $keyValueArray) X-Ref

Creates a new URI with multiple specific query string values.

It has the same behavior as withQueryValue() but for an associative array of key => value.

param: UriInterface $uri URI to use as a base.
param: array $keyValueArray Associative array of key and values
return: UriInterface

fromParts(array $parts) X-Ref

Creates a URI from a hash of `parse_url` components.

param: array $parts
return: UriInterface

getScheme() X-Ref

No description

getAuthority() X-Ref

No description

getUserInfo() X-Ref

No description

getHost() X-Ref

No description

getPort() X-Ref

No description