Generic URI handler

 Methods

Create a new URI object

__construct(\Zend\Uri\Uri | string | null $uri) 

Parameters

$uri

\Zend\Uri\Uristringnull

Exceptions

\Zend\Uri\Exception\InvalidArgumentException

Magic method to convert the URI to a string

__toString() : string

Returns

string

Encode the path

encodePath(string $path) : string

Will replace all characters which are not strictly allowed in the path part with percent-encoded representation

Parameters

$path

string

Exceptions

\Zend\Uri\Exception\InvalidArgumentException

Returns

string

URL-encode a query string or fragment based on RFC-3986 guidelines.

encodeQueryFragment(string $input) : string

Note that query and fragment encoding allows more unencoded characters than the usual rawurlencode() function would usually return - for example '/' and ':' are allowed as literals.

Parameters

$input

string

Exceptions

\Zend\Uri\Exception\InvalidArgumentException

Returns

string

URL-encode the user info part of a URI

encodeUserInfo(string $userInfo) : string

Parameters

$userInfo

string

Exceptions

\Zend\Uri\Exception\InvalidArgumentException

Returns

string

Retrieve Escaper instance

getEscaper() : \Zend\Escaper\Escaper

Lazy-loads one if none provided

Returns

Get the URI fragment

getFragment() : string | null

Returns

stringnull

Get the URI host

getHost() : string | null

Returns

stringnull

Get the URI path

getPath() : string | null

Returns

stringnull

Get the URI port

getPort() : integer | null

Returns

integernull

Get the URI query

getQuery() : string | null

Returns

stringnull

Return the query string as an associative array of key => value pairs

getQueryAsArray() : array

This is an extension to RFC-3986 but is quite useful when working with most common URI types

Returns

array

Get the scheme part of the URI

getScheme() : string | null

Returns

stringnull

Get the User-info (usually user:password) part

getUserInfo() : string | null

Returns

stringnull

Check if the URI is an absolute or relative URI

isAbsolute() : bool

Returns

bool

Check if the URI is valid

isValid() : bool

Note that a relative URI may still be valid

Returns

bool

Check if the URI is a valid relative URI

isValidRelative() : bool

Returns

bool

Convert the link to a relative link by substracting a base URI

makeRelative(\Zend\Uri\Uri | string $baseUri) : \Zend\Uri\Uri

This is the opposite of resolving a relative link - i.e. creating a relative reference link from an original URI and a base URI.

If the two URIs do not intersect (e.g. the original URI is not in any way related to the base URI) the URI will not be modified.

Parameters

$baseUri

\Zend\Uri\Uristring

Returns

Merge a base URI and a relative URI into a new URI object

merge(\Zend\Uri\Uri | string $baseUri, \Zend\Uri\Uri | string $relativeUri) : \Zend\Uri\Uri

This convenience method wraps ::resolve() to allow users to quickly create new absolute URLs without the need to instantiate and clone URI objects.

If objects are passed in, none of the passed objects will be modified.

Parameters

$baseUri

\Zend\Uri\Uristring

$relativeUri

\Zend\Uri\Uristring

Returns

Normalize the URI

normalize() : \Zend\Uri\Uri

Normalizing a URI includes removing any redundant parent directory or current directory references from the path (e.g. foo/bar/../baz becomes foo/baz), normalizing the scheme case, decoding any over-encoded characters etc.

Eventually, two normalized URLs pointing to the same resource should be equal even if they were originally represented by two different strings

Returns

Parse a URI string

parse(string $uri) : \Zend\Uri\Uri

Parameters

$uri

string

Returns

Extract only the scheme part out of a URI string.

parseScheme(string $uriString) : string | null

This is used by the parse() method, but is useful as a standalone public method if one wants to test a URI string for it's scheme before doing anything with it.

Will return the scheme if found, or NULL if no scheme found (URI may still be valid, but not full)

Parameters

$uriString

string

Exceptions

\Zend\Uri\Exception\InvalidArgumentException

Returns

stringnull

Remove any extra dot segments (/.

removePathDotSegments(string $path) : string

./, /./) from a path

