Inheritance diagram for GuzzleHttp\Psr7\Uri:

Public Member Functions
	__construct ($uri='')

	__toString ()

	getAuthority ()

	getFragment ()

	getHost ()

	getPath ()

	getPort ()

	getQuery ()

	getScheme ()

	getUserInfo ()

	withFragment ($fragment)

	withHost ($host)

	withPath ($path)

	withPort ($port)

	withQuery ($query)

	withScheme ($scheme)

	withUserInfo ($user, $password=null)

Static Public Member Functions
static	composeComponents ($scheme, $authority, $path, $query, $fragment)

static	fromParts (array $parts)

static	isAbsolute (UriInterface $uri)

static	isAbsolutePathReference (UriInterface $uri)

static	isDefaultPort (UriInterface $uri)

static	isNetworkPathReference (UriInterface $uri)

static	isRelativePathReference (UriInterface $uri)

static	isSameDocumentReference (UriInterface $uri, UriInterface $base=null)

static	removeDotSegments ($path)

static	resolve (UriInterface $base, $rel)

static	withoutQueryValue (UriInterface $uri, $key)

static	withQueryValue (UriInterface $uri, $key, $value)

static	withQueryValues (UriInterface $uri, array $keyValueArray)

Data Fields
const	HTTP_DEFAULT_HOST = 'localhost'

Detailed Description

PSR-7 URI implementation.

Author: Michael Dowling; Tobias Schultze; Matthew Weier O'Phinney

Definition at line 13 of file Uri.php.

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Psr7\Uri::__construct ( $uri = '' )

Parameters

string $uri URI to parse

Definition at line 86 of file Uri.php.

Member Function Documentation

◆ __toString()

GuzzleHttp\Psr7\Uri::__toString ( )

Return the string representation as a URI reference.

Depending on which components of the URI are present, the resulting string is either a full URI or relative reference according to RFC 3986, Section 4.1. The method concatenates the various components of the URI, using the appropriate delimiters:

If a scheme is present, it MUST be suffixed by ":".
If an authority is present, it MUST be prefixed by "//".
The path can be concatenated without delimiters. But there are two cases where the path has to be adjusted to make the URI reference valid as PHP does not allow to throw an exception in __toString():
- If the path is rootless and an authority is present, the path MUST be prefixed by "/".
- If the path is starting with more than one "/" and no authority is present, the starting slashes MUST be reduced to one.
If a query is present, it MUST be prefixed by "?".
If a fragment is present, it MUST be prefixed by "#".

See also: http://tools.ietf.org/html/rfc3986#section-4.1

Returns: string

Implements Psr\Http\Message\UriInterface.

Definition at line 98 of file Uri.php.

References GuzzleHttp\Psr7\Uri\composeComponents(), and GuzzleHttp\Psr7\Uri\getAuthority().

◆ composeComponents()

static GuzzleHttp\Psr7\Uri::composeComponents	(	$scheme,
		$authority,
		$path,
		$query,
		$fragment
	)

static

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).

Parameters

string	$scheme
string	$authority
string	$path
string	$query
string	$fragment

Returns: string

https://tools.ietf.org/html/rfc3986#section-5.3

Definition at line 135 of file Uri.php.

Referenced by GuzzleHttp\Psr7\Uri\__toString(), and GuzzleHttp\Psr7\UriResolver\resolve().

◆ fromParts()

static GuzzleHttp\Psr7\Uri::fromParts ( array $parts )

static

Creates a URI from a hash of parse_url components.

Parameters

array $parts

Returns: UriInterface If the components do not form a valid URI.

Definition at line 385 of file Uri.php.

◆ getAuthority()

GuzzleHttp\Psr7\Uri::getAuthority ( )

Retrieve the authority component of the URI.

If no authority information is present, this method MUST return an empty string.

The authority syntax of the URI is:

[user-info@]host[:port]

If the port component is not set or is the standard port for the current scheme, it SHOULD NOT be included.

See also: https://tools.ietf.org/html/rfc3986#section-3.2

Returns: string The URI authority, in "[user-info@]host[:port]" format.

Implements Psr\Http\Message\UriInterface.

Definition at line 399 of file Uri.php.

Referenced by GuzzleHttp\Psr7\Uri\__toString().

◆ getFragment()

GuzzleHttp\Psr7\Uri::getFragment ( )

Retrieve the fragment component of the URI.

If no fragment is present, this method MUST return an empty string.

The leading "#" character is not part of the fragment and MUST NOT be added.

The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.5.

See also: https://tools.ietf.org/html/rfc3986#section-2; https://tools.ietf.org/html/rfc3986#section-3.5

Returns: string The URI fragment.

