TokenManager
in package
Table of Contents
Properties
- $defaultKey : string
- $storage : array<string|int, mixed>
Methods
- __construct() : mixed
- Constructor.
- generateToken() : string
- Generate a new token and store it in the storage.
- getToken() : string|null
- Get the stored token.
- invalidateToken() : void
- Invalidate a stored token.
- validateToken() : bool
- Validate a token against the stored token.
Properties
$defaultKey
private
string
$defaultKey
$storage
private
array<string|int, mixed>
$storage
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $storage = null ][, string $defaultKey = 'security_token' ]) : mixed
Parameters
- $storage : array<string|int, mixed> = null
-
The storage mechanism (e.g.,
$_SESSIONor custom storage). - $defaultKey : string = 'security_token'
-
The default key used for token storage.
generateToken()
Generate a new token and store it in the storage.
public
generateToken([string|null $key = null ]) : string
Parameters
- $key : string|null = null
-
Optional storage key. Uses default if not provided.
Return values
string —The generated token.
getToken()
Get the stored token.
public
getToken([string|null $key = null ]) : string|null
Parameters
- $key : string|null = null
-
Optional storage key. Uses default if not provided.
Return values
string|null —The token or null if not set.
invalidateToken()
Invalidate a stored token.
public
invalidateToken([string|null $key = null ]) : void
Parameters
- $key : string|null = null
-
Optional storage key. Uses default if not provided.
validateToken()
Validate a token against the stored token.
public
validateToken(string $token[, string|null $key = null ]) : bool
Parameters
- $token : string
-
The token to validate.
- $key : string|null = null
-
Optional storage key. Uses default if not provided.
Return values
bool —True if valid, false otherwise.