Page MenuHomeWickedGov Phorge
Files F4129426

IModule.php
No OneTemporary
Actions

Size
1 KB
Referenced Files
None
Subscribers
None

IModule.php
View Options

<?php
namespace MediaWiki\Extension\OATHAuth;
use MediaWiki\Auth\AbstractSecondaryAuthenticationProvider;
use MediaWiki\Context\IContextSource;
use MediaWiki\Extension\OATHAuth\HTMLForm\IManageForm;
use MediaWiki\Message\Message;
interface IModule {
/**
* Name of the module, as declared in the OATHAuth.Modules extension.json attribute.
*
* @return string
*/
public function getName();
/**
* @return Message
*/
public function getDisplayName();
/**
* @param array $data
* @return IAuthKey
*/
public function newKey( array $data );
/**
* @return AbstractSecondaryAuthenticationProvider
*/
public function getSecondaryAuthProvider();
/**
* 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
*
* @param OATHUser $user
* @return bool
*/
public function isEnabled( OATHUser $user );
/**
* Run the validation
*
* @param OATHUser $user
* @param array $data
* @return bool
*/
public function verify( OATHUser $user, array $data );
/**
* @param string $action
* @param OATHUser $user
* @param OATHUserRepository $repo
* @param IContextSource $context
* @return IManageForm|null if no form is available for given action
*/
public function getManageForm(
$action,
OATHUser $user,
OATHUserRepository $repo,
IContextSource $context
);
/**
* Return Message object for the short text to be displayed as description
*
* @return Message
*/
public function getDescriptionMessage();
/**
* Module-specific text that will be shown when the user is disabling
* the module, to warn of data-loss.
* This will be shown alongside the generic warning message.
*
* @return Message|null if no additional text is needed
*/
public function getDisableWarningMessage();
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 09:53 (2 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b6/52/5e44d80e6582076c5483550a2efe
Default Alt Text
IModule.php (1 KB)

Event Timeline