Implements Psr\Http\Message\UriInterface.

Definition at line 438 of file Uri.php.

◆ getHost()

GuzzleHttp\Psr7\Uri::getHost ( )

Retrieve the host component of the URI.

If no host is present, this method MUST return an empty string.

The value returned MUST be normalized to lowercase, per RFC 3986 Section 3.2.2.

See also: http://tools.ietf.org/html/rfc3986#section-3.2.2

Returns: string The URI host.

Implements Psr\Http\Message\UriInterface.

Definition at line 418 of file Uri.php.

◆ getPath()

GuzzleHttp\Psr7\Uri::getPath ( )

Retrieve the path component of the URI.

The path can either be empty or absolute (starting with a slash) or rootless (not starting with a slash). Implementations MUST support all three syntaxes.

Normally, the empty path "" and absolute path "/" are considered equal as defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically do this normalization because in contexts with a trimmed base path, e.g. the front controller, this difference becomes significant. It's the task of the user to handle both "" and "/".

The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.3.

As an example, if the value should include a slash ("/") not intended as delimiter between path segments, that value MUST be passed in encoded form (e.g., "%2F") to the instance.

See also: https://tools.ietf.org/html/rfc3986#section-2; https://tools.ietf.org/html/rfc3986#section-3.3

Returns: string The URI path.

Implements Psr\Http\Message\UriInterface.

Definition at line 428 of file Uri.php.

◆ getPort()

GuzzleHttp\Psr7\Uri::getPort ( )

Retrieve the port component of the URI.

If a port is present, and it is non-standard for the current scheme, this method MUST return it as an integer. If the port is the standard port used with the current scheme, this method SHOULD return null.

If no port is present, and no scheme is present, this method MUST return a null value.

If no port is present, but a scheme is present, this method MAY return the standard port for that scheme, but SHOULD return null.

Returns: null|int The URI port.

Implements Psr\Http\Message\UriInterface.

Definition at line 423 of file Uri.php.

◆ getQuery()

GuzzleHttp\Psr7\Uri::getQuery ( )

Retrieve the query string of the URI.

If no query string is present, this method MUST return an empty string.

The leading "?" character is not part of the query and MUST NOT be added.

The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.4.

As an example, if a value in a key/value pair of the query string should include an ampersand ("&") not intended as a delimiter between values, that value MUST be passed in encoded form (e.g., "%26") to the instance.

See also: https://tools.ietf.org/html/rfc3986#section-2; https://tools.ietf.org/html/rfc3986#section-3.4

Returns: string The URI query string.

Implements Psr\Http\Message\UriInterface.

Definition at line 433 of file Uri.php.

◆ getScheme()

GuzzleHttp\Psr7\Uri::getScheme ( )

Retrieve the scheme component of the URI.

If no scheme is present, this method MUST return an empty string.

The value returned MUST be normalized to lowercase, per RFC 3986 Section 3.1.

The trailing ":" character is not part of the scheme and MUST NOT be added.

See also: https://tools.ietf.org/html/rfc3986#section-3.1

Returns: string The URI scheme.

Implements Psr\Http\Message\UriInterface.

Definition at line 394 of file Uri.php.

◆ getUserInfo()

GuzzleHttp\Psr7\Uri::getUserInfo ( )

Retrieve the user information component of the URI.

If no user information is present, this method MUST return an empty string.

If a user is present in the URI, this will return that value; additionally, if the password is also present, it will be appended to the user value, with a colon (":") separating the values.

The trailing "@" character is not part of the user information and MUST NOT be added.

Returns: string The URI user information, in "username[:password]" format.

Implements Psr\Http\Message\UriInterface.

Definition at line 413 of file Uri.php.

◆ isAbsolute()

static GuzzleHttp\Psr7\Uri::isAbsolute ( UriInterface $uri )

static

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'

Parameters

UriInterface $uri

Returns: bool

See also: Uri::isNetworkPathReference; Uri::isAbsolutePathReference; Uri::isRelativePathReference https://tools.ietf.org/html/rfc3986#section-4

Definition at line 195 of file Uri.php.

References Psr\Http\Message\UriInterface\getScheme().

◆ isAbsolutePathReference()

static GuzzleHttp\Psr7\Uri::isAbsolutePathReference ( UriInterface $uri )

static

Whether the URI is a absolute-path reference.

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

Parameters

UriInterface $uri

Returns: bool https://tools.ietf.org/html/rfc3986#section-4.2

Definition at line 225 of file Uri.php.

References Psr\Http\Message\UriInterface\getAuthority(), Psr\Http\Message\UriInterface\getPath(), and Psr\Http\Message\UriInterface\getScheme().

