MediaWiki\Extension\OATHAuth\Module\TOTP Class Reference

Inheritance diagram for MediaWiki\Extension\OATHAuth\Module\TOTP:

Collaboration diagram for MediaWiki\Extension\OATHAuth\Module\TOTP:

Public Member Functions
	getConfig ()
	getDataFromUser (OATHUser $user)
	getDescriptionMessage ()
	Return Message object for the short text to be displayed as description. Returns Message More...
	getDisableWarningMessage ()
	Module-specific text that will be shown when user is disabling the module, to warn of data-loss.This will be shown alongside generic warning message. Returns Message|null if no additional text is needed More...
	getDisplayName ()
	getManageForm ( $action, OATHUser $user, OATHUserRepository $repo)
	getName ()
	Name of the module. More...
	getSecondaryAuthProvider ()
	isEnabled (OATHUser $user)
	Is this module currently enabled for the given user. More...
	newKey (array $data)
	verify (OATHUser $user, array $data)

Static Public Member Functions
static	factory ()

Detailed Description

Definition at line 18 of file TOTP.php.

Member Function Documentation

factory()

static MediaWiki\Extension\OATHAuth\Module\TOTP::factory ( )

static

Definition at line 19 of file TOTP.php.

getConfig()

MediaWiki\Extension\OATHAuth\Module\TOTP::getConfig

(

)

Definition at line 121 of file TOTP.php.

getDataFromUser()

MediaWiki\Extension\OATHAuth\Module\TOTP::getDataFromUser

(

OATHUser

$user

)

Parameters

OATHUser

$user

Returns

array

Exceptions

MWException

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 57 of file TOTP.php.

References MediaWiki\Extension\OATHAuth\OATHUser\getFirstKey().

getDescriptionMessage()

MediaWiki\Extension\OATHAuth\Module\TOTP::getDescriptionMessage

(

)

Return Message object for the short text to be displayed as description.

Returns

Message

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 128 of file TOTP.php.

References wfMessage().

getDisableWarningMessage()

MediaWiki\Extension\OATHAuth\Module\TOTP::getDisableWarningMessage

(

)

Module-specific text that will be shown when user is disabling the module, to warn of data-loss.This will be shown alongside generic warning message.

Returns

Message|null if no additional text is needed

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 135 of file TOTP.php.

References wfMessage().

getDisplayName()

MediaWiki\Extension\OATHAuth\Module\TOTP::getDisplayName

(

)

Returns

Message

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 31 of file TOTP.php.

References wfMessage().

getManageForm()

MediaWiki\Extension\OATHAuth\Module\TOTP::getManageForm	(		$action,
		OATHUser	$user,
		OATHUserRepository	$repo
	)

Parameters

string	$action
OATHUser	$user
OATHUserRepository	$repo

Returns

IManageForm|null

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 107 of file TOTP.php.

References MediaWiki\$action, MediaWiki\Extension\OATHAuth\Special\OATHManage\ACTION_DISABLE, MediaWiki\Extension\OATHAuth\Special\OATHManage\ACTION_ENABLE, and MediaWiki\Extension\OATHAuth\OATHUser\getModule().

getName()

MediaWiki\Extension\OATHAuth\Module\TOTP::getName

(

)

Name of the module.

Returns

string

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 27 of file TOTP.php.

getSecondaryAuthProvider()

MediaWiki\Extension\OATHAuth\Module\TOTP::getSecondaryAuthProvider

(

)

Returns

SecondaryAuthenticationProvider

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 70 of file TOTP.php.

isEnabled()

MediaWiki\Extension\OATHAuth\Module\TOTP::isEnabled

(

OATHUser

$user

)

Is this module currently enabled for the given user.

Parameters

OATHUser

$user

Returns

bool

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 97 of file TOTP.php.

References MediaWiki\Extension\OATHAuth\OATHUser\getFirstKey().

newKey()

MediaWiki\Extension\OATHAuth\Module\TOTP::newKey

(

array

$data

)

Parameters

array

$data

Returns

IAuthKey

Exceptions

MWException

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 41 of file TOTP.php.

References MediaWiki\Extension\OATHAuth\Key\TOTPKey\newFromArray().

verify()

MediaWiki\Extension\OATHAuth\Module\TOTP::verify	(	OATHUser	$user,
		array	$data
	)

Parameters

OATHUser	$user
array	$data

Returns

bool|int

Exceptions

MWException

Implements MediaWiki\Extension\OATHAuth\IModule.

Definition at line 80 of file TOTP.php.

References MediaWiki\Extension\OATHAuth\OATHUser\getFirstKey().

---

The documentation for this class was generated from the following file:

• extensions/OATHAuth/src/Module/TOTP.php