AuthSafetyFileStorage
in package
Class representing a safety file storage
Table of Contents
- FILE_NAME_TEMPLATE = '2fa-{CUSTOMER_ID}'
- File name template
- $directoryPath : string
- Path to directory
- __construct() : mixed
- Create instance
- createFileForCustomer() : $this
- Create safety file for provided customer ID
- fileExistenceForCustomer() : bool
- Return whether the safety file exists
- removeFileForCustomer() : $this
- Remove safety file for provided customer ID
- filePathForCustomer() : string
- Return the substituted file path for the provided customer ID
Constants
FILE_NAME_TEMPLATE
File name template
public
mixed
FILE_NAME_TEMPLATE
= '2fa-{CUSTOMER_ID}'
Properties
$directoryPath
Path to directory
protected
string
$directoryPath
Methods
__construct()
Create instance
public
__construct(NonEmptyStringType $directory) : mixed
Parameters
- $directory : NonEmptyStringType
-
Path to directory
Tags
Return values
mixed —createFileForCustomer()
Create safety file for provided customer ID
public
createFileForCustomer(IdType $customerId) : $this
Parameters
- $customerId : IdType
-
Customer ID
Return values
$this —Same instance
fileExistenceForCustomer()
Return whether the safety file exists
public
fileExistenceForCustomer(IdType $customerId) : bool
Parameters
- $customerId : IdType
-
Customer ID
Return values
bool —Whether the safety file exists
removeFileForCustomer()
Remove safety file for provided customer ID
public
removeFileForCustomer(IdType $customerId) : $this
Parameters
- $customerId : IdType
-
Customer ID
Return values
$this —Same instance
filePathForCustomer()
Return the substituted file path for the provided customer ID
protected
filePathForCustomer(IdType $customerId) : string
Parameters
- $customerId : IdType
-
Customer ID
Return values
string —Substituted file path