◆ isDefaultPort()

static GuzzleHttp\Psr7\Uri::isDefaultPort ( UriInterface $uri )

static

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.

Parameters

UriInterface $uri

Returns: bool

Definition at line 171 of file Uri.php.

References Psr\Http\Message\UriInterface\getPort(), and Psr\Http\Message\UriInterface\getScheme().

Referenced by GuzzleHttp\Psr7\UriNormalizer\normalize().

◆ isNetworkPathReference()

static GuzzleHttp\Psr7\Uri::isNetworkPathReference ( UriInterface $uri )

static

Whether the URI is a network-path reference.

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

Parameters

UriInterface $uri

Returns: bool https://tools.ietf.org/html/rfc3986#section-4.2

Definition at line 210 of file Uri.php.

References Psr\Http\Message\UriInterface\getAuthority(), and Psr\Http\Message\UriInterface\getScheme().

◆ isRelativePathReference()

static GuzzleHttp\Psr7\Uri::isRelativePathReference ( UriInterface $uri )

static

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.

Parameters

UriInterface $uri

Returns: bool https://tools.ietf.org/html/rfc3986#section-4.2

Definition at line 243 of file Uri.php.

References Psr\Http\Message\UriInterface\getAuthority(), Psr\Http\Message\UriInterface\getPath(), and Psr\Http\Message\UriInterface\getScheme().

Referenced by GuzzleHttp\Psr7\UriNormalizer\normalize(), and GuzzleHttp\Psr7\UriResolver\relativize().

◆ isSameDocumentReference()

static GuzzleHttp\Psr7\Uri::isSameDocumentReference	(	UriInterface	$uri,
		UriInterface	$base = `null`
	)

static

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.

Parameters

UriInterface	$uri	The URI to check
UriInterface \| null	$base	An optional base URI to compare against

Returns: bool https://tools.ietf.org/html/rfc3986#section-4.4

Definition at line 263 of file Uri.php.

References Psr\Http\Message\UriInterface\getAuthority(), Psr\Http\Message\UriInterface\getPath(), Psr\Http\Message\UriInterface\getQuery(), Psr\Http\Message\UriInterface\getScheme(), and GuzzleHttp\Psr7\UriResolver\resolve().

◆ removeDotSegments()

static GuzzleHttp\Psr7\Uri::removeDotSegments ( $path )

static

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

Parameters

string $path

Returns: string

Deprecated:: since version 1.4. Use UriResolver::removeDotSegments instead.

See also: UriResolver::removeDotSegments

Definition at line 287 of file Uri.php.

References GuzzleHttp\Psr7\UriResolver\removeDotSegments().

◆ resolve()

static GuzzleHttp\Psr7\Uri::resolve	(	UriInterface	$base,
			$rel
	)

static

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

Parameters

UriInterface	$base	Base URI
string \| UriInterface	$rel	Relative URI

Returns: UriInterface

Deprecated:: since version 1.4. Use UriResolver::resolve instead.

See also: UriResolver::resolve

Definition at line 303 of file Uri.php.

References GuzzleHttp\Psr7\UriResolver\resolve().

◆ withFragment()

GuzzleHttp\Psr7\Uri::withFragment ( $fragment )

Return an instance with the specified URI fragment.

This method MUST retain the state of the current instance, and return an instance that contains the specified URI fragment.

Users can provide both encoded and decoded fragment characters. Implementations ensure the correct encoding as outlined in getFragment().

An empty fragment value is equivalent to removing the fragment.

Parameters

string $fragment The fragment to use with the new instance.

Returns: static A new instance with the specified fragment.

Implements Psr\Http\Message\UriInterface.

Definition at line 537 of file Uri.php.

◆ withHost()

GuzzleHttp\Psr7\Uri::withHost ( $host )

Return an instance with the specified host.

This method MUST retain the state of the current instance, and return an instance that contains the specified host.

An empty host value is equivalent to removing the host.

Parameters

string $host The hostname to use with the new instance.

Returns: static A new instance with the specified host.

Exceptions

Implements Psr\Http\Message\UriInterface.

Definition at line 477 of file Uri.php.

◆ withoutQueryValue()

static GuzzleHttp\Psr7\Uri::withoutQueryValue	(	UriInterface	$uri,
			$key
	)

static

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

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

Parameters

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

Returns: UriInterface

Definition at line 323 of file Uri.php.

References Psr\Http\Message\UriInterface\withQuery().

◆ withPath()

GuzzleHttp\Psr7\Uri::withPath ( $path )

Return an instance with the specified path.

This method MUST retain the state of the current instance, and return an instance that contains the specified path.

The path can either be empty or absolute (starting with a slash) or rootless (not starting with a slash). Implementations MUST support all three syntaxes.

If the path is intended to be domain-relative rather than path relative then it must begin with a slash ("/"). Paths not starting with a slash ("/") are assumed to be relative to some base path known to the application or consumer.

Users can provide both encoded and decoded path characters. Implementations ensure the correct encoding as outlined in getPath().

Parameters

string $path The path to use with the new instance.

Returns: static A new instance with the specified path.

Exceptions

Implements Psr\Http\Message\UriInterface.

Definition at line 508 of file Uri.php.

◆ withPort()

GuzzleHttp\Psr7\Uri::withPort ( $port )

Return an instance with the specified port.

This method MUST retain the state of the current instance, and return an instance that contains the specified port.

Implementations MUST raise an exception for ports outside the established TCP and UDP port ranges.

A null value provided for the port is equivalent to removing the port information.

Parameters

null | int $port The port to use with the new instance; a null value removes the port information.

Returns: static A new instance with the specified port.

Exceptions

Implements Psr\Http\Message\UriInterface.

Definition at line 492 of file Uri.php.

◆ withQuery()

GuzzleHttp\Psr7\Uri::withQuery ( $query )

Return an instance with the specified query string.

This method MUST retain the state of the current instance, and return an instance that contains the specified query string.

Users can provide both encoded and decoded query characters. Implementations ensure the correct encoding as outlined in getQuery().

An empty query string value is equivalent to removing the query string.

Parameters

string $query The query string to use with the new instance.

Returns: static A new instance with the specified query string.

Exceptions

Implements Psr\Http\Message\UriInterface.

Definition at line 523 of file Uri.php.

◆ withQueryValue()

static GuzzleHttp\Psr7\Uri::withQueryValue	(	UriInterface	$uri,
			$key,
			$value
	)

static

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".

Parameters

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

Returns: UriInterface

Definition at line 345 of file Uri.php.

References Psr\Http\Message\UriInterface\withQuery().

◆ withQueryValues()

static GuzzleHttp\Psr7\Uri::withQueryValues	(	UriInterface	$uri,
		array	$keyValueArray
	)

static

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.

Parameters

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

Returns: UriInterface

Definition at line 364 of file Uri.php.

References Psr\Http\Message\UriInterface\withQuery().

◆ withScheme()

GuzzleHttp\Psr7\Uri::withScheme ( $scheme )

Return an instance with the specified scheme.

This method MUST retain the state of the current instance, and return an instance that contains the specified scheme.

Implementations MUST support the schemes "http" and "https" case insensitively, and MAY accommodate other schemes if required.

An empty scheme is equivalent to removing the scheme.

Parameters

string $scheme The scheme to use with the new instance.

Returns: static A new instance with the specified scheme.

Exceptions

Implements Psr\Http\Message\UriInterface.

Definition at line 443 of file Uri.php.

◆ withUserInfo()

GuzzleHttp\Psr7\Uri::withUserInfo	(	$user,
		$password = `null`
	)

Return an instance with the specified user information.

This method MUST retain the state of the current instance, and return an instance that contains the specified user information.

Password is optional, but the user information MUST include the user; an empty string for the user is equivalent to removing user information.

Parameters

string	$user	The user name to use for authority.
null \| string	$password	The password associated with $user.

Returns: static A new instance with the specified user information.

Implements Psr\Http\Message\UriInterface.

Definition at line 459 of file Uri.php.

Field Documentation

◆ HTTP_DEFAULT_HOST

const GuzzleHttp\Psr7\Uri::HTTP_DEFAULT_HOST = 'localhost'

Absolute http and https URIs require a host per RFC 7230 Section 2.7 but in generic URIs the host can be empty. So for http(s) URIs we apply this default host when no host is given yet to form a valid URI.

Definition at line 21 of file Uri.php.

The documentation for this class was generated from the following file:

Uri.php

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ composeComponents()

◆ fromParts()

◆ getAuthority()

◆ getFragment()

◆ getHost()

◆ getPath()

◆ getPort()

◆ getQuery()

◆ getScheme()

◆ getUserInfo()

◆ isAbsolute()

◆ isAbsolutePathReference()

◆ isDefaultPort()

◆ isNetworkPathReference()

◆ isRelativePathReference()

◆ isSameDocumentReference()

◆ removeDotSegments()

◆ resolve()

◆ withFragment()

◆ withHost()

◆ withoutQueryValue()

◆ withPath()

◆ withPort()

◆ withQuery()

◆ withQueryValue()

◆ withQueryValues()

◆ withScheme()

◆ withUserInfo()

Field Documentation

◆ HTTP_DEFAULT_HOST