phpDocumentor

HubAuthStorage
in package
implements HubAuthStorageInterface

Class HubAuthStorage

Performs the filesystem operations for the HubAuthService.

Tags
category

System

subpackage

Storages

Interfaces, Classes and Traits

HubAuthStorageInterface
Interface HubSessionKeyRepositoryInterface

Table of Contents

$storageDirectoryPath  : string
__construct()  : mixed
HubAuthStorage constructor.
removeAuthHashFile()  : HubAuthStorageInterface
Remove authentication hash file from filesystem.
verifyAuthHashFile()  : bool
Verify that an authentication hash file exists in the cache directory.

Properties

Methods

__construct()

HubAuthStorage constructor.

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

The storage directory path where the authentication files are stored.

Tags
throws
InvalidArgumentException

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

Return values
mixed

removeAuthHashFile()

Remove authentication hash file from filesystem.

public removeAuthHashFile(AuthHash $authHash) : HubAuthStorageInterface
Parameters
$authHash : AuthHash

The authentication hash to be removed.

Tags
throws
InvalidArgumentException

If the authentication file does not exist.

Return values
HubAuthStorageInterface

Returns same instance for chained method calls.

verifyAuthHashFile()

Verify that an authentication hash file exists in the cache directory.

public verifyAuthHashFile(AuthHash $authHash) : bool
Parameters
$authHash : AuthHash

The authentication hash to be verified.

Return values
bool

Returns the verification result.

Search results