The scope of this class is split ilias-conform URI's into components. More...

Collaboration diagram for ILIAS\Data\URI:

Public Member Functions
	__construct (string $uri_string)

	getSchema ()

	withSchema (string $schema)
	Get URI with modified schema. More...

	getAuthority ()

	withAuthority (string $authority)
	Get URI with modified authority. More...

	getPort ()

	withPort (?int $port=null)
	Get URI with modified port. More...

	getHost ()

	withHost (string $host)
	Get URI with modified host. More...

	getPath ()

	withPath (?string $path=null)
	Get URI with modified path. More...

	getQuery ()

	withQuery (?string $query=null)
	Get URI with modified query. More...

	getFragment ()

	withFragment (?string $fragment=null)
	Get URI with modified fragment. More...

	getBaseURI ()
	Get a well-formed URI consisting only of schema, authority and port. More...

	__toString ()

	getParameters ()
	Get all parameters as associative array. More...

	getParameter (string $param)
	Get the value of the given parameter (or null) More...

	withParameters (array $parameters)
	Get URI with modified parameters. More...

	withParameter (string $key, $value)
	Get URI with modified parameters. More...

Protected Member Functions
	digestSchema (string $schema)
	Check schema formating. More...

	digestHost (string $host)
	Check host formating. More...

	digestPort (?int $port=null)
	Check port formating. More...

	digestPath (?string $path=null)
	Check path formating. More...

	digestQuery (?string $query=null)
	Check query formating. More...

	digestFragment (?string $fragment=null)
	Check fragment formating. More...

	checkCorrectFormatOrThrow (string $regexp, string $string)
	Check wether a string fits a regexp. More...

Protected Attributes
string	$schema

string	$host

int	$port

string	$path

string	$query

string	$fragment

Private Attributes
const	PATH_DELIM = '/'

const	ALPHA = '[A-Za-z]'
	Relevant character-groups as defined in RFC 3986 Appendix 1. More...

const	DIGIT = '[0-9]'

const	ALPHA_DIGIT = '[A-Za-z0-9]'

const	HEXDIG = '[0-9A-Fa-f]'

const	PCTENCODED = '%' . self::HEXDIG . self::HEXDIG

const	PIMP = '[\\+\\-\\.]'
	point\|minus\|plus to be used in schema. More...

const	SUBDELIMS = '[\\$,;=!&\'\\‍(\\‍)\\*\\+]'
	valid subdelims according to RFC 3986 Appendix 1: "!" "$" "&" "'" "(" ")" "*" "+" "," ";" "=" More...

const	BASEURI_SUBDELIMS = '[\\$,;&\'\\*]'
	subdelims without jsf**k characters +!() and = More...

const	UNRESERVED = self::ALPHA_DIGIT . '\|[\\-\\._~]'

const	UNRESERVED_NO_DOT = self::ALPHA_DIGIT . '\|[\\-_~]'

const	PCHAR = self::UNRESERVED . '\|' . self::SUBDELIMS . '\|' . self::PCTENCODED

const	SCHEMA = '#^' . self::ALPHA . '(' . self::ALPHA_DIGIT . '\|' . self::PIMP . ')*$#'

const	DOMAIN_LABEL = self::ALPHA_DIGIT . '((' . self::UNRESERVED_NO_DOT . '\|' . self::PCTENCODED . '\|' . self::BASEURI_SUBDELIMS . ')' . self::ALPHA_DIGIT . ')'

const	HOST_REG_NAME = '^' . self::DOMAIN_LABEL . '(\\.' . self::DOMAIN_LABEL . ')*$'

const	HOST_IPV4_EMBEDDED = '(' . self::DIGIT . '{1,3})(\\.' . self::DIGIT . '{1,3}){3}'

const	HOST_IPV4 = '^' . self::HOST_IPV4_EMBEDDED . '$'

const	IPV6_COUNT_COLONS = '(' . self::HEXDIG . '{1,4}:)'

const	IPV6_COLONS_BETWEEN = '(' . self::HEXDIG . '{0,4}:' . self::HEXDIG . '{0,4})'

