Base
in package
Table of Contents
Properties
- $userID : int|null
Methods
- __construct() : mixed
- classIsAvailable() : string|null
- Checks if a given token is an enabled MFA class, and returns the fully qualified class name (or NULL)
- classIsMFA() : string|null
- Does the class exist on the system.
- clearPendingLogin() : mixed
- getAvailableClasses() : array<string|int, mixed>
- Returns an array of fully qualified or short class names that are available.
- getMFAclasses() : array<string|int, mixed>
- This is the options callback for the standalone_mfa_enabled setting.
- getPendingLogin() : array<string|int, mixed>|null
- Fetch the array of pending login data (userID, expiry, ...) if it exists and has not expired.
- updatePendingLogin() : array<string|int, mixed>
Properties
$userID
public
int|null
$userID
Methods
__construct()
public
__construct(int $userID) : mixed
Parameters
- $userID : int
classIsAvailable()
Checks if a given token is an enabled MFA class, and returns the fully qualified class name (or NULL)
public
static classIsAvailable(string $shortClassName) : string|null
Parameters
- $shortClassName : string
Return values
string|nullclassIsMFA()
Does the class exist on the system.
public
static classIsMFA(string $shortClassName) : string|null
Parameters
- $shortClassName : string
Return values
string|nullclearPendingLogin()
public
clearPendingLogin() : mixed
getAvailableClasses()
Returns an array of fully qualified or short class names that are available.
public
static getAvailableClasses([bool $short = FALSE ]) : array<string|int, mixed>
Available here means:
- is configured in settings as available to users
- is actually an MFA class.
Parameters
- $short : bool = FALSE
Return values
array<string|int, mixed>getMFAclasses()
This is the options callback for the standalone_mfa_enabled setting.
public
static getMFAclasses() : array<string|int, mixed>
Return values
array<string|int, mixed>getPendingLogin()
Fetch the array of pending login data (userID, expiry, ...) if it exists and has not expired.
public
static getPendingLogin() : array<string|int, mixed>|null
If it's expired, drop it from the session.
Return values
array<string|int, mixed>|nullupdatePendingLogin()
public
updatePendingLogin(array<string|int, mixed> $changes) : array<string|int, mixed>
Parameters
- $changes : array<string|int, mixed>