Référence de la classe PlgTwofactorauthTotp

Graphe d'héritage de PlgTwofactorauthTotp:

Fonctions membres publiques
	onUserTwofactorIdentify ()
	onUserTwofactorShowConfiguration ($otpConfig, $userId=null)
	onUserTwofactorApplyConfiguration ($method)
	onUserTwofactorAuthenticate ($credentials, $options)

Attributs protégés
	$autoloadLanguage = true
	$methodName = 'totp'

Description détaillée

Joomla! Two Factor Authentication using Google Authenticator TOTP Plugin

Depuis

3.2

Documentation des fonctions membres

onUserTwofactorApplyConfiguration()

onUserTwofactorApplyConfiguration

(

$method

)

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

Paramètres

string

$method

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

Renvoie

boolean|stdClass False if the method doesn't match or we have an error, OTP config object if it succeeds

Voir également

UsersModelUser::setOtpConfig

Depuis

3.2

Références $app, $check, $data, et $input.

onUserTwofactorAuthenticate()

onUserTwofactorAuthenticate	(		$credentials,
			$options
	)

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

Paramètres

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

Renvoie

boolean True if the user is authorised with this two-factor authentication method

Depuis

3.2

Références $check, et $options.

onUserTwofactorIdentify()

onUserTwofactorIdentify

(

)

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

Renvoie

stdClass An object with public properties method and title

Depuis

3.2

Références $app, $section, et elseif.

onUserTwofactorShowConfiguration()

onUserTwofactorShowConfiguration	(		$otpConfig,
			$userId = null
	)

Shows the configuration page for this two factor authentication method.

Paramètres

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

Renvoie

boolean|string False if the method is not ours, the HTML of the configuration page otherwise

Voir également

UsersModelUser::getOtpConfig

Depuis

3.2

Références $html, $path, $url, $userId, FOFPlatform\getInstance(), et JLoader\import().

Documentation des champs

$autoloadLanguage

$autoloadLanguage = true

protected

$methodName

$methodName = 'totp'

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• plugins/twofactorauth/totp/totp.php