const	IPV6_LEFT_SHORT = '(' . self::HEXDIG . '{1,4}\|' . self::HEXDIG . '{1,4}(:' . self::HEXDIG . '{1,4})*)?'

const	HOST_IPV6_LONG = '^\\[' . self::IPV6_COUNT_COLONS . '{7}' . self::HEXDIG . '{1,4}\\]$'

const	HOST_IPV6_SHORT

const	HOST_IPV6_EMBEDDED_IPV4_LONG = '^\\[' . self::IPV6_COUNT_COLONS . '{5}' . self::HEXDIG . '{1,4}:' . self::HOST_IPV4_EMBEDDED . '\\]$'

const	HOST_IPV6_EMBEDDED_IPV4_SHORT

const	HOST_IPV6_EMBEDDED_IPV4 = self::HOST_IPV6_EMBEDDED_IPV4_SHORT . '\|' . self::HOST_IPV6_EMBEDDED_IPV4_LONG

const	HOST_IPV6 = self::HOST_IPV6_LONG . '\|' . self::HOST_IPV6_SHORT . '\|' . self::HOST_IPV6_EMBEDDED_IPV4

const	HOST = '#' . self::HOST_IPV4 . '\|' . self::HOST_REG_NAME . '\|' . self::HOST_IPV6 . '#'

const	PORT = '#^' . self::DIGIT . '+$#'

const	PATH = '#^(?!//)(?!:)(' . self::PCHAR . '\|' . self::PATH_DELIM . ')+$#'

const	QUERY = '#^(' . self::PCHAR . '\|' . self::PATH_DELIM . '\|\\?)+$#'

const	FRAGMENT = '#^(' . self::PCHAR . '\|' . self::PATH_DELIM . '\|\\?\|\\#)+$#'

Detailed Description

The scope of this class is split ilias-conform URI's into components.

Please refer to RFC 3986 for details. Notice, ilias-confor URI's will form a SUBSET of RFC 3986:

Notice the restrictions on baseuri-subdelims.
We require a schema and an authority to be present.
If any part is located and it is invalid an exception will be thrown instead of just omiting it.
IPv6 is now supported.
The IPv6 conforms to https://datatracker.ietf.org/doc/html/rfc4291#section-2.2.

Definition at line 34 of file URI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Data\URI::__construct ( string $uri_string )

Definition at line 110 of file URI.php.

    {
        $this->schema = $this->digestSchema(parse_url($uri_string, PHP_URL_SCHEME));
        $this->host = $this->digestHost(parse_url($uri_string, PHP_URL_HOST));
        $this->port = $this->digestPort(parse_url($uri_string, PHP_URL_PORT));
        $this->path = $this->digestPath(parse_url($uri_string, PHP_URL_PATH));
        $this->query = $this->digestQuery(parse_url($uri_string, PHP_URL_QUERY));
        $this->fragment = $this->digestFragment(parse_url($uri_string, PHP_URL_FRAGMENT));
    }

References ILIAS\Data\URI\digestFragment(), ILIAS\Data\URI\digestHost(), ILIAS\Data\URI\digestPath(), ILIAS\Data\URI\digestPort(), ILIAS\Data\URI\digestQuery(), and ILIAS\Data\URI\digestSchema().

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

ILIAS\Data\URI::__toString ( )

Definition at line 336 of file URI.php.

                                : string
    {
        $uri = $this->getBaseURI();
        $query = $this->getQuery();
        if ($query) {
            $uri .= '?' . $query;
        }
        $fragment = $this->getFragment();
        if ($fragment) {
            $uri .= '#' . $fragment;
        }
        return $uri;
    }

References ILIAS\Data\URI\$fragment, ILIAS\Data\URI\$query, ILIAS\Data\URI\getBaseURI(), ILIAS\Data\URI\getFragment(), and ILIAS\Data\URI\getQuery().

Referenced by ILIAS\UI\Implementation\Component\Link\Bulky\__construct(), and ILIAS\UI\Implementation\Component\Prompt\State\State\withRedirect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkCorrectFormatOrThrow()

ILIAS\Data\URI::checkCorrectFormatOrThrow	(	string	$regexp,
		string	$string
	)

protected

