Inheritance diagram for MediaWiki\Extension\OATHAuth\IModule:

Public Member Functions
	getDataFromUser (OATHUser $user)

	getDescriptionMessage ()
	Return Message object for the short text to be displayed as description. More...

	getDisableWarningMessage ()
	Module-specific text that will be shown when user is disabling the module, to warn of data-loss. 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 Arguably, module is enabled just by the fact its set on user but it might not be true for all future modules. More...

	newKey (array $data)

	verify (OATHUser $user, array $data)
	Run the validation. More...

Detailed Description

Definition at line 9 of file IModule.php.

Member Function Documentation

◆ getDataFromUser()

MediaWiki\Extension\OATHAuth\IModule::getDataFromUser ( OATHUser $user )

Parameters

OATHUser $user

Returns: array

Implemented in MediaWiki\Extension\OATHAuth\Module\TOTP.

◆ getDescriptionMessage()

MediaWiki\Extension\OATHAuth\IModule::getDescriptionMessage ( )

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

Returns: Message

Implemented in MediaWiki\Extension\OATHAuth\Module\TOTP.

Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\getGenericContent().

◆ getDisableWarningMessage()

MediaWiki\Extension\OATHAuth\IModule::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

Implemented in MediaWiki\Extension\OATHAuth\Module\TOTP.

◆ getDisplayName()

MediaWiki\Extension\OATHAuth\IModule::getDisplayName ( )

Returns: Message

Implemented in MediaWiki\Extension\OATHAuth\Module\TOTP.

Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\getGenericContent().

◆ getManageForm()

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

Parameters

string	$action
OATHUser	$user
OATHUserRepository	$repo

Returns: IManageForm|null if no form is available for given action

Implemented in MediaWiki\Extension\OATHAuth\Module\TOTP.

Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addCustomContent().

◆ getName()

MediaWiki\Extension\OATHAuth\IModule::getName ( )

Name of the module.

Returns: string

Implemented in MediaWiki\Extension\OATHAuth\Module\TOTP.

Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\ensureRequiredFormFields(), MediaWiki\Extension\OATHAuth\Special\OATHManage\getGenericContent(), MediaWiki\Extension\OATHAuth\Special\OATHManage\isModuleEnabled(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\isModuleRequested().

◆ getSecondaryAuthProvider()

MediaWiki\Extension\OATHAuth\IModule::getSecondaryAuthProvider ( )

Returns: SecondaryAuthenticationProvider

Implemented in MediaWiki\Extension\OATHAuth\Module\TOTP.

Referenced by MediaWiki\Extension\OATHAuth\Auth\SecondaryAuthenticationProvider\getProviderForModule().

◆ isEnabled()

MediaWiki\Extension\OATHAuth\IModule::isEnabled ( OATHUser $user )

Is this module currently enabled for the given user Arguably, module is enabled just by the fact its set on user but it might not be true for all future modules.

Parameters

OATHUser $user