phpDocumentor

HubSessionKeyStorage
in package
implements HubSessionKeyStorageInterface

Class HubSessionKeyStorage

Tags
category

System

subpackage

Storages

Interfaces, Classes and Traits

HubSessionKeyStorageInterface
Interface HubSessionKeyRepositoryInterface

Table of Contents

$storageDirectoryPath  : string
__construct()  : mixed
HubSessionKeyStorage constructor.
_getFilename()  : string
Get storage filename for given authorization hash identifier.
findAndDeleteByAuthHash()  : HubSessionKey|null
Find the HubSessionKey in the filesystem and delete the file immediately.
store()  : HubSessionKeyStorage
Stores the HubSessionKey in the filesystem.

Properties

Methods

__construct()

HubSessionKeyStorage constructor.

public __construct(string $storageDirectoryPath) : mixed
Parameters
$storageDirectoryPath : string

The storage directory path where the session keys will be stored.

Tags
throws
InvalidArgumentException

If the storage directory path does not exist or is not writable.

Return values
mixed

_getFilename()

Get storage filename for given authorization hash identifier.

public _getFilename(AuthHash $authHash) : string
Parameters
$authHash : AuthHash

The hub session authorization identifier.

Return values
string

findAndDeleteByAuthHash()

Find the HubSessionKey in the filesystem and delete the file immediately.

public findAndDeleteByAuthHash(AuthHash $authHash) : HubSessionKey|null
Parameters
$authHash : AuthHash

The hub authorization hash identifier.

Return values
HubSessionKey|null

Returns a HubSessionKey instance or null if nothing was found.

store()

Stores the HubSessionKey in the filesystem.

public store(HubSessionKey $hubSessionKey, AuthHash $authHash) : HubSessionKeyStorage
Parameters
$hubSessionKey : HubSessionKey

The session key to be stored.

$authHash : AuthHash

The authorization hash identifier.

Return values
HubSessionKeyStorage

Returns same class instance for chained method calls.

Search results