ilCtrlToken Class Reference

Class ilCtrlToken is responsible for generating and storing unique CSRF tokens. More...

Inheritance diagram for ilCtrlToken:

Collaboration diagram for ilCtrlToken:

Public Member Functions
	__construct (string $token)
	ilCtrlToken Constructor More...
	verifyWith (string $token)
	@inheritDoc More...
	getToken ()
	@inheritDoc More...
	verifyWith (string $token)
	Compares the given token to the stored one of the given user. More...
	getToken ()
	Returns the token string of this instance. More...

Private Attributes
string	$token

Detailed Description

Class ilCtrlToken is responsible for generating and storing unique CSRF tokens.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 13 of file class.ilCtrlToken.php.

Constructor & Destructor Documentation

__construct()

ilCtrlToken::__construct

(

string

$token

)

ilCtrlToken Constructor

Parameters

string

$token

Definition at line 27 of file class.ilCtrlToken.php.

    {
        $this->token = $token;
    }

References $token.

Member Function Documentation

getToken()

ilCtrlToken::getToken

(

)

@inheritDoc

Implements ilCtrlTokenInterface.

Definition at line 43 of file class.ilCtrlToken.php.

                              : string
    {
        return $this->token;
    }

References $token.

verifyWith()

ilCtrlToken::verifyWith

(

string

$token

)

@inheritDoc

Implements ilCtrlTokenInterface.

Definition at line 35 of file class.ilCtrlToken.php.

                                             : bool
    {
        return ($this->token === $token);
    }

References $token.

Field Documentation

$token

string ilCtrlToken::$token

private

Definition at line 20 of file class.ilCtrlToken.php.

Referenced by __construct(), getToken(), and verifyWith().

---

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

• Services/UICore/classes/Token/class.ilCtrlToken.php