Documentation

Uri
in package
implements UriInterface

PSR-7 URI implementation.

Tags
author

Michael Dowling

author

Tobias Schultze

author

Matthew Weier O'Phinney

author

Tobias Nyholm tobias.nyholm@gmail.com

author

Martijn van der Ven martijn@vanderven.se

final

This class should never be extended. See https://github.com/Nyholm/psr7/blob/master/doc/final.md

Table of Contents

Interfaces

UriInterface
Value object representing a URI.

Constants

CHAR_GEN_DELIMS  = ':\/\?#\[\]@'
CHAR_SUB_DELIMS  = '!\$&\'\(\)\*\+,;='
CHAR_UNRESERVED  = 'a-zA-Z0-9_\-\.~'
SCHEMES  = ['http' => 80, 'https' => 443]

Properties

$fragment  : string
$host  : string
$path  : string
$port  : int|null
$query  : string
$scheme  : string
$userInfo  : string

Methods

__construct()  : mixed
__toString()  : string
Return the string representation as a URI reference.
getAuthority()  : string
Retrieve the authority component of the URI.
getFragment()  : string
Retrieve the fragment component of the URI.
getHost()  : string
Retrieve the host component of the URI.
getPath()  : string
Retrieve the path component of the URI.
getPort()  : null|int
Retrieve the port component of the URI.
getQuery()  : string
Retrieve the query string of the URI.
getScheme()  : string
Retrieve the scheme component of the URI.
getUserInfo()  : string
Retrieve the user information component of the URI.
withFragment()  : static
Return an instance with the specified URI fragment.
withHost()  : static
Return an instance with the specified host.
withPath()  : static
Return an instance with the specified path.
withPort()  : static
Return an instance with the specified port.
withQuery()  : static
Return an instance with the specified query string.
withScheme()  : static
Return an instance with the specified scheme.
withUserInfo()  : static
Return an instance with the specified user information.
createUriString()  : string
Create a URI string from its various parts.
filterPath()  : string
filterPort()  : int|null
filterQueryAndFragment()  : string
isNonStandardPort()  : bool
Is a given port non-standard for the current scheme?
rawurlencodeMatchZero()  : string

Constants

CHAR_GEN_DELIMS

private mixed CHAR_GEN_DELIMS = ':\/\?#\[\]@'

CHAR_SUB_DELIMS

private mixed CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;='

CHAR_UNRESERVED

private mixed CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~'

SCHEMES

private mixed SCHEMES = ['http' => 80, 'https' => 443]

Properties

$fragment

private string $fragment = ''

Uri fragment.

$host

private string $host = ''

Uri host.

$path

private string $path = ''

Uri path.

$port

private int|null $port

Uri port.

$query

private string $query = ''

Uri query string.

$scheme

private string $scheme = ''

Uri scheme.

$userInfo

private string $userInfo = ''

Uri user info.

Methods

__construct()

public __construct([string $uri = '' ]) : mixed
Parameters
$uri : string = ''

__toString()

Return the string representation as a URI reference.

public __toString() : string

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 "#".
Return values
string

getAuthority()

Retrieve the authority component of the URI.

public getAuthority() : string

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.

Return values
string —

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

getFragment()

Retrieve the fragment component of the URI.

public getFragment() : string

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.

Return values
string —

The URI fragment.

getHost()

Retrieve the host component of the URI.

public getHost() : string

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.

Return values
string —

The URI host.

getPath()

Retrieve the path component of the URI.

public getPath() : string

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 values
string —

The URI path.

getPort()

Retrieve the port component of the URI.

public getPort() : null|int

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.

Return values
null|int —

The URI port.

getQuery()

Retrieve the query string of the URI.

public getQuery() : string

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.

Return values
string —

The URI query string.

getScheme()

Retrieve the scheme component of the URI.

public getScheme() : string

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.

Return values
string —

The URI scheme.

getUserInfo()

Retrieve the user information component of the URI.

public getUserInfo() : string

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.

Return values
string —

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

withFragment()

Return an instance with the specified URI fragment.

public withFragment(mixed $fragment) : static
Parameters
$fragment : mixed

The fragment to use with the new instance.

Return values
static

withHost()

Return an instance with the specified host.

public withHost(mixed $host) : static
Parameters
$host : mixed

The hostname to use with the new instance.

Return values
static

withPath()

Return an instance with the specified path.

public withPath(mixed $path) : static
Parameters
$path : mixed

The path to use with the new instance.

Return values
static

withPort()

Return an instance with the specified port.

public withPort(mixed $port) : static
Parameters
$port : mixed

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

Return values
static

withQuery()

Return an instance with the specified query string.

public withQuery(mixed $query) : static
Parameters
$query : mixed

The query string to use with the new instance.

Return values
static

withScheme()

Return an instance with the specified scheme.

public withScheme(mixed $scheme) : static
Parameters
$scheme : mixed

The scheme to use with the new instance.

Return values
static

withUserInfo()

Return an instance with the specified user information.

public withUserInfo(mixed $user[, mixed $password = null ]) : static
Parameters
$user : mixed

The user name to use for authority.

$password : mixed = null

The password associated with $user.

Return values
static

createUriString()

Create a URI string from its various parts.

private static createUriString(string $scheme, string $authority, string $path, string $query, string $fragment) : string
Parameters
$scheme : string
$authority : string
$path : string
$query : string
$fragment : string
Return values
string

filterPath()

private filterPath(mixed $path) : string
Parameters
$path : mixed
Return values
string

filterPort()

private filterPort(mixed $port) : int|null
Parameters
$port : mixed
Return values
int|null

filterQueryAndFragment()

private filterQueryAndFragment(mixed $str) : string
Parameters
$str : mixed
Return values
string

isNonStandardPort()

Is a given port non-standard for the current scheme?

private static isNonStandardPort(string $scheme, int $port) : bool
Parameters
$scheme : string
$port : int
Return values
bool

rawurlencodeMatchZero()

private static rawurlencodeMatchZero(array<string|int, mixed> $match) : string
Parameters
$match : array<string|int, mixed>
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results