Algorithm is adapted from RFC-3986 section 5.2.4 (@link http://tools.ietf.org/html/rfc3986#section-5.2.4)

todo consider optimizing

Parameters

$path

string

Returns

string

Convert a relative URI into an absolute URI using a base absolute URI as a reference.

resolve(\Zend\Uri\Uri | string $baseUri) : \Zend\Uri\Uri

This is similar to merge() - only it uses the supplied URI as the base reference instead of using the current URI as the base reference.

Merging algorithm is adapted from RFC-3986 section 5.2 (@link http://tools.ietf.org/html/rfc3986#section-5.2)

Parameters

$baseUri

\Zend\Uri\Uristring

Exceptions

\Zend\Uri\Exception\InvalidArgumentException

Returns

Set Escaper instance

setEscaper(\Zend\Escaper\Escaper $escaper) 

Parameters

Set the URI fragment part

setFragment(string $fragment) : \Zend\Uri\Uri

Parameters

$fragment

string

Exceptions

\Zend\Uri\Exception\InvalidUriPartException If the schema definition does not have this part

Returns

Set the URI host

setHost(string $host) : \Zend\Uri\Uri

Note that the generic syntax for URIs allows using host names which are not necessarily IPv4 addresses or valid DNS host names. For example, IPv6 addresses are allowed as well, and also an abstract "registered name" which may be any name composed of a valid set of characters, including, for example, tilda (~) and underscore (_) which are not allowed in DNS names.

Subclasses of Uri may impose more strict validation of host names - for example the HTTP RFC clearly states that only IPv4 and valid DNS names are allowed in HTTP URIs.

Parameters

$host

string

Exceptions

\Zend\Uri\Exception\InvalidUriPartException

Returns

Set the path

setPath(string $path) : \Zend\Uri\Uri

Parameters

$path

string

Returns

Set the port part of the URI

setPort(integer $port) : \Zend\Uri\Uri

Parameters

$port

integer

Returns

Set the query string

setQuery(string | array $query) : \Zend\Uri\Uri

If an array is provided, will encode this array of parameters into a query string. Array values will be represented in the query string using PHP's common square bracket notation.

Parameters

$query

stringarray

Returns

Set the URI scheme

setScheme(string $scheme) : \Zend\Uri\Uri

If the scheme is not valid according to the generic scheme syntax or is not acceptable by the specific URI class (e.g. 'http' or 'https' are the only acceptable schemes for the Zend\Uri\Http class) an exception will be thrown.

You can check if a scheme is valid before setting it using the validateScheme() method.

Parameters

$scheme

string

Exceptions

\Zend\Uri\Exception\InvalidUriPartException

Returns

Set the URI User-info part (usually user:password)

setUserInfo(string $userInfo) : \Zend\Uri\Uri

Parameters

$userInfo

string

Exceptions

\Zend\Uri\Exception\InvalidUriPartException If the schema definition does not have this part

Returns

Compose the URI into a string

toString() : string

Exceptions

\Zend\Uri\Exception\InvalidUriException

Returns

string

Validate the host part

validateHost(string $host, integer $allowed) : bool

Users may control which host types to allow by passing a second parameter with a bitmask of HOST_* constants which are allowed. If not specified, all address types will be allowed.

Note that the generic URI syntax allows different host representations, including IPv4 addresses, IPv6 addresses and future IP address formats enclosed in square brackets, and registered names which may be DNS names or even more complex names. This is different (and is much more loose) from what is commonly accepted as valid HTTP URLs for example.

Parameters

$host

string

$allowed

integer

bitmask of allowed host types

Returns

bool

Validate the path

validatePath(string $path) : bool

Parameters

$path

string

Returns

bool

Validate the port

validatePort(integer $port) : bool

Valid values include numbers between 1 and 65535, and empty values

Parameters

$port

integer

Returns

bool

Check if a URI query or fragment part is valid or not

validateQueryFragment(string $input) : bool

Query and Fragment parts are both restricted by the same syntax rules, so the same validation method can be used for both.

You can encode a query or fragment part to ensure it is valid by passing it through the encodeQueryFragment() method.

Parameters

$input

string

Returns

bool

Check if a scheme is valid or not

validateScheme(string $scheme) : bool

Will check $scheme to be valid against the generic scheme syntax defined in RFC-3986. If the class also defines specific acceptable schemes, will also check that $scheme is one of them.

Parameters

$scheme

string

Returns

bool

Check that the userInfo part of a URI is valid

validateUserInfo(string $userInfo) : bool

Parameters

$userInfo

string

Returns

bool

Decode all percent encoded characters which are allowed to be represented literally

decodeUrlEncodedChars(string $input, string $allowed) : mixed

Will not decode any characters which are not listed in the 'allowed' list

Parameters

$input

string

$allowed

string

Pattern of allowed characters

Returns

mixed

Check if an address is a valid DNS hostname

isValidDnsHostname(string $host) : bool

Parameters

$host

string

Returns

bool

Check if a host name is a valid IP address, depending on allowed IP address types

isValidIpAddress(string $host, integer $allowed) : bool

Parameters

$host

string

$allowed

integer

allowed address types

Returns

bool

Check if an address is a valid registered name (as defined by RFC-3986) address

isValidRegName(string $host) : bool

Parameters

$host

string

Returns

bool

Normalize the fragment part

normalizeFragment(string $fragment) : string

Currently this is exactly the same as normalizeQuery().

Parameters

$fragment

string

Returns

string

Normalize the host part

normalizeHost(string $host) : string

By default this converts host names to lower case

Parameters

$host

string

Returns

string

Normalize the path

normalizePath(string $path) : string

This involves removing redundant dot segments, decoding any over-encoded characters and encoding everything that needs to be encoded and is not

Parameters

$path

string

Returns

string

Normalize the port

normalizePort(integer $port, string $scheme) : integer | null

If the class defines a default port for the current scheme, and the current port is default, it will be unset.

Parameters

$port

integer

$scheme

string

Returns

integernull

Normalize the query part

normalizeQuery(string $query) : string

This involves decoding everything that doesn't need to be encoded, and encoding everything else

Parameters

$query

string

Returns

string

Normalize the scheme

normalizeScheme(string $scheme) : string

Usually this means simply converting the scheme to lower case

Parameters

$scheme

string

Returns

string

 Properties

 

List of default ports per scheme

$defaultPorts : array

Inheriting URI classes may set this, and the normalization methods will automatically remove the port if it is equal to the default port for the current scheme

 

$escaper

$escaper : \Zend\Escaper\Escaper

 

URI fragment

$fragment : string

 

URI hostname

$host : string

 

URI path

$path : string

 

URI port

$port : integer

 

URI query string

$query : string

 

URI scheme

$scheme : string

 

URI userInfo part (usually user:password in HTTP URLs)

$userInfo : string

 

Which host part types are valid for this URI?

$validHostTypes : integer

 

Array of valid schemes.

$validSchemes : array

Subclasses of this class that only accept specific schemes may set the list of accepted schemes here. If not empty, when setScheme() is called it will only accept the schemes listed here.

 Constants

 

CHAR_GEN_DELIMS

CHAR_GEN_DELIMS 

 

CHAR_RESERVED

CHAR_RESERVED 

 

CHAR_SUB_DELIMS

CHAR_SUB_DELIMS 

 

Character classes defined in RFC-3986

CHAR_UNRESERVED 

 

HOST_ALL

HOST_ALL 

 

HOST_DNS

HOST_DNS 

 

HOST_DNS_OR_IPV4

HOST_DNS_OR_IPV4 

 

HOST_DNS_OR_IPV4_OR_IPV6

HOST_DNS_OR_IPV4_OR_IPV6 

 

HOST_DNS_OR_IPV4_OR_IPV6_OR_REGNAME

HOST_DNS_OR_IPV4_OR_IPV6_OR_REGNAME 

 

HOST_DNS_OR_IPV6

HOST_DNS_OR_IPV6 

 

HOST_DNS_OR_IPVANY

HOST_DNS_OR_IPVANY 

 

Host part types represented as binary masks The binary mask consists of 5 bits in the following order: <RegName> | <DNS> | <IPvFuture> | <IPv6> | <IPv4> Place 1 or 0 in the different positions for enable or disable the part.

HOST_IPV4 

Finally use a hexadecimal representation.

 

HOST_IPV6

HOST_IPV6 

 

HOST_IPVANY

HOST_IPVANY 

 

HOST_IPVFUTURE

HOST_IPVFUTURE 

 

HOST_REGNAME

HOST_REGNAME