Value object representing a URI. More...

Inheritance diagram for Slim\Http\Uri:

Collaboration diagram for Slim\Http\Uri:

Public Member Functions
	__construct ( $scheme, $host, $port=null, $path='/', $query='', $fragment='', $user='', $password='')
	Create new Uri. More...

	getScheme ()
	Retrieve the scheme component of the URI. More...

	withScheme ($scheme)
	Return an instance with the specified scheme. More...

	getAuthority ()
	Retrieve the authority component of the URI. More...

	getUserInfo ()
	Retrieve the user information component of the URI. More...

	withUserInfo ($user, $password=null)
	Return an instance with the specified user information. More...

	getHost ()
	Retrieve the host component of the URI. More...

	withHost ($host)
	Return an instance with the specified host. More...

	getPort ()
	Retrieve the port component of the URI. More...

	withPort ($port)
	Return an instance with the specified port. More...

	getPath ()
	Retrieve the path component of the URI. More...

	withPath ($path)
	Return an instance with the specified path. More...

	getBasePath ()
	Retrieve the base path segment of the URI. More...

	withBasePath ($basePath)
	Set base path. More...

	getQuery ()
	Retrieve the query string of the URI. More...

	withQuery ($query)
	Return an instance with the specified query string. More...

	getFragment ()
	Retrieve the fragment component of the URI. More...

	withFragment ($fragment)
	Return an instance with the specified URI fragment. More...

	__toString ()
	Return the string representation as a URI reference. More...

	getBaseUrl ()
	Return the fully qualified base URL. More...

	getScheme ()
	Retrieve the scheme component of the URI. More...

	getAuthority ()
	Retrieve the authority component of the URI. More...

	getUserInfo ()
	Retrieve the user information component of the URI. More...

	getHost ()
	Retrieve the host component of the URI. More...

	getPort ()
	Retrieve the port component of the URI. More...

	getPath ()
	Retrieve the path component of the URI. More...

	getQuery ()
	Retrieve the query string of the URI. More...

	getFragment ()
	Retrieve the fragment component of the URI. More...

	withScheme ($scheme)
	Return an instance with the specified scheme. More...

	withUserInfo ($user, $password=null)
	Return an instance with the specified user information. More...

	withHost ($host)
	Return an instance with the specified host. More...

	withPort ($port)
	Return an instance with the specified port. More...

	withPath ($path)
	Return an instance with the specified path. More...

	withQuery ($query)
	Return an instance with the specified query string. More...

	withFragment ($fragment)
	Return an instance with the specified URI fragment. More...

	__toString ()
	Return the string representation as a URI reference. More...

Static Public Member Functions
static	createFromString ($uri)
	Create new Uri from string. More...

static	createFromEnvironment (Environment $env)
	Create new Uri from environment. More...

Protected Member Functions
	filterScheme ($scheme)
	Filter Uri scheme. More...

	filterUserInfo ($query)
	Filters the user info string. More...

	hasStandardPort ()
	Does this Uri use a standard port? More...

	filterPort ($port)
	Filter Uri port. More...

	filterPath ($path)
	Filter Uri path. More...

	filterQuery ($query)
	Filters the query string or fragment of a URI. More...

Protected Attributes
	$scheme = ''

	$user = ''

	$password = ''

	$host = ''

	$port

	$basePath = ''

	$path = ''

	$query = ''

	$fragment = ''

Detailed Description

Value object representing a URI.

This interface is meant to represent URIs according to RFC 3986 and to provide methods for most common operations. Additional functionality for working with URIs can be provided on top of the interface or externally. Its primary use is for HTTP requests, but may also be used in other contexts.

Instances of this interface are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current instance and return an instance that contains the changed state.

Typically the Host header will be also be present in the request message. For server-side requests, the scheme will typically be discoverable in the server parameters.

(the URI specification)

Definition at line 35 of file Uri.php.

Constructor & Destructor Documentation

◆ __construct()

Slim\Http\Uri::__construct	(	$scheme,
		$host,
		$port = `null`,
		$path = `'/'`,
		$query = `''`,
		$fragment = `''`,
		$user = `''`,
		$password = `''`
	)

Create new Uri.

Parameters

string	$scheme	Uri scheme.
string	$host	Uri host.
int	$port	Uri port number.
string	$path	Uri path.
string	$query	Uri query string.
string	$fragment	Uri fragment.
string	$user	Uri user.
string	$password	Uri password.

Definition at line 112 of file Uri.php.

      {
        $this->scheme = $this->filterScheme($scheme);
        $this->host = $host;
        $this->port = $this->filterPort($port);
        $this->path = empty($path) ? '/' : $this->filterPath($path);
        $this->query = $this->filterQuery($query);
        $this->fragment = $this->filterQuery($fragment);
        $this->user = $user;
        $this->password = $password;
    }

References Slim\Http\Uri\$fragment, Slim\Http\Uri\$host, Slim\Http\Uri\$password, Slim\Http\Uri\$path, Slim\Http\Uri\$port, Slim\Http\Uri\$query, Slim\Http\Uri\$scheme, Slim\Http\Uri\$user, Slim\Http\Uri\filterPath(), Slim\Http\Uri\filterPort(), Slim\Http\Uri\filterQuery(), Slim\Http\Uri\filterScheme(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

Slim\Http\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 806 of file Uri.php.

    {
        $scheme = $this->getScheme();
        $authority = $this->getAuthority();
        $basePath = $this->getBasePath();
        $path = $this->getPath();
        $query = $this->getQuery();
        $fragment = $this->getFragment();
 
        $path = $basePath . '/' . ltrim($path, '/');
 
        return ($scheme !== '' ? $scheme . ':' : '')
            . ($authority !== '' ? '//' . $authority : '')
            . $path
            . ($query !== '' ? '?' . $query : '')
            . ($fragment !== '' ? '#' . $fragment : '');
    }

References $authority, Slim\Http\Uri\$basePath, Slim\Http\Uri\$fragment, Slim\Http\Uri\$path, Slim\Http\Uri\$query, Slim\Http\Uri\$scheme, Slim\Http\Uri\getAuthority(), Slim\Http\Uri\getBasePath(), Slim\Http\Uri\getFragment(), Slim\Http\Uri\getPath(), Slim\Http\Uri\getQuery(), and Slim\Http\Uri\getScheme().

Here is the call graph for this function:

◆ createFromEnvironment()

static Slim\Http\Uri::createFromEnvironment ( Environment $env )

static

Create new Uri from environment.

Parameters

Environment $env

Returns: self

Definition at line 166 of file Uri.php.

    {
        // Scheme
        $isSecure = $env->get('HTTPS');
        $scheme = (empty($isSecure) || $isSecure === 'off') ? 'http' : 'https';
 
        // Authority: Username and password
        $username = $env->get('PHP_AUTH_USER', '');
        $password = $env->get('PHP_AUTH_PW', '');
 
        // Authority: Host and Port
        if ($env->has('HTTP_HOST')) {
            $host = $env->get('HTTP_HOST');
            // set a port default
            $port = null;
        } else {
            $host = $env->get('SERVER_NAME');
            // set a port default
            $port = (int)$env->get('SERVER_PORT', 80);
        }
 
        if (preg_match('/^(\[[a-fA-F0-9:.]+\])(:\d+)?\z/', $host, $matches)) {
            $host = $matches[1];
 
            if (isset($matches[2])) {
                $port = (int) substr($matches[2], 1);
            }
        } else {
            $pos = strpos($host, ':');
            if ($pos !== false) {
                $port = (int) substr($host, $pos + 1);
                $host = strstr($host, ':', true);
            }
        }
 
        // Path
        $requestScriptName = parse_url($env->get('SCRIPT_NAME'), PHP_URL_PATH);
        $requestScriptDir = dirname($requestScriptName);
 
        // parse_url() requires a full URL. As we don't extract the domain name or scheme,
        // we use a stand-in.
        $requestUri = parse_url('http://example.com' . $env->get('REQUEST_URI'), PHP_URL_PATH);
 
        $basePath = '';
        $virtualPath = $requestUri;
        if (stripos($requestUri, $requestScriptName) === 0) {
            $basePath = $requestScriptName;
        } elseif ($requestScriptDir !== '/' && stripos($requestUri, $requestScriptDir) === 0) {
            $basePath = $requestScriptDir;
        }
 
        if ($basePath) {
            $virtualPath = ltrim(substr($requestUri, strlen($basePath)), '/');
        }
 
        // Query string
        $queryString = $env->get('QUERY_STRING', '');
        if ($queryString === '') {
            $queryString = parse_url('http://example.com' . $env->get('REQUEST_URI'), PHP_URL_QUERY);
        }
 
        // Fragment
        $fragment = '';
 
        // Build Uri
        $uri = new static($scheme, $host, $port, $virtualPath, $queryString, $fragment, $username, $password);
        if ($basePath) {
            $uri = $uri->withBasePath($basePath);
        }
 
        return $uri;
    }

References Slim\Http\Uri\$basePath, $env, Slim\Http\Uri\$fragment, Slim\Http\Uri\$host, Slim\Http\Uri\$password, Slim\Http\Uri\$port, and Slim\Http\Uri\$scheme.

Referenced by Slim\Http\Request\createFromEnvironment().

Here is the caller graph for this function:

◆ createFromString()

static Slim\Http\Uri::createFromString ( $uri )

static

Create new Uri from string.

Parameters

string $uri Complete Uri string (i.e., https://user:pass@host:443/path?query).

Returns: self

Definition at line 140 of file Uri.php.

    {
        if (!is_string($uri) && !method_exists($uri, '__toString')) {
            throw new InvalidArgumentException('Uri must be a string');
        }
 
        $parts = parse_url($uri);
        $scheme = isset($parts['scheme']) ? $parts['scheme'] : '';
        $user = isset($parts['user']) ? $parts['user'] : '';
        $pass = isset($parts['pass']) ? $parts['pass'] : '';
        $host = isset($parts['host']) ? $parts['host'] : '';
        $port = isset($parts['port']) ? $parts['port'] : null;
        $path = isset($parts['path']) ? $parts['path'] : '';
        $query = isset($parts['query']) ? $parts['query'] : '';
        $fragment = isset($parts['fragment']) ? $parts['fragment'] : '';
 
        return new static($scheme, $host, $port, $path, $query, $fragment, $user, $pass);
    }

References Slim\Http\Uri\$fragment, Slim\Http\Uri\$host, $pass, Slim\Http\Uri\$path, Slim\Http\Uri\$port, Slim\Http\Uri\$query, Slim\Http\Uri\$scheme, and Slim\Http\Uri\$user.

◆ filterPath()

Slim\Http\Uri::filterPath ( $path )

protected

Filter Uri path.

This method percent-encodes all reserved characters in the provided path string. This method will NOT double-encode characters that are already percent-encoded.

Parameters

string $path The raw uri path.

Returns: string The RFC 3986 percent-encoded uri path. http://www.faqs.org/rfcs/rfc3986.html

Definition at line 644 of file Uri.php.

    {
        return preg_replace_callback(
            '/(?:[^a-zA-Z0-9_\-\.~:@&=\+\$,\/;%]+|%(?![A-Fa-f0-9]{2}))/',
            function ($match) {
                return rawurlencode($match[0]);
            },
            $path
        );
    }

References Slim\Http\Uri\$path.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\withBasePath(), and Slim\Http\Uri\withPath().

Here is the caller graph for this function:

◆ filterPort()

Slim\Http\Uri::filterPort ( $port )

protected

Filter Uri port.

Parameters

null | int $port The Uri port number.

Returns: null|int

Exceptions

InvalidArgumentException If the port is invalid.

Definition at line 510 of file Uri.php.

    {
        if (is_null($port) || (is_integer($port) && ($port >= 1 && $port <= 65535))) {
            return $port;
        }
 
        throw new InvalidArgumentException('Uri port must be null or an integer between 1 and 65535 (inclusive)');
    }

References Slim\Http\Uri\$port.

Referenced by Slim\Http\Uri\__construct(), and Slim\Http\Uri\withPort().

Here is the caller graph for this function:

◆ filterQuery()

Slim\Http\Uri::filterQuery ( $query )

protected

Filters the query string or fragment of a URI.

Parameters

string $query The raw uri query string.

Returns: string The percent-encoded query string.

Definition at line 717 of file Uri.php.

    {
        return preg_replace_callback(
            '/(?:[^a-zA-Z0-9_\-\.~!\$&\'\‍(\‍)\*\+,;=%:@\/\?]+|%(?![A-Fa-f0-9]{2}))/',
            function ($match) {
                return rawurlencode($match[0]);
            },
            $query
        );
    }

References Slim\Http\Uri\$query.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\withFragment(), and Slim\Http\Uri\withQuery().

Here is the caller graph for this function:

◆ filterScheme()

Slim\Http\Uri::filterScheme ( $scheme )

protected

Filter Uri scheme.

Parameters

string $scheme Raw Uri scheme.

Returns: string

Exceptions

InvalidArgumentException	If the Uri scheme is not a string.
InvalidArgumentException	If Uri scheme is not "", "https", or "http".

Definition at line 295 of file Uri.php.

    {
        static $valid = [
            '' => true,
            'https' => true,
            'http' => true,
        ];
 
        if (!is_string($scheme) && !method_exists($scheme, '__toString')) {
            throw new InvalidArgumentException('Uri scheme must be a string');
        }
 
        $scheme = str_replace('://', '', strtolower((string)$scheme));
        if (!isset($valid[$scheme])) {
            throw new InvalidArgumentException('Uri scheme must be one of: "", "https", "http"');
        }
 
        return $scheme;
    }

References Slim\Http\Uri\$scheme, and $valid.

Referenced by Slim\Http\Uri\__construct(), and Slim\Http\Uri\withScheme().

Here is the caller graph for this function:

◆ filterUserInfo()

Slim\Http\Uri::filterUserInfo ( $query )

protected

Filters the user info string.

Parameters

string $query The raw uri query string.

Returns: string The percent-encoded query string.

Definition at line 399 of file Uri.php.

    {
        return preg_replace_callback(
            '/(?:[^a-zA-Z0-9_\-\.~!\$&\'\‍(\‍)\*\+,;=]+|%(?![A-Fa-f0-9]{2}))/u',
            function ($match) {
                return rawurlencode($match[0]);
            },
            $query
        );
    }

References Slim\Http\Uri\$query.

Referenced by Slim\Http\Uri\withUserInfo().

Here is the caller graph for this function:

◆ getAuthority()

Slim\Http\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 337 of file Uri.php.

    {
        $userInfo = $this->getUserInfo();
        $host = $this->getHost();
        $port = $this->getPort();
 
        return ($userInfo !== '' ? $userInfo . '@' : '') . $host . ($port !== null ? ':' . $port : '');
    }

References Slim\Http\Uri\$host, Slim\Http\Uri\$port, Slim\Http\Uri\getHost(), Slim\Http\Uri\getPort(), and Slim\Http\Uri\getUserInfo().

Referenced by Slim\Http\Uri\__toString(), and Slim\Http\Uri\getBaseUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBasePath()

Slim\Http\Uri::getBasePath ( )

Retrieve the base path segment of the URI.

Note: This method is not part of the PSR-7 standard.

This method MUST return a string; if no path is present it MUST return an empty string.

Returns: string The base path segment of the URI.

Definition at line 602 of file Uri.php.

    {
        return $this->basePath;
    }

References Slim\Http\Uri\$basePath.

Referenced by Slim\Http\Uri\__toString(), and Slim\Http\Uri\getBaseUrl().

Here is the caller graph for this function:

◆ getBaseUrl()

Slim\Http\Uri::getBaseUrl ( )

Return the fully qualified base URL.

Note that this method never includes a trailing /

This method is not part of PSR-7.

Returns: string

Definition at line 833 of file Uri.php.

    {
        $scheme = $this->getScheme();
        $authority = $this->getAuthority();
        $basePath = $this->getBasePath();
 
        if ($authority !== '' && substr($basePath, 0, 1) !== '/') {
            $basePath = $basePath . '/' . $basePath;
        }
 
        return ($scheme !== '' ? $scheme . ':' : '')
            . ($authority ? '//' . $authority : '')
            . rtrim($basePath, '/');
    }

References $authority, Slim\Http\Uri\$basePath, Slim\Http\Uri\$scheme, Slim\Http\Uri\getAuthority(), Slim\Http\Uri\getBasePath(), and Slim\Http\Uri\getScheme().

Here is the call graph for this function:

◆ getFragment()

Slim\Http\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 748 of file Uri.php.

    {
        return $this->fragment;
    }

References Slim\Http\Uri\$fragment.

Referenced by Slim\Http\Uri\__toString().

Here is the caller graph for this function:

◆ getHost()

Slim\Http\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 421 of file Uri.php.

    {
        return $this->host;
    }

References Slim\Http\Uri\$host.

Referenced by Slim\Http\Uri\getAuthority().

Here is the caller graph for this function:

◆ getPath()

Slim\Http\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 548 of file Uri.php.

    {
        return $this->path;
    }

References Slim\Http\Uri\$path.

Referenced by Slim\Http\Uri\__toString().

Here is the caller graph for this function:

◆ getPort()

Slim\Http\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 461 of file Uri.php.

    {
        return $this->port && !$this->hasStandardPort() ? $this->port : null;
    }

References Slim\Http\Uri\hasStandardPort().

Referenced by Slim\Http\Uri\getAuthority().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuery()

Slim\Http\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 679 of file Uri.php.

    {
        return $this->query;
    }

References Slim\Http\Uri\$query.

Referenced by Slim\Http\Uri\__toString().

Here is the caller graph for this function:

◆ getScheme()

Slim\Http\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 257 of file Uri.php.

    {
        return $this->scheme;
    }

References Slim\Http\Uri\$scheme.

Referenced by Slim\Http\Uri\__toString(), and Slim\Http\Uri\getBaseUrl().

Here is the caller graph for this function:

◆ getUserInfo()

Slim\Http\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 361 of file Uri.php.

    {
        return $this->user . ($this->password !== '' ? ':' . $this->password : '');
    }

References user().

Referenced by Slim\Http\Uri\getAuthority().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasStandardPort()

Slim\Http\Uri::hasStandardPort ( )

protected

Does this Uri use a standard port?

Returns: bool

Definition at line 497 of file Uri.php.

    {
        return ($this->scheme === 'http' && $this->port === 80) || ($this->scheme === 'https' && $this->port === 443);
    }

Referenced by Slim\Http\Uri\getPort().

Here is the caller graph for this function:

◆ withBasePath()

Slim\Http\Uri::withBasePath ( $basePath )

Set base path.

Note: This method is not part of the PSR-7 standard.

Parameters

string $basePath

Returns: self

Definition at line 615 of file Uri.php.

    {
        if (!is_string($basePath)) {
            throw new InvalidArgumentException('Uri path must be a string');
        }
        if (!empty($basePath)) {
            $basePath = '/' . trim($basePath, '/'); // <-- Trim on both sides
        }
        $clone = clone $this;
 
        if ($basePath !== '/') {
            $clone->basePath = $this->filterPath($basePath);
        }
 
        return $clone;
    }

References Slim\Http\Uri\$basePath, and Slim\Http\Uri\filterPath().

Here is the call graph for this function:

◆ withFragment()

Slim\Http\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: self A new instance with the specified fragment.

Implements Psr\Http\Message\UriInterface.

Definition at line 767 of file Uri.php.

    {
        if (!is_string($fragment) && !method_exists($fragment, '__toString')) {
            throw new InvalidArgumentException('Uri fragment must be a string');
        }
        $fragment = ltrim((string)$fragment, '#');
        $clone = clone $this;
        $clone->fragment = $this->filterQuery($fragment);
 
        return $clone;
    }

References Slim\Http\Uri\$fragment, and Slim\Http\Uri\filterQuery().

Here is the call graph for this function:

◆ withHost()

Slim\Http\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: self A new instance with the specified host.

Exceptions

InvalidArgumentException for invalid hostnames.

Implements Psr\Http\Message\UriInterface.

Definition at line 438 of file Uri.php.

    {
        $clone = clone $this;
        $clone->host = $host;
 
        return $clone;
    }

References Slim\Http\Uri\$host.

◆ withPath()

Slim\Http\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: self A new instance with the specified path.

Exceptions

InvalidArgumentException for invalid paths.

Implements Psr\Http\Message\UriInterface.

Definition at line 575 of file Uri.php.

    {
        if (!is_string($path)) {
            throw new InvalidArgumentException('Uri path must be a string');
        }
 
        $clone = clone $this;
        $clone->path = $this->filterPath($path);
 
        // if the path is absolute, then clear basePath
        if (substr($path, 0, 1) == '/') {
            $clone->basePath = '';
        }
 
        return $clone;
    }

References Slim\Http\Uri\$path, and Slim\Http\Uri\filterPath().

Here is the call graph for this function:

◆ withPort()

Slim\Http\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: self A new instance with the specified port.

Exceptions

InvalidArgumentException for invalid ports.

Implements Psr\Http\Message\UriInterface.

Definition at line 483 of file Uri.php.

    {
        $port = $this->filterPort($port);
        $clone = clone $this;
        $clone->port = $port;
 
        return $clone;
    }

References Slim\Http\Uri\$port, and Slim\Http\Uri\filterPort().

Here is the call graph for this function:

◆ withQuery()

Slim\Http\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: self A new instance with the specified query string.

Exceptions

InvalidArgumentException for invalid query strings.

Implements Psr\Http\Message\UriInterface.

Definition at line 699 of file Uri.php.

    {
        if (!is_string($query) && !method_exists($query, '__toString')) {
            throw new InvalidArgumentException('Uri query must be a string');
        }
        $query = ltrim((string)$query, '?');
        $clone = clone $this;
        $clone->query = $this->filterQuery($query);
 
        return $clone;
    }

References Slim\Http\Uri\$query, and Slim\Http\Uri\filterQuery().

Here is the call graph for this function:

◆ withScheme()

Slim\Http\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: self A new instance with the specified scheme.

Exceptions

InvalidArgumentException for invalid or unsupported schemes.

Implements Psr\Http\Message\UriInterface.

Definition at line 277 of file Uri.php.

    {
        $scheme = $this->filterScheme($scheme);
        $clone = clone $this;
        $clone->scheme = $scheme;
 
        return $clone;
    }

References Slim\Http\Uri\$scheme, and Slim\Http\Uri\filterScheme().

Here is the call graph for this function:

◆ withUserInfo()

Slim\Http\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: self A new instance with the specified user information.

Implements Psr\Http\Message\UriInterface.

Definition at line 380 of file Uri.php.

    {
        $clone = clone $this;
        $clone->user = $this->filterUserInfo($user);
        if ('' !== $clone->user) {
            $clone->password = !in_array($password, [null, ''], true) ? $this->filterUserInfo($password) : '';
        } else {
            $clone->password = '';
        }
 
        return $clone;
    }

References Slim\Http\Uri\$password, Slim\Http\Uri\$user, and Slim\Http\Uri\filterUserInfo().

Here is the call graph for this function:

Field Documentation

◆ $basePath

Slim\Http\Uri::$basePath = ''

protected

Definition at line 77 of file Uri.php.

Referenced by Slim\Http\Uri\__toString(), Slim\Http\Uri\createFromEnvironment(), Slim\Http\Uri\getBasePath(), Slim\Http\Uri\getBaseUrl(), and Slim\Http\Uri\withBasePath().

◆ $fragment

Slim\Http\Uri::$fragment = ''

protected

Definition at line 98 of file Uri.php.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\__toString(), Slim\Http\Uri\createFromEnvironment(), Slim\Http\Uri\createFromString(), Slim\Http\Uri\getFragment(), and Slim\Http\Uri\withFragment().

◆ $host

Slim\Http\Uri::$host = ''

protected

Definition at line 63 of file Uri.php.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\createFromEnvironment(), Slim\Http\Uri\createFromString(), Slim\Http\Uri\getAuthority(), Slim\Http\Uri\getHost(), and Slim\Http\Uri\withHost().

◆ $password

Slim\Http\Uri::$password = ''

protected

Definition at line 56 of file Uri.php.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\createFromEnvironment(), and Slim\Http\Uri\withUserInfo().

◆ $path

Slim\Http\Uri::$path = ''

protected

Definition at line 84 of file Uri.php.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\__toString(), Slim\Http\Uri\createFromString(), Slim\Http\Uri\filterPath(), Slim\Http\Uri\getPath(), and Slim\Http\Uri\withPath().

◆ $port

Slim\Http\Uri::$port

protected

Definition at line 70 of file Uri.php.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\createFromEnvironment(), Slim\Http\Uri\createFromString(), Slim\Http\Uri\filterPort(), Slim\Http\Uri\getAuthority(), and Slim\Http\Uri\withPort().

◆ $query

Slim\Http\Uri::$query = ''

protected

Definition at line 91 of file Uri.php.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\__toString(), Slim\Http\Uri\createFromString(), Slim\Http\Uri\filterQuery(), Slim\Http\Uri\filterUserInfo(), Slim\Http\Uri\getQuery(), and Slim\Http\Uri\withQuery().

◆ $scheme

Slim\Http\Uri::$scheme = ''

protected

Definition at line 42 of file Uri.php.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\__toString(), Slim\Http\Uri\createFromEnvironment(), Slim\Http\Uri\createFromString(), Slim\Http\Uri\filterScheme(), Slim\Http\Uri\getBaseUrl(), Slim\Http\Uri\getScheme(), and Slim\Http\Uri\withScheme().

◆ $user

Slim\Http\Uri::$user = ''

protected

Definition at line 49 of file Uri.php.

Referenced by Slim\Http\Uri\__construct(), Slim\Http\Uri\createFromString(), and Slim\Http\Uri\withUserInfo().

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

libs/composer/vendor/slim/slim/Slim/Http/Uri.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ createFromEnvironment()

◆ createFromString()

◆ filterPath()

◆ filterPort()

◆ filterQuery()

◆ filterScheme()

◆ filterUserInfo()

◆ getAuthority()

◆ getBasePath()

◆ getBaseUrl()

◆ getFragment()

◆ getHost()

◆ getPath()

◆ getPort()

◆ getQuery()

◆ getScheme()

◆ getUserInfo()

◆ hasStandardPort()

◆ withBasePath()

◆ withFragment()

◆ withHost()

◆ withPath()

◆ withPort()

◆ withQuery()

◆ withScheme()

◆ withUserInfo()

Field Documentation

◆ $basePath

◆ $fragment

◆ $host

◆ $password

◆ $path

◆ $port

◆ $query

◆ $scheme

◆ $user