Session based authentication storage.
This authentication storage uses the session to store the user identity and token.
This is the period in which the autologin cookie will remain active (ie: will expire after this many days). The default is one day.
This is the hash algorithm used to encrypt the token placed in the cookie in the user's browser session. This data is hashed to ensure that it can not be manipulated by the user.
The token hash is the value stored in the session cache and is used to confirm that a user account is authenticated. As an added security measure we apply a hash to this value so that plain test passwords will never be stored in the session cache, even if there is no password encryption chain.
For a standard login, this is the session expirey timeout. Basically this is the maximum time in which a session will ever be active. If autologin is being used, then it is quite common to set this to a low value to allow the user to be re-authenticated with the autologin token periodically.
public CacheAdapter $session
private array $blackListedBackends = array (
0 => 'apc',
)
public __construct(array $config): void
| Parameter | Type | Description |
|---|
$config | array | |
public write(array $data): void
| Parameter | Type | Description |
|---|
$data | array | |
public has(string $key): bool
| Parameter | Type | Description |
|---|
$key | string | |
public get(string $key): mixed
| Parameter | Type | Description |
|---|
$key | string | |
public set(string $key, mixed $value): void
| Parameter | Type | Description |
|---|
$key | string | |
$value | mixed | |
public (string $key): void
| Parameter | Type | Description |
|---|
$key | string | |
public refresh(string $token): ?string
| Parameter | Type | Description |
|---|
$token | string | |
private initSession(?string $sessionID): void
| Parameter | Type | Description |
|---|
$sessionID | string | |
Generated by Hazaar API Doc Generator on Wed, 07 Jan 2026 11:29:59 +0000