URI.php

Builds a representation of the string from the component parts.

Used when resolving and merging paths to correctly interpret and remove single and double dot segments from the path per RFC 3986 Section 5.2.4

Constructor. See https://www.php-fig.org/psr/psr-17/#26-urifactoryinterface

If $silent == true, then will not throw exceptions and will attempt to continue gracefully.

If $raw == true, then will use parseStr() method instead of native parse_str() function. Note: Method not in PSR-7

Sets and overwrites any current URI information.

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.

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: <pre> [user-info@]host[:port] </pre> If the port component is not set or is the standard port for the current scheme, it SHOULD NOT be included.

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. NOTE that be default, the password, if available, will NOT be shown as a security measure as discussed in RFC 3986, Section 7.5. If you know the password is not a security issue, you can force it to be shown with $this->showPassword(); The trailing "@" character is not part of the user information and MUST NOT be added.

Temporarily sets the URI to show a password in userInfo. Will reset itself after the first call to authority(). Note: Method not in PSR-7

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.

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.

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.

Retrieve the query string

Retrieve a URI fragment

Returns the segments of the path as an array.

Returns the value of a specific segment of the URI path. Allows to get only existing segments or the next one. segment, the $default value. If you specify the last +2 or more throws HTTPException.

Set the value of a specific segment of the URI path. Allows to set only existing segments or add new one. Note: Method not in PSR-7

Returns the total number of segments. Note: Method not in PSR-7

Formats the URI as a string. Warning: For backwards-compatability this method assumes URIs with the same host as baseURL should be relative to the project's configuration. This aspect of __toString() is deprecated and should be avoided.

Change the path (and scheme) assuming URIs with the same host as baseURL should be relative to the project's configuration.

Parses the given string and saves the appropriate authority pieces. Note: Method not in PSR-7

Sets the scheme for this URI. Because of the large number of valid schemes we cannot limit this to only http or https.

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.

Sets the userInfo/Authority portion of the URI.

Sets the host name to use.

Sets the port portion of the URI.

Sets the path portion of the URI.

Sets the current baseURL.

Returns the current baseURL.

Sets the path portion of the URI based on segments.

Sets the query portion of the URI, while attempting to clean the various parts of the query keys and values.

A convenience method to pass an array of items in as the Query portion of the URI.

Adds a single new element to the query vars. Note: Method not in PSR-7

Removes one or more query vars from the URI. Note: Method not in PSR-7

Filters the query variables so that only the keys passed in are kept. The rest are removed from the object. Note: Method not in PSR-7

Sets the fragment portion of the URI.

Encodes any dangerous characters, and removes dot segments. While dot segments have valid uses according to the spec, this URI class does not allow them.

Saves our parts from a parse_url call. host?: string, user?: string, path?: string, query?: string, fragment?: string, scheme?: string, port?: int, pass?: string, } $parts

Combines one URI string with this one based on the rules set out in RFC 3986 Section 2

Given 2 paths, will merge them according to rules set out in RFC 2986, Section 5.2

This is equivalent to the native PHP parse_str() function. This version allows the dot to be used as a key of the query string.