ILIAS\UI\URLBuilderToken Class Reference

URLBuilderToken. More...

Collaboration diagram for ILIAS\UI\URLBuilderToken:

Public Member Functions
	__construct (array $namespace, string $name)
	getToken ()
	Get the token hash value. More...
	getName ()
	Get the full name of the token including its namespace. More...
	__toString ()
	render ()
	Output the JS equivalent of the token as a string. More...

Data Fields
const	TOKEN_LENGTH = 24

Private Member Functions
	createToken ()
	Creates a randomized string of length URLBuilderToken::TOKEN_LENGTH generated by the random_bytes() function md5() is used as a fallback on systems that don't support random_bytes() More...

Private Attributes
array	$namespace
string	$name
string	$token

Detailed Description

URLBuilderToken.

This is a token used by Data/URLBuilder to control usage of URL parameters. See URLBuilder interface for more details.

Definition at line 29 of file URLBuilderToken.php.

Constructor & Destructor Documentation

__construct()

ILIAS\UI\URLBuilderToken::__construct	(	array	$namespace,
		string	$name
	)

Definition at line 36 of file URLBuilderToken.php.

References ILIAS\UI\URLBuilderToken\$name, and ILIAS\UI\URLBuilderToken\createToken().

    {
        $this->namespace = $namespace;
        $this->name = $name;
        $this->token = $this->createToken();
    }

Here is the call graph for this function:

Member Function Documentation

__toString()

ILIAS\UI\URLBuilderToken::__toString

(

)

Definition at line 60 of file URLBuilderToken.php.

References ILIAS\UI\URLBuilderToken\getName().

                                : string
    {
        return $this->getName();
    }

Here is the call graph for this function:

createToken()

ILIAS\UI\URLBuilderToken::createToken ( )

private

Creates a randomized string of length URLBuilderToken::TOKEN_LENGTH generated by the random_bytes() function md5() is used as a fallback on systems that don't support random_bytes()

Definition at line 70 of file URLBuilderToken.php.

References ILIAS\UI\URLBuilderToken\$token.

Referenced by ILIAS\UI\URLBuilderToken\__construct().

                                  : string
    {
        try {
            $token = bin2hex(random_bytes(self::TOKEN_LENGTH / 2));
        } catch (\Throwable $t) {
            $token = md5(uniqid((string) time(), true));
            $token = substr($token, 0, self::TOKEN_LENGTH);
        }
        return $token;
    }

Here is the caller graph for this function:

getName()

ILIAS\UI\URLBuilderToken::getName

(

)

Get the full name of the token including its namespace.

Definition at line 55 of file URLBuilderToken.php.

References ILIAS\UI\URLBuilderToken\$name, and ILIAS\UI\URLBuilder\SEPARATOR.

Referenced by ILIAS\UI\URLBuilderToken\__toString(), ILIAS\UI\URLBuilder\checkToken(), ILIAS\UI\URLBuilder\deleteParameter(), and ILIAS\UI\URLBuilder\withParameter().

                             : string
    {
        return implode(URLBuilder::SEPARATOR, $this->namespace) . URLBuilder::SEPARATOR . $this->name;
    }

Here is the caller graph for this function:

getToken()

ILIAS\UI\URLBuilderToken::getToken

(

)

Get the token hash value.

Definition at line 46 of file URLBuilderToken.php.

References ILIAS\UI\URLBuilderToken\$token.

Referenced by ILIAS\UI\URLBuilder\checkToken().

                              : string
    {
        return $this->token;
    }

Here is the caller graph for this function:

render()

ILIAS\UI\URLBuilderToken::render

(

)

Output the JS equivalent of the token as a string.

Used by the URLBuilder renderer.

Definition at line 85 of file URLBuilderToken.php.

                            : string
    {
        $namespace = [];
        foreach ($this->namespace as $name) {
            $namespace[] = '"' . $name . '"';
        }
        $output = 'new il.UI.core.URLBuilderToken([' . implode(',', $namespace) . '], "' . $this->name . '", "' . $this->token . '")';
        return $output;
    }

Field Documentation

$name

string ILIAS\UI\URLBuilderToken::$name

private

Definition at line 33 of file URLBuilderToken.php.

Referenced by ILIAS\UI\URLBuilderToken\__construct(), and ILIAS\UI\URLBuilderToken\getName().

$namespace

array ILIAS\UI\URLBuilderToken::$namespace

private

Definition at line 32 of file URLBuilderToken.php.

$token

string ILIAS\UI\URLBuilderToken::$token

private

Definition at line 34 of file URLBuilderToken.php.

Referenced by ILIAS\UI\URLBuilderToken\createToken(), and ILIAS\UI\URLBuilderToken\getToken().

TOKEN_LENGTH

const ILIAS\UI\URLBuilderToken::TOKEN_LENGTH = 24

Definition at line 31 of file URLBuilderToken.php.

Referenced by ILIAS\UI\URLBuilderTokenTest\testTokenLength().

---

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

• src/UI/URLBuilderToken.php