Check wether a string fits a regexp.

Return it, if so, throw otherwise.

Definition at line 190 of file URI.php.

                                                                                : string
    {
        if (preg_match($regexp, $string) === 1) {
            return $string;
        }
        throw new \InvalidArgumentException('ill-formated component "' . $string . '" expected "' . $regexp . '"');
    }

Referenced by ILIAS\Data\URI\digestFragment(), ILIAS\Data\URI\digestHost(), ILIAS\Data\URI\digestPath(), ILIAS\Data\URI\digestQuery(), ILIAS\Data\URI\digestSchema(), and ILIAS\Data\URI\withAuthority().

Here is the caller graph for this function:

◆ digestFragment()

ILIAS\Data\URI::digestFragment ( ?string $fragment = null )

protected

Check fragment formating.

Return it in case of success.

Definition at line 177 of file URI.php.

                                                               : ?string
    {
        if ($fragment === null) {
            return null;
        }
        return $this->checkCorrectFormatOrThrow(self::FRAGMENT, $fragment);
    }

References ILIAS\Data\URI\$fragment, and ILIAS\Data\URI\checkCorrectFormatOrThrow().

Referenced by ILIAS\Data\URI\__construct(), and ILIAS\Data\URI\withFragment().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ digestHost()

ILIAS\Data\URI::digestHost ( string $host )

protected

Check host formating.

Return it in case of success.

Definition at line 131 of file URI.php.

                                               : string
    {
        return $this->checkCorrectFormatOrThrow(self::HOST, $host);
    }

References ILIAS\Data\URI\$host, and ILIAS\Data\URI\checkCorrectFormatOrThrow().

Referenced by ILIAS\Data\URI\__construct(), ILIAS\Data\URI\withAuthority(), and ILIAS\Data\URI\withHost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ digestPath()

ILIAS\Data\URI::digestPath ( ?string $path = null )

protected

Check path formating.

Return it in case of success.

Definition at line 147 of file URI.php.

                                                       : ?string
    {
        if ($path === null) {
            return null;
        }
        $path = trim($this->checkCorrectFormatOrThrow(self::PATH, $path), self::PATH_DELIM);
        if ($path === '') {
            $path = null;
        }
        return $path;
    }

References ILIAS\Data\URI\$path, and ILIAS\Data\URI\checkCorrectFormatOrThrow().

Referenced by ILIAS\Data\URI\__construct(), and ILIAS\Data\URI\withPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ digestPort()

ILIAS\Data\URI::digestPort ( ?int $port = null )

protected

Check port formating.

Return it in case of success.

Definition at line 139 of file URI.php.

                                                    : ?int
    {
        return $port ?? null;
    }

References ILIAS\Data\URI\$port.

Referenced by ILIAS\Data\URI\__construct(), and ILIAS\Data\URI\withPort().

Here is the caller graph for this function:

◆ digestQuery()

ILIAS\Data\URI::digestQuery ( ?string $query = null )

protected

Check query formating.

Return it in case of success.

Definition at line 162 of file URI.php.

                                                         : ?string
    {
        if ($query === null) {
            return null;
        }
        $qparts = explode('&', $query);
        foreach ($qparts as $q) {
            $this->checkCorrectFormatOrThrow(self::QUERY, $q);
        }
        return $query;
    }

References $q, ILIAS\Data\URI\$query, and ILIAS\Data\URI\checkCorrectFormatOrThrow().

Referenced by ILIAS\Data\URI\__construct(), and ILIAS\Data\URI\withQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ digestSchema()

ILIAS\Data\URI::digestSchema ( string $schema )

protected

Check schema formating.

Return it in case of success.

Definition at line 123 of file URI.php.

                                                   : string
    {
        return $this->checkCorrectFormatOrThrow(self::SCHEMA, $schema);
    }

References ILIAS\Data\URI\$schema, and ILIAS\Data\URI\checkCorrectFormatOrThrow().

Referenced by ILIAS\Data\URI\__construct(), and ILIAS\Data\URI\withSchema().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAuthority()

ILIAS\Data\URI::getAuthority ( )

Definition at line 214 of file URI.php.

                                  : string
    {
        $port = $this->getPort();
        if ($port === null) {
            return $this->getHost();
        }
        return $this->getHost() . ':' . $port;
    }

References ILIAS\Data\URI\$port, ILIAS\Data\URI\getHost(), and ILIAS\Data\URI\getPort().

Referenced by ILIAS\Data\URI\getBaseURI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBaseURI()

ILIAS\Data\URI::getBaseURI ( )

Get a well-formed URI consisting only of schema, authority and port.

Definition at line 327 of file URI.php.

                                : string
    {
        $path = $this->getPath();
        if ($path === null) {
            return $this->getSchema() . '://' . $this->getAuthority();
        }
        return $this->getSchema() . '://' . $this->getAuthority() . '/' . $path;
    }

References ILIAS\Data\URI\$path, ILIAS\Data\URI\getAuthority(), ILIAS\Data\URI\getPath(), and ILIAS\Data\URI\getSchema().

Referenced by ILIAS\Data\URI\__toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFragment()

ILIAS\Data\URI::getFragment ( )

Definition at line 307 of file URI.php.

                                 : ?string
    {
        return $this->fragment;
    }

References ILIAS\Data\URI\$fragment.

Referenced by ILIAS\Data\URI\__toString().

Here is the caller graph for this function:

◆ getHost()

ILIAS\Data\URI::getHost ( )

Definition at line 259 of file URI.php.

                             : string
    {
        return $this->host;
    }

References ILIAS\Data\URI\$host.

Referenced by ILIAS\Data\URI\getAuthority().

Here is the caller graph for this function:

◆ getParameter()

ILIAS\Data\URI::getParameter ( string $param )

Get the value of the given parameter (or null)

Returns: mixed|null

Definition at line 367 of file URI.php.

    {
        $params = $this->getParameters();
 
        return $params[$param] ?? null;
    }

References $param, $params, and ILIAS\Data\URI\getParameters().

Here is the call graph for this function:

◆ getParameters()

ILIAS\Data\URI::getParameters ( )

Get all parameters as associative array.

Definition at line 353 of file URI.php.

                                   : array
    {
        $params = [];
        $query = $this->getQuery();
        if (!is_null($query)) {
            parse_str($query, $params);
        }
        return $params;
    }

References $params, ILIAS\Data\URI\$query, and ILIAS\Data\URI\getQuery().

Referenced by ILIAS\Data\URI\getParameter(), and ILIAS\Data\URI\withParameter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPath()

ILIAS\Data\URI::getPath ( )

Definition at line 275 of file URI.php.

                             : ?string
    {
        return $this->path;
    }

References ILIAS\Data\URI\$path.

Referenced by ILIAS\Data\URI\getBaseURI(), and ILIAS\StaticURL\Handler\HandlerService\performRedirect().

Here is the caller graph for this function:

◆ getPort()

ILIAS\Data\URI::getPort ( )

Definition at line 243 of file URI.php.

                             : ?int
    {
        return $this->port;
    }

References ILIAS\Data\URI\$port.

Referenced by ILIAS\Data\URI\getAuthority().

Here is the caller graph for this function:

◆ getQuery()

ILIAS\Data\URI::getQuery ( )

Definition at line 291 of file URI.php.

                              : ?string
    {
        return $this->query;
    }

References ILIAS\Data\URI\$query.

Referenced by ILIAS\Data\URI\__toString(), and ILIAS\Data\URI\getParameters().

Here is the caller graph for this function:

◆ getSchema()

ILIAS\Data\URI::getSchema ( )

Definition at line 198 of file URI.php.

                               : string
    {
        return $this->schema;
    }

References ILIAS\Data\URI\$schema.

Referenced by ILIAS\Data\URI\getBaseURI().

Here is the caller graph for this function:

◆ withAuthority()

ILIAS\Data\URI::withAuthority ( string $authority )

Get URI with modified authority.

Definition at line 226 of file URI.php.

                                                    : URI
    {
        $parts = explode(':', $authority);
        if (count($parts) > 2) {
            throw new \InvalidArgumentException('ill-formated component ' . $authority);
        }
        $host = $this->digestHost($parts[0]);
        $port = null;
        if (array_key_exists(1, $parts)) {
            $port = (int) $this->checkCorrectFormatOrThrow(self::PORT, (string) $parts[1]);
        }
        $other = clone $this;
        $other->host = $host;
        $other->port = $port;
        return $other;
    }

References ILIAS\Data\URI\$host, $parts, ILIAS\Data\URI\$port, ILIAS\Data\URI\checkCorrectFormatOrThrow(), ILIAS\Data\URI\digestHost(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ withFragment()

ILIAS\Data\URI::withFragment ( ?string $fragment = null )

Get URI with modified fragment.

Definition at line 315 of file URI.php.

                                                          : URI
    {
        $fragment = $this->digestFragment($fragment);
        $other = clone $this;
        $other->fragment = $fragment;
        return $other;
    }

References ILIAS\Data\URI\$fragment, and ILIAS\Data\URI\digestFragment().

Here is the call graph for this function:

◆ withHost()

ILIAS\Data\URI::withHost ( string $host )

Get URI with modified host.

Definition at line 267 of file URI.php.

                                          : URI
    {
        $host = $this->digestHost($host);
        $other = clone $this;
        $other->host = $host;
        return $other;
    }

References ILIAS\Data\URI\$host, and ILIAS\Data\URI\digestHost().

Here is the call graph for this function:

◆ withParameter()

ILIAS\Data\URI::withParameter	(	string	$key,
			$value
	)

Get URI with modified parameters.

Definition at line 387 of file URI.php.

                                                      : URI
    {
        $params = $this->getParameters();
        $params[$key] = $value;
        return $this->withParameters($params);
    }

References $params, ILIAS\Data\URI\getParameters(), and ILIAS\Data\URI\withParameters().

Referenced by ILIAS\Test\Questions\Presentation\QuestionsTableQuery\getActionURL(), ILIAS\UI\examples\Input\Field\TreeMultiSelect\TreeMultiSelectExampleNodeRetrieval\getAsyncNodeRenderUrl(), ILIAS\UI\examples\Input\Field\TreeSelect\TreeSelectExampleNodeRetrieval\getAsyncNodeRenderUrl(), ILIAS\StaticURL\Shortlinks\UI\TreeSelectNodeRetrieval\getAsyncRenderUrl(), KSDocumentationTreeRecursion\getNodeUri(), ILIAS\Test\Questions\RandomQuestionSetSourcePoolDefinitionListTable\getTarget(), and ILIAS\TestQuestionPool\Skills\SkillsByQuestionOverviewTable\mapRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withParameters()

ILIAS\Data\URI::withParameters ( array $parameters )

Get URI with modified parameters.

Definition at line 377 of file URI.php.

                                                     : URI
    {
        return $this->withQuery(
            http_build_query($parameters)
        );
    }

References ILIAS\Data\URI\withQuery().

Referenced by ILIAS\Data\URI\withParameter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withPath()

ILIAS\Data\URI::withPath ( ?string $path = null )

Get URI with modified path.

Definition at line 283 of file URI.php.

                                                  : URI
    {
        $path = $this->digestPath($path);
        $other = clone $this;
        $other->path = $path;
        return $other;
    }

References ILIAS\Data\URI\$path, and ILIAS\Data\URI\digestPath().

Referenced by ILIAS\StaticURL\Handler\HandlerService\performRedirect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withPort()

ILIAS\Data\URI::withPort ( ?int $port = null )

Get URI with modified port.

Definition at line 251 of file URI.php.

                                               : URI
    {
        $port = $this->digestPort($port);
        $other = clone $this;
        $other->port = $port;
        return $other;
    }

References ILIAS\Data\URI\$port, and ILIAS\Data\URI\digestPort().

Here is the call graph for this function:

◆ withQuery()

ILIAS\Data\URI::withQuery ( ?string $query = null )

Get URI with modified query.

Definition at line 299 of file URI.php.

                                                    : URI
    {
        $query = $this->digestQuery($query);
        $other = clone $this;
        $other->query = $query;
        return $other;
    }

References ILIAS\Data\URI\$query, and ILIAS\Data\URI\digestQuery().

Referenced by ILIAS\Data\URI\withParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withSchema()

ILIAS\Data\URI::withSchema ( string $schema )

Get URI with modified schema.

Definition at line 206 of file URI.php.

                                              : URI
    {
        $shema = $this->digestSchema($schema);
        $other = clone $this;
        $other->schema = $schema;
        return $other;
    }

References ILIAS\Data\URI\$schema, and ILIAS\Data\URI\digestSchema().

Here is the call graph for this function:

Field Documentation

◆ $fragment

string ILIAS\Data\URI::$fragment

protected

Definition at line 108 of file URI.php.

Referenced by ILIAS\Data\URI\__toString(), ILIAS\Data\URI\digestFragment(), ILIAS\Data\URI\getFragment(), and ILIAS\Data\URI\withFragment().

◆ $host

string ILIAS\Data\URI::$host

protected

Definition at line 104 of file URI.php.

Referenced by ILIAS\Data\URI\digestHost(), ILIAS\Data\URI\getHost(), ILIAS\Data\URI\withAuthority(), and ILIAS\Data\URI\withHost().

◆ $path

string ILIAS\Data\URI::$path

protected

Definition at line 106 of file URI.php.

Referenced by ILIAS\Data\URI\digestPath(), ILIAS\Data\URI\getBaseURI(), ILIAS\Data\URI\getPath(), and ILIAS\Data\URI\withPath().

◆ $port

int ILIAS\Data\URI::$port

protected

Definition at line 105 of file URI.php.

Referenced by ILIAS\Data\URI\digestPort(), ILIAS\Data\URI\getAuthority(), ILIAS\Data\URI\getPort(), ILIAS\Data\URI\withAuthority(), and ILIAS\Data\URI\withPort().

◆ $query

string ILIAS\Data\URI::$query

protected

Definition at line 107 of file URI.php.

Referenced by ILIAS\Data\URI\__toString(), ILIAS\Data\URI\digestQuery(), ILIAS\Data\URI\getParameters(), ILIAS\Data\URI\getQuery(), and ILIAS\Data\URI\withQuery().

◆ $schema

string ILIAS\Data\URI::$schema

protected

Definition at line 103 of file URI.php.

Referenced by ILIAS\Data\URI\digestSchema(), ILIAS\Data\URI\getSchema(), and ILIAS\Data\URI\withSchema().

◆ ALPHA

const ILIAS\Data\URI::ALPHA = '[A-Za-z]'

private

Relevant character-groups as defined in RFC 3986 Appendix 1.

Definition at line 41 of file URI.php.

◆ ALPHA_DIGIT

const ILIAS\Data\URI::ALPHA_DIGIT = '[A-Za-z0-9]'

private

Definition at line 43 of file URI.php.

◆ BASEURI_SUBDELIMS

const ILIAS\Data\URI::BASEURI_SUBDELIMS = '[\\$,;&\'\\*]'

private

subdelims without jsf**k characters +!() and =

Definition at line 59 of file URI.php.

◆ DIGIT

const ILIAS\Data\URI::DIGIT = '[0-9]'

private

Definition at line 42 of file URI.php.

◆ DOMAIN_LABEL

const ILIAS\Data\URI::DOMAIN_LABEL = self::ALPHA_DIGIT . '((' . self::UNRESERVED_NO_DOT . '|' . self::PCTENCODED . '|' . self::BASEURI_SUBDELIMS . ')*' . self::ALPHA_DIGIT . ')*'

private

Definition at line 67 of file URI.php.

◆ FRAGMENT

const ILIAS\Data\URI::FRAGMENT = '#^(' . self::PCHAR . '|' . self::PATH_DELIM . '|\\?|\\#)+$#'

private

Definition at line 101 of file URI.php.

◆ HEXDIG

const ILIAS\Data\URI::HEXDIG = '[0-9A-Fa-f]'

private

Definition at line 44 of file URI.php.

◆ HOST

const ILIAS\Data\URI::HOST = '#' . self::HOST_IPV4 . '|' . self::HOST_REG_NAME . '|' . self::HOST_IPV6 . '#'

private

Definition at line 97 of file URI.php.

◆ HOST_IPV4

const ILIAS\Data\URI::HOST_IPV4 = '^' . self::HOST_IPV4_EMBEDDED . '$'

private

Definition at line 70 of file URI.php.

◆ HOST_IPV4_EMBEDDED

const ILIAS\Data\URI::HOST_IPV4_EMBEDDED = '(' . self::DIGIT . '{1,3})(\\.' . self::DIGIT . '{1,3}){3}'

private

Definition at line 69 of file URI.php.

◆ HOST_IPV6

const ILIAS\Data\URI::HOST_IPV6 = self::HOST_IPV6_LONG . '|' . self::HOST_IPV6_SHORT . '|' . self::HOST_IPV6_EMBEDDED_IPV4

private

Definition at line 96 of file URI.php.

◆ HOST_IPV6_EMBEDDED_IPV4

const ILIAS\Data\URI::HOST_IPV6_EMBEDDED_IPV4 = self::HOST_IPV6_EMBEDDED_IPV4_SHORT . '|' . self::HOST_IPV6_EMBEDDED_IPV4_LONG

private

Definition at line 94 of file URI.php.

◆ HOST_IPV6_EMBEDDED_IPV4_LONG

const ILIAS\Data\URI::HOST_IPV6_EMBEDDED_IPV4_LONG = '^\\[' . self::IPV6_COUNT_COLONS . '{5}' . self::HEXDIG . '{1,4}:' . self::HOST_IPV4_EMBEDDED . '\\]$'

private

Definition at line 86 of file URI.php.

◆ HOST_IPV6_EMBEDDED_IPV4_SHORT

const ILIAS\Data\URI::HOST_IPV6_EMBEDDED_IPV4_SHORT

private

Initial value:

= '^\\[(?=' . self::IPV6_COLONS_BETWEEN . '{2,6}' . self::HOST_IPV4_EMBEDDED . '\\]$)' . 
        self::IPV6_LEFT_SHORT . '::' .
        
        
        '(' . self::HEXDIG . '{1,4}|(' . self::HEXDIG . '{1,4}:)*' . self::HEXDIG . '{0,4})?' . self::HOST_IPV4_EMBEDDED . '\\]$'

Definition at line 88 of file URI.php.

◆ HOST_IPV6_LONG

const ILIAS\Data\URI::HOST_IPV6_LONG = '^\\[' . self::IPV6_COUNT_COLONS . '{7}' . self::HEXDIG . '{1,4}\\]$'

private

Definition at line 78 of file URI.php.

◆ HOST_IPV6_SHORT

const ILIAS\Data\URI::HOST_IPV6_SHORT

private

Initial value:

= '^\\[(?=' . self::IPV6_COLONS_BETWEEN . '{2,7}\\]$)' . 
        self::IPV6_LEFT_SHORT . '::' .
        
        '(' . self::HEXDIG . '{1,4}|(' . self::HEXDIG . '{1,4}:)*' . self::HEXDIG . '{1,4})?\\]$'

Definition at line 80 of file URI.php.

◆ HOST_REG_NAME

const ILIAS\Data\URI::HOST_REG_NAME = '^' . self::DOMAIN_LABEL . '(\\.' . self::DOMAIN_LABEL . ')*$'

private

Definition at line 68 of file URI.php.

◆ IPV6_COLONS_BETWEEN

const ILIAS\Data\URI::IPV6_COLONS_BETWEEN = '(' . self::HEXDIG . '{0,4}:' . self::HEXDIG . '{0,4})'

private

Definition at line 73 of file URI.php.

◆ IPV6_COUNT_COLONS

const ILIAS\Data\URI::IPV6_COUNT_COLONS = '(' . self::HEXDIG . '{1,4}:)'

private

Definition at line 72 of file URI.php.

◆ IPV6_LEFT_SHORT

const ILIAS\Data\URI::IPV6_LEFT_SHORT = '(' . self::HEXDIG . '{1,4}|' . self::HEXDIG . '{1,4}(:' . self::HEXDIG . '{1,4})*)?'

private

Definition at line 74 of file URI.php.

◆ PATH

const ILIAS\Data\URI::PATH = '#^(?!//)(?!:)(' . self::PCHAR . '|' . self::PATH_DELIM . ')+$#'

private

Definition at line 99 of file URI.php.

◆ PATH_DELIM

const ILIAS\Data\URI::PATH_DELIM = '/'

private

Definition at line 36 of file URI.php.

◆ PCHAR

const ILIAS\Data\URI::PCHAR = self::UNRESERVED . '|' . self::SUBDELIMS . '|' . self::PCTENCODED

private

Definition at line 64 of file URI.php.

◆ PCTENCODED

const ILIAS\Data\URI::PCTENCODED = '%' . self::HEXDIG . self::HEXDIG

private

Definition at line 45 of file URI.php.

◆ PIMP

const ILIAS\Data\URI::PIMP = '[\\+\\-\\.]'

private

point|minus|plus to be used in schema.

Definition at line 49 of file URI.php.

◆ PORT

const ILIAS\Data\URI::PORT = '#^' . self::DIGIT . '+$#'

private

Definition at line 98 of file URI.php.

◆ QUERY

const ILIAS\Data\URI::QUERY = '#^(' . self::PCHAR . '|' . self::PATH_DELIM . '|\\?)+$#'

private

Definition at line 100 of file URI.php.

◆ SCHEMA

const ILIAS\Data\URI::SCHEMA = '#^' . self::ALPHA . '(' . self::ALPHA_DIGIT . '|' . self::PIMP . ')*$#'

private

Definition at line 66 of file URI.php.

◆ SUBDELIMS

const ILIAS\Data\URI::SUBDELIMS = '[\\$,;=!&\'\\‍(\\‍)\\*\\+]'

private

valid subdelims according to RFC 3986 Appendix 1: "!" "$" "&" "'" "(" ")" "*" "+" "," ";" "="

Definition at line 55 of file URI.php.

◆ UNRESERVED

const ILIAS\Data\URI::UNRESERVED = self::ALPHA_DIGIT . '|[\\-\\._~]'

private

Definition at line 61 of file URI.php.

◆ UNRESERVED_NO_DOT

const ILIAS\Data\URI::UNRESERVED_NO_DOT = self::ALPHA_DIGIT . '|[\\-_~]'

private

Definition at line 62 of file URI.php.

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

components/ILIAS/Data/src/URI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ checkCorrectFormatOrThrow()

◆ digestFragment()

◆ digestHost()

◆ digestPath()

◆ digestPort()

◆ digestQuery()

◆ digestSchema()

◆ getAuthority()

◆ getBaseURI()

◆ getFragment()

◆ getHost()

◆ getParameter()

◆ getParameters()

◆ getPath()

◆ getPort()

◆ getQuery()

◆ getSchema()

◆ withAuthority()

◆ withFragment()

◆ withHost()

◆ withParameter()

◆ withParameters()

◆ withPath()

◆ withPort()

◆ withQuery()

◆ withSchema()

Field Documentation

◆ $fragment

◆ $host

◆ $path

◆ $port

◆ $query

◆ $schema

◆ ALPHA

◆ ALPHA_DIGIT

◆ BASEURI_SUBDELIMS

◆ DIGIT

◆ DOMAIN_LABEL

◆ FRAGMENT

◆ HEXDIG

◆ HOST

◆ HOST_IPV4

◆ HOST_IPV4_EMBEDDED

◆ HOST_IPV6

◆ HOST_IPV6_EMBEDDED_IPV4

◆ HOST_IPV6_EMBEDDED_IPV4_LONG

◆ HOST_IPV6_EMBEDDED_IPV4_SHORT

◆ HOST_IPV6_LONG

◆ HOST_IPV6_SHORT

◆ HOST_REG_NAME

◆ IPV6_COLONS_BETWEEN

◆ IPV6_COUNT_COLONS

◆ IPV6_LEFT_SHORT

◆ PATH

◆ PATH_DELIM

◆ PCHAR

◆ PCTENCODED

◆ PIMP

◆ PORT

◆ QUERY

◆ SCHEMA

◆ SUBDELIMS

◆ UNRESERVED

◆ UNRESERVED_NO_DOT