MediaWiki
1.34.0
|
Public Member Functions | |
__construct () | |
Initializes a page to manage available 2FA modules. More... | |
checkPermissions () | |
execute ( $subPage) | |
Public Member Functions inherited from SpecialPage | |
__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false) | |
Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More... | |
addHelpLink ( $to, $overrideBaseUrl=false) | |
Adds help link with an icon via page indicators. More... | |
checkReadOnly () | |
If the wiki is currently in readonly mode, throws a ReadOnlyError. More... | |
displayRestrictionError () | |
Output an error message telling the user what access level they have to have. More... | |
doesWrites () | |
Indicates whether this special page may perform database writes. More... | |
getConfig () | |
Shortcut to get main config object. More... | |
getContext () | |
Gets the context this SpecialPage is executed in. More... | |
getDescription () | |
Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More... | |
getFinalGroupName () | |
Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More... | |
getFullTitle () | |
Return the full title, including $par. More... | |
getLanguage () | |
Shortcut to get user's language. More... | |
getLinkRenderer () | |
getLocalName () | |
Get the localised name of the special page. More... | |
getName () | |
Get the name of this Special Page. More... | |
getOutput () | |
Get the OutputPage being used for this instance. More... | |
getPageTitle ( $subpage=false) | |
Get a self-referential title object. More... | |
getRequest () | |
Get the WebRequest being used for this instance. More... | |
getRestriction () | |
Get the permission that a user must have to execute this page. More... | |
getSkin () | |
Shortcut to get the skin being used for this instance. More... | |
getUser () | |
Shortcut to get the User executing this instance. More... | |
including ( $x=null) | |
Whether the special page is being evaluated via transclusion. More... | |
isCached () | |
Is this page cached? Expensive pages are cached or disabled in miser mode. More... | |
isExpensive () | |
Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More... | |
isIncludable () | |
Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More... | |
isListed () | |
Whether this special page is listed in Special:SpecialPages. More... | |
isRestricted () | |
Can be overridden by subclasses with more complicated permissions schemes. More... | |
listed ( $x=null) | |
Get or set whether this special page is listed in Special:SpecialPages. More... | |
maxIncludeCacheTime () | |
How long to cache page when it is being included. More... | |
msg ( $key,... $params) | |
Wrapper around wfMessage that sets the current context. More... | |
outputHeader ( $summaryMessageKey='') | |
Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More... | |
prefixSearchSubpages ( $search, $limit, $offset) | |
Return an array of subpages beginning with $search that this special page will accept. More... | |
requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin') | |
If the user is not logged in, throws UserNotLoggedIn error. More... | |
run ( $subPage) | |
Entry point. More... | |
setContext ( $context) | |
Sets the context this SpecialPage is executed in. More... | |
setHeaders () | |
Sets headers - this should be called from the execute() method of all derived classes! More... | |
setLinkRenderer (LinkRenderer $linkRenderer) | |
setListed ( $listed) | |
Set whether this page is listed in Special:Specialpages, at run-time. More... | |
userCanExecute (User $user) | |
Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More... | |
Public Attributes | |
const | ACTION_DISABLE = 'disable' |
const | ACTION_ENABLE = 'enable' |
Protected Attributes | |
string | $action |
OATHAuth | $auth |
OATHUser | $authUser |
IModule | $requestedModule |
OATHUserRepository | $userRepo |
Protected Attributes inherited from SpecialPage | |
IContextSource | $mContext |
Current request context. More... | |
$mIncludable | |
$mIncluding | |
$mName | |
$mRestriction | |
Private Member Functions | |
addAlternativesHTML () | |
addCustomContent (IModule $module, $panel=null) | |
addEnabledHTML () | |
addGeneralHelp () | |
addHeading (Message $message) | |
addInactiveHTML () | |
addModuleHTML (IModule $module) | |
clearPage () | |
When performing an action on a module (like enable/disable), page should contain only form for that action. More... | |
ensureRequiredFormFields (IManageForm &$form, IModule $module) | |
getEnabled () | |
getGenericContent (IModule $module) | |
Get the panel with generic content for a module. More... | |
hasAlternativeModules () | |
hasEnabled () | |
isGenericAction () | |
Actions enable and disable are generic and all modules must implement them, while all other actions are module-specific. More... | |
isModuleEnabled (IModule $module) | |
isModuleRequested (IModule $module) | |
isSwitch () | |
isValidFormType ( $form) | |
Checks if given form instance fulfills required conditions. More... | |
nothingEnabled () | |
setAction () | |
setModule () | |
shouldShowDisableWarning () | |
shouldShowGenericButtons () | |
showDisableWarning () | |
Additional Inherited Members | |
Static Public Member Functions inherited from SpecialPage | |
static | getSafeTitleFor ( $name, $subpage=false) |
Get a localised Title object for a page name with a possibly unvalidated subpage. More... | |
static | getTitleFor ( $name, $subpage=false, $fragment='') |
Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More... | |
static | getTitleValueFor ( $name, $subpage=false, $fragment='') |
Get a localised TitleValue object for a specified special page name. More... | |
Protected Member Functions inherited from SpecialPage | |
addFeedLinks ( $params) | |
Adds RSS/atom links. More... | |
afterExecute ( $subPage) | |
Gets called after. More... | |
beforeExecute ( $subPage) | |
Gets called before. More... | |
buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false) | |
Generate (prev x| next x) (20|50|100...) type links for paging. More... | |
checkLoginSecurityLevel ( $level=null) | |
Verifies that the user meets the security level, possibly reauthenticating them in the process. More... | |
getCacheTTL () | |
getGroupName () | |
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More... | |
getLoginSecurityLevel () | |
Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More... | |
getRobotPolicy () | |
Return the robot policy. More... | |
getSubpagesForPrefixSearch () | |
Return an array of subpages that this special page will accept for prefix searches. More... | |
prefixSearchString ( $search, $limit, $offset) | |
Perform a regular substring search for prefixSearchSubpages. More... | |
setReauthPostData (array $data) | |
Record preserved POST data after a reauthentication. More... | |
useTransactionalTimeLimit () | |
Call wfTransactionalTimeLimit() if this request was POSTed. More... | |
Static Protected Member Functions inherited from SpecialPage | |
static | prefixSearchArray ( $search, $limit, array $subpages, $offset) |
Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More... | |
Definition at line 42 of file OATHManage.php.
MediaWiki\Extension\OATHAuth\Special\OATHManage::__construct | ( | ) |
Initializes a page to manage available 2FA modules.
ConfigException | |
MWException |
Definition at line 73 of file OATHManage.php.
References MediaWiki\MediaWikiServices\getInstance(), and SpecialPage\getUser().
|
private |
Definition at line 159 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\addHeading(), MediaWiki\Extension\OATHAuth\Special\OATHManage\addInactiveHTML(), and wfMessage().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
private |
IModule | $module | |
PanelLayout | null | $panel |
Definition at line 241 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\ensureRequiredFormFields(), MediaWiki\Extension\OATHAuth\IModule\getManageForm(), SpecialPage\getOutput(), MediaWiki\getTitle(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\isValidFormType().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addModuleHTML().
|
private |
Definition at line 154 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\addHeading(), MediaWiki\Extension\OATHAuth\Special\OATHManage\addModuleHTML(), MediaWiki\Extension\OATHAuth\Special\OATHManage\getEnabled(), and wfMessage().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
private |
Definition at line 178 of file OATHManage.php.
References SpecialPage\getOutput(), and wfMessage().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
private |
Definition at line 254 of file OATHManage.php.
References SpecialPage\getOutput().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addAlternativesHTML(), MediaWiki\Extension\OATHAuth\Special\OATHManage\addEnabledHTML(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\nothingEnabled().
|
private |
Definition at line 169 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\addModuleHTML(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\isModuleEnabled().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addAlternativesHTML(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\nothingEnabled().
|
private |
Definition at line 184 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\addCustomContent(), MediaWiki\Extension\OATHAuth\Special\OATHManage\getGenericContent(), SpecialPage\getOutput(), MediaWiki\Extension\OATHAuth\Special\OATHManage\isModuleEnabled(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\isModuleRequested().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addEnabledHTML(), MediaWiki\Extension\OATHAuth\Special\OATHManage\addInactiveHTML(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
MediaWiki\Extension\OATHAuth\Special\OATHManage::checkPermissions | ( | ) |
PermissionsError | |
UserNotLoggedIn |
Reimplemented from SpecialPage.
Definition at line 117 of file OATHManage.php.
References SpecialPage\checkLoginSecurityLevel(), SpecialPage\displayRestrictionError(), SpecialPage\getRequest(), SpecialPage\getUser(), MediaWiki\Extension\OATHAuth\Special\OATHManage\hasEnabled(), and SpecialPage\requireLogin().
|
private |
When performing an action on a module (like enable/disable), page should contain only form for that action.
Definition at line 319 of file OATHManage.php.
References SpecialPage\getOutput(), MediaWiki\getTitle(), MediaWiki\Extension\OATHAuth\Special\OATHManage\isGenericAction(), MediaWiki\Extension\OATHAuth\Special\OATHManage\isModuleEnabled(), and wfMessage().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
private |
IManageForm | &$form | |
IModule | $module |
Definition at line 306 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\HTMLForm\IManageForm\addHiddenField(), MediaWiki\Extension\OATHAuth\IModule\getName(), and MediaWiki\Extension\OATHAuth\HTMLForm\IManageForm\hasField().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addCustomContent().
MediaWiki\Extension\OATHAuth\Special\OATHManage::execute | ( | $subPage | ) |
null | string | $subPage |
Reimplemented from SpecialPage.
Definition at line 86 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\addAlternativesHTML(), MediaWiki\Extension\OATHAuth\Special\OATHManage\addEnabledHTML(), MediaWiki\Extension\OATHAuth\Special\OATHManage\addGeneralHelp(), MediaWiki\Extension\OATHAuth\Special\OATHManage\addModuleHTML(), MediaWiki\Extension\OATHAuth\Special\OATHManage\clearPage(), SpecialPage\getOutput(), MediaWiki\Extension\OATHAuth\Special\OATHManage\hasAlternativeModules(), MediaWiki\Extension\OATHAuth\Special\OATHManage\hasEnabled(), MediaWiki\Extension\OATHAuth\Special\OATHManage\nothingEnabled(), MediaWiki\Extension\OATHAuth\Special\OATHManage\setAction(), MediaWiki\Extension\OATHAuth\Special\OATHManage\setModule(), MediaWiki\Extension\OATHAuth\Special\OATHManage\shouldShowDisableWarning(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\showDisableWarning().
|
private |
Definition at line 150 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\hasEnabled().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addEnabledHTML(), MediaWiki\Extension\OATHAuth\Special\OATHManage\isModuleEnabled(), MediaWiki\Extension\OATHAuth\Special\OATHManage\isSwitch(), MediaWiki\Extension\OATHAuth\Special\OATHManage\shouldShowDisableWarning(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\showDisableWarning().
|
private |
Get the panel with generic content for a module.
IModule | $module |
Definition at line 203 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\IModule\getDescriptionMessage(), MediaWiki\Extension\OATHAuth\IModule\getDisplayName(), MediaWiki\Extension\OATHAuth\IModule\getName(), SpecialPage\getOutput(), MediaWiki\getTitle(), MediaWiki\Extension\OATHAuth\Special\OATHManage\isModuleEnabled(), MediaWiki\Extension\OATHAuth\Special\OATHManage\shouldShowGenericButtons(), and wfMessage().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addModuleHTML().
|
private |
Definition at line 340 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\isModuleEnabled().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
private |
Definition at line 146 of file OATHManage.php.
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\checkPermissions(), MediaWiki\Extension\OATHAuth\Special\OATHManage\execute(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\getEnabled().
|
private |
Actions enable and disable are generic and all modules must implement them, while all other actions are module-specific.
Definition at line 336 of file OATHManage.php.
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\clearPage(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\shouldShowGenericButtons().
|
private |
Definition at line 277 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\getEnabled(), and MediaWiki\Extension\OATHAuth\IModule\getName().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addInactiveHTML(), MediaWiki\Extension\OATHAuth\Special\OATHManage\addModuleHTML(), MediaWiki\Extension\OATHAuth\Special\OATHManage\clearPage(), MediaWiki\Extension\OATHAuth\Special\OATHManage\getGenericContent(), and MediaWiki\Extension\OATHAuth\Special\OATHManage\hasAlternativeModules().
|
private |
Definition at line 268 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\IModule\getName().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addModuleHTML().
|
private |
Definition at line 397 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\getEnabled().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\showDisableWarning().
|
private |
Checks if given form instance fulfills required conditions.
mixed | $form |
Definition at line 290 of file OATHManage.php.
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\addCustomContent().
|
private |
Definition at line 164 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\addHeading(), MediaWiki\Extension\OATHAuth\Special\OATHManage\addInactiveHTML(), and wfMessage().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
private |
Definition at line 137 of file OATHManage.php.
References SpecialPage\getRequest().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
private |
Definition at line 141 of file OATHManage.php.
References SpecialPage\getRequest().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
private |
Definition at line 349 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\getEnabled(), and SpecialPage\getRequest().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
private |
Definition at line 258 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\isGenericAction().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\getGenericContent().
|
private |
Definition at line 355 of file OATHManage.php.
References MediaWiki\Extension\OATHAuth\Special\OATHManage\getEnabled(), SpecialPage\getOutput(), MediaWiki\getTitle(), MediaWiki\Extension\OATHAuth\Special\OATHManage\isSwitch(), and wfMessage().
Referenced by MediaWiki\Extension\OATHAuth\Special\OATHManage\execute().
|
protected |
Definition at line 61 of file OATHManage.php.
|
protected |
Definition at line 49 of file OATHManage.php.
|
protected |
Definition at line 57 of file OATHManage.php.
|
protected |
Definition at line 65 of file OATHManage.php.
|
protected |
Definition at line 53 of file OATHManage.php.
const MediaWiki\Extension\OATHAuth\Special\OATHManage::ACTION_DISABLE = 'disable' |
Definition at line 44 of file OATHManage.php.
Referenced by MediaWiki\Extension\OATHAuth\Module\TOTP\getManageForm().
const MediaWiki\Extension\OATHAuth\Special\OATHManage::ACTION_ENABLE = 'enable' |
Definition at line 43 of file OATHManage.php.
Referenced by MediaWiki\Extension\OATHAuth\Module\TOTP\getManageForm().