TwoFactorPlugin
class TwoFactorPlugin (View source)
Two factor authentication plugin class
This is basic implementation which does no additional authentication, subclasses are expected to implement this.
Properties
| static string | $id | ||
| static bool | $showSubmit | Whether to show submit button in form |
|
| protected TwoFactor | $twofactor | ||
| protected bool | $provided | ||
| protected string | $message | ||
| Template | $template |
Methods
Returns authentication error message
Checks authentication, returns true on success
Renders user interface to enter two-factor authentication
Renders user interface to configure two-factor authentication
Performs backend configuration
Get user visible name
Get user visible description
Return an application ID
Details
__construct(TwoFactor $twofactor)
Creates object
string
getError()
Returns authentication error message
bool
check()
Checks authentication, returns true on success
string
render()
Renders user interface to enter two-factor authentication
string
setup()
Renders user interface to configure two-factor authentication
bool
configure()
Performs backend configuration
static string
getName()
Get user visible name
static string
getDescription()
Get user visible description
string
getAppId(bool $return_url)
Return an application ID
Either hostname or hostname with scheme.