TokenStorageInterface Interface Reference

Inheritance diagram for TokenStorageInterface:

Public Member Functions
	get (string $id)
	Reads a stored CSRF token.
	set (string $id, string $token)
	Stores a CSRF token.
	remove (string $id)
	Removes a CSRF token.
	exists (string $id)
	Checks whether a token with the given token ID exists.

Detailed Description

Definition at line 4 of file TokenStorageInterface.php.

Member Function Documentation

exists()

exists

(

string

$id

)

Checks whether a token with the given token ID exists.

Returns

bool Whether a token exists with the given ID

Implemented in SessionTokenStorage.

get()

get

(

string

$id

)

Reads a stored CSRF token.

Returns

string The stored token

Implemented in SessionTokenStorage.

remove()

remove

(

string

$id

)

Removes a CSRF token.

Returns

string|null Returns the removed token if one existed, NULL otherwise

Implemented in SessionTokenStorage.

set()

set	(	string	$id,
		string	$token
	)

Stores a CSRF token.

Implemented in SessionTokenStorage.

---

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

• C:/Users/myadd/Documents/GitHub/ubiquity-doc-api/vendor/phpmv/ubiquity-security/src/Ubiquity/security/csrf/storages/TokenStorageInterface.php