You are here

public function UriInterface::getPath in Auth0 Single Sign On 8.2

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.

Return value

string The URI path.

See also

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

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

1 method overrides UriInterface::getPath()
Uri::getPath in vendor/guzzlehttp/psr7/src/Uri.php
Retrieve the path component of the URI.

File

vendor/psr/http-message/src/UriInterface.php, line 134

Class

UriInterface
Value object representing a URI.

Namespace

Psr\Http\Message

Code

public function getPath();