GuzzleHttp\Psr7\UriNormalizer Class Reference

Static Public Member Functions
static	isEquivalent (UriInterface $uri1, UriInterface $uri2, $normalizations=self::PRESERVING_NORMALIZATIONS)
static	normalize (UriInterface $uri, $flags=self::PRESERVING_NORMALIZATIONS)

Data Fields
const	CAPITALIZE_PERCENT_ENCODING = 1
const	CONVERT_EMPTY_PATH = 4
const	DECODE_UNRESERVED_CHARACTERS = 2
const	PRESERVING_NORMALIZATIONS = 63
const	REMOVE_DEFAULT_HOST = 8
const	REMOVE_DEFAULT_PORT = 16
const	REMOVE_DOT_SEGMENTS = 32
const	REMOVE_DUPLICATE_SLASHES = 64
const	SORT_QUERY_PARAMETERS = 128

Detailed Description

Provides methods to normalize and compare URIs.

Author

Tobias Schultze

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

Definition at line 13 of file UriNormalizer.php.

Member Function Documentation

isEquivalent()

static GuzzleHttp\Psr7\UriNormalizer::isEquivalent ( UriInterface  $uri1, UriInterface  $uri2,   $normalizations = self::PRESERVING_NORMALIZATIONS  )

static

Whether two URIs can be considered equivalent.

Both URIs are normalized automatically before comparison with the given $normalizations bitmask. The method also accepts relative URI references and returns true when they are equivalent. This of course assumes they will be resolved against the same base URI. If this is not the case, determination of equivalence or difference of relative references does not mean anything.

Parameters

UriInterface	$uri1	An URI to compare
UriInterface	$uri2	An URI to compare
int	$normalizations	A bitmask of normalizations to apply, see constants

Returns

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

Definition at line 175 of file UriNormalizer.php.

References GuzzleHttp\Psr7\UriNormalizer\normalize().

normalize()

static GuzzleHttp\Psr7\UriNormalizer::normalize ( UriInterface  $uri,   $flags = self::PRESERVING_NORMALIZATIONS  )

static

Returns a normalized URI.

The scheme and host component are already normalized to lowercase per PSR-7 UriInterface. This methods adds additional normalizations that can be configured with the $flags parameter.

PSR-7 UriInterface cannot distinguish between an empty component and a missing component as getQuery(), getFragment() etc. always return a string. This means the URIs "/?#" and "/" are treated equivalent which is not necessarily true according to RFC 3986. But that difference is highly uncommon in reality. So this potential normalization is implied in PSR-7 as well.

Parameters

UriInterface	$uri	The URI to normalize
int	$flags	A bitmask of normalizations to apply, see constants

Returns

UriInterface The normalized URI https://tools.ietf.org/html/rfc3986#section-6.2

Definition at line 119 of file UriNormalizer.php.

References Psr\Http\Message\UriInterface\getHost(), Psr\Http\Message\UriInterface\getPath(), Psr\Http\Message\UriInterface\getPort(), Psr\Http\Message\UriInterface\getQuery(), Psr\Http\Message\UriInterface\getScheme(), GuzzleHttp\Psr7\Uri\isDefaultPort(), GuzzleHttp\Psr7\Uri\isRelativePathReference(), GuzzleHttp\Psr7\UriResolver\removeDotSegments(), Psr\Http\Message\UriInterface\withHost(), Psr\Http\Message\UriInterface\withPath(), Psr\Http\Message\UriInterface\withPort(), and Psr\Http\Message\UriInterface\withQuery().

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

Field Documentation

CAPITALIZE_PERCENT_ENCODING

const GuzzleHttp\Psr7\UriNormalizer::CAPITALIZE_PERCENT_ENCODING = 1

All letters within a percent-encoding triplet (e.g., "%3A") are case-insensitive, and should be capitalized.

Example: http://example.org/a%c2%b1b → http://example.org/a%C2%B1b

Definition at line 28 of file UriNormalizer.php.

CONVERT_EMPTY_PATH

const GuzzleHttp\Psr7\UriNormalizer::CONVERT_EMPTY_PATH = 4

Converts the empty path to "/" for http and https URIs.

Example: http://example.org → http://example.org/

Definition at line 46 of file UriNormalizer.php.

DECODE_UNRESERVED_CHARACTERS

const GuzzleHttp\Psr7\UriNormalizer::DECODE_UNRESERVED_CHARACTERS = 2

Decodes percent-encoded octets of unreserved characters.

For consistency, percent-encoded octets in the ranges of ALPHA (%41–%5A and %61–%7A), DIGIT (%30–%39), hyphen (%2D), period (%2E), underscore (%5F), or tilde (%7E) should not be created by URI producers and, when found in a URI, should be decoded to their corresponding unreserved characters by URI normalizers.

Example: http://example.org/%7Eusern%61me/ → http://example.org/~username/

Definition at line 39 of file UriNormalizer.php.

PRESERVING_NORMALIZATIONS

const GuzzleHttp\Psr7\UriNormalizer::PRESERVING_NORMALIZATIONS = 63

Default normalizations which only include the ones that preserve semantics.

self::CAPITALIZE_PERCENT_ENCODING | self::DECODE_UNRESERVED_CHARACTERS | self::CONVERT_EMPTY_PATH | self::REMOVE_DEFAULT_HOST | self::REMOVE_DEFAULT_PORT | self::REMOVE_DOT_SEGMENTS

Definition at line 21 of file UriNormalizer.php.

REMOVE_DEFAULT_HOST

const GuzzleHttp\Psr7\UriNormalizer::REMOVE_DEFAULT_HOST = 8

Removes the default host of the given URI scheme from the URI.

Only the "file" scheme defines the default host "localhost". All of file:/myfile, file:///myfile, and file://localhost/myfile are equivalent according to RFC 3986. The first format is not accepted by PHPs stream functions and thus already normalized implicitly to the second format in the Uri class. See GuzzleHttp\Psr7\Uri::composeComponents.

Example: file://localhost/myfile → file:///myfile

Definition at line 59 of file UriNormalizer.php.

REMOVE_DEFAULT_PORT

const GuzzleHttp\Psr7\UriNormalizer::REMOVE_DEFAULT_PORT = 16

Removes the default port of the given URI scheme from the URI.

Example: http://example.org:80/ → http://example.org/

Definition at line 66 of file UriNormalizer.php.

REMOVE_DOT_SEGMENTS

const GuzzleHttp\Psr7\UriNormalizer::REMOVE_DOT_SEGMENTS = 32

Removes unnecessary dot-segments.

Dot-segments in relative-path references are not removed as it would change the semantics of the URI reference.

Example: http://example.org/../a/b/../c/./d.html → http://example.org/a/c/d.html

Definition at line 76 of file UriNormalizer.php.

REMOVE_DUPLICATE_SLASHES

const GuzzleHttp\Psr7\UriNormalizer::REMOVE_DUPLICATE_SLASHES = 64

Paths which include two or more adjacent slashes are converted to one.

Webservers usually ignore duplicate slashes and treat those URIs equivalent. But in theory those URIs do not need to be equivalent. So this normalization may change the semantics. Encoded slashes (%2F) are not removed.

Example: http://example.org//foo///bar.html → http://example.org/foo/bar.html

Definition at line 87 of file UriNormalizer.php.

SORT_QUERY_PARAMETERS

const GuzzleHttp\Psr7\UriNormalizer::SORT_QUERY_PARAMETERS = 128

Sort query parameters with their values in alphabetical order.

However, the order of parameters in a URI may be significant (this is not defined by the standard). So this normalization is not safe and may change the semantics of the URI.

Example: ?lang=en&article=fred → ?article=fred&lang=en

Note: The sorting is neither locale nor Unicode aware (the URI query does not get decoded at all) as the purpose is to be able to compare URIs in a reproducible way, not to have the params sorted perfectly.

Definition at line 100 of file UriNormalizer.php.

---

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

• UriNormalizer.php