Docs For Class PlgTwofactorauthTotp

Description

Joomla! Two Factor Authentication using Google Authenticator TOTP Plugin

since: 3.2

Located in /plugins/twofactorauth/totp/totp.php (line 19)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --PlgTwofactorauthTotp

Variable Summary

boolean $autoloadLanguage

string $methodName

Method Summary

PlgTwofactorauthTotp __construct (object &$subject, [array $config = array()])

boolean|stdClass onUserTwofactorApplyConfiguration (string $method)

boolean onUserTwofactorAuthenticate (array $credentials, array $options)

stdClass onUserTwofactorIdentify ()

boolean|string onUserTwofactorShowConfiguration (object $otpConfig, [integer $user_id = null])

Variables

boolean $autoloadLanguage = true (line 27)

Affects constructor behavior. If true, language files will be loaded automatically.

since: 3.2
access: protected

Redefinition of:

JPlugin::$autoloadLanguage: Affects constructor behavior. If true, language files will be loaded automatically.

string $methodName = 'totp' (line 35)

Method name

since: 3.2
access: protected

Inherited Variables

Inherited from JPlugin

JPlugin::$params
JPlugin::$_name
JPlugin::$_type

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 47)

Constructor

since: 3.2
access: public

PlgTwofactorauthTotp __construct (object &$subject, [array $config = array()])

object &$subject: The object to observe
array $config: An optional associative array of configuration settings. Recognized key values include 'name', 'group', 'params', 'language' (this list is not meant to be comprehensive).

Redefinition of:

JPlugin::__construct(): Constructor

onUserTwofactorApplyConfiguration (line 176)

The save handler of the two factor configuration method's configuration page.

return: False if the method doesn't match or we have an error, OTP config object if it succeeds
see: UsersModelUser::setOtpConfig
since: 3.2
access: public

boolean|stdClass onUserTwofactorApplyConfiguration (string $method)

string $method: The two factor auth method for which we'll show the config page

onUserTwofactorAuthenticate (line 266)

This method should handle any two factor authentication and report back to the subject.

return: True if the user is authorised with this two-factor authentication method
since: 3.2
access: public

boolean onUserTwofactorAuthenticate (array $credentials, array $options)

array $credentials: Array holding the user credentials
array $options: Array of extra options

onUserTwofactorIdentify (line 66)

This method returns the identification object for this two factor authentication plugin.

return: An object with public properties method and title
since: 3.2
access: public

stdClass onUserTwofactorIdentify ()

onUserTwofactorShowConfiguration (line 112)

Shows the configuration page for this two factor authentication method.

return: False if the method is not ours, the HTML of the configuration page otherwise
see: UsersModelUser::getOtpConfig
since: 3.2
access: public

boolean|string onUserTwofactorShowConfiguration (object $otpConfig, [integer $user_id = null])

object $otpConfig: The two factor auth configuration object
integer $user_id: The numeric user ID of the user whose form we'll display

Inherited Methods

Inherited From JPlugin

JPlugin::__construct()
JPlugin::loadLanguage()

Inherited From JEvent

JEvent::__construct()
JEvent::update()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()