MediaWiki REL1_33
SpecialDisableOATHForUser Class Reference
Inheritance diagram for SpecialDisableOATHForUser:
Collaboration diagram for SpecialDisableOATHForUser:

Public Member Functions

 __construct ()
 
 alterForm (HTMLForm $form)
 Set the page title and add JavaScript RL modules.
 
 doesWrites ()
 Indicates whether this special page may perform database writes.
 
 execute ( $par)
 
 onSubmit (array $formData)
 
 onSuccess ()
 Do something exciting on successful processing of the form, most likely to show a confirmation message.
 
 requiresUnblock ()
 
- Public Member Functions inherited from FormSpecialPage
 requiresWrite ()
 Whether this action requires the wiki not to be locked.
 
- 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.
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators.
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError.
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 getConfig ()
 Shortcut to get main config object.
 
 getContext ()
 Gets the context this SpecialPage is executed in.
 
 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.
 
 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.
 
 getFullTitle ()
 Return the full title, including $par.
 
 getLanguage ()
 Shortcut to get user's language.
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page.
 
 getName ()
 Get the name of this Special Page.
 
 getOutput ()
 Get the OutputPage being used for this instance.
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object.
 
 getRequest ()
 Get the WebRequest being used for this instance.
 
 getRestriction ()
 Get the permission that a user must have to execute this page.
 
 getSkin ()
 Shortcut to get the skin being used for this instance.
 
 getTitle ( $subpage=false)
 Get a self-referential title object.
 
 getUser ()
 Shortcut to get the User executing this instance.
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion.
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode.
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages.
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes.
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages.
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included.
 
 msg ( $key)
 Wrapper around wfMessage that sets the current context.
 
 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.
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept.
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error.
 
 run ( $subPage)
 Entry point.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time.
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
 

Protected Member Functions

 checkExecutePermissions (User $user)
 Require users to be logged in.
 
 getDisplayFormat ()
 
 getFormFields ()
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.
 
- Protected Member Functions inherited from FormSpecialPage
 getForm ()
 Get the HTMLForm to control behavior.
 
 getMessagePrefix ()
 Get message prefix for HTMLForm.
 
 postText ()
 Add post-text to the form.
 
 preText ()
 Add pre-text to the form.
 
 setParameter ( $par)
 Maybe do something interesting with the subpage parameter.
 
 setReauthPostData (array $data)
 Preserve POST data across reauthentication.
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 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'.
 
 getRobotPolicy ()
 Return the robot policy.
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

Private Attributes

OATHUserRepository $OATHRepository
 

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.
 
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.
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name.
 
- 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).
 
- Protected Attributes inherited from FormSpecialPage
string null $par = null
 The sub-page of the special page.
 
array null $reauthPostData = null
 POST data preserved across re-authentication.
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context.
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

Definition at line 3 of file SpecialDisableOATHForUser.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialDisableOATHForUser::__construct ( )

Member Function Documentation

◆ alterForm()

SpecialDisableOATHForUser::alterForm ( HTMLForm $form)

Set the page title and add JavaScript RL modules.

Parameters
HTMLForm$form

Reimplemented from FormSpecialPage.

Definition at line 26 of file SpecialDisableOATHForUser.php.

References ContextSource\getOutput(), SpecialPage\msg(), and HTMLForm\setPreText().

◆ checkExecutePermissions()

SpecialDisableOATHForUser::checkExecutePermissions ( User $user)
protected

Require users to be logged in.

Parameters
User$user

Reimplemented from FormSpecialPage.

Definition at line 52 of file SpecialDisableOATHForUser.php.

References SpecialPage\requireLogin().

◆ doesWrites()

SpecialDisableOATHForUser::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 13 of file SpecialDisableOATHForUser.php.

◆ execute()

SpecialDisableOATHForUser::execute ( $par)
Parameters
string$par

Reimplemented from FormSpecialPage.

Definition at line 61 of file SpecialDisableOATHForUser.php.

References FormSpecialPage\$par, and SpecialPage\getOutput().

◆ getDisplayFormat()

SpecialDisableOATHForUser::getDisplayFormat ( )
protected
Returns
string

Reimplemented from FormSpecialPage.

Definition at line 36 of file SpecialDisableOATHForUser.php.

◆ getFormFields()

SpecialDisableOATHForUser::getFormFields ( )
protected
Returns
array[]

Reimplemented from FormSpecialPage.

Definition at line 69 of file SpecialDisableOATHForUser.php.

◆ getLoginSecurityLevel()

SpecialDisableOATHForUser::getLoginSecurityLevel ( )
protected

Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

a reauthentication). What exactly that will mean is decided by the authentication framework.

Returns
bool|string False or the argument for AuthManager::securitySensitiveOperationStatus(). Typically a special page needing elevated security would return its name here.

Reimplemented from SpecialPage.

Definition at line 17 of file SpecialDisableOATHForUser.php.

References SpecialPage\getName().

◆ onSubmit()

SpecialDisableOATHForUser::onSubmit ( array $formData)
Parameters
array$formData
Returns
array|bool

Reimplemented from FormSpecialPage.

Definition at line 85 of file SpecialDisableOATHForUser.php.

References SpecialPage\getName(), SpecialPage\getRequest(), SpecialPage\getUser(), and User\newFromName().

◆ onSuccess()

SpecialDisableOATHForUser::onSuccess ( )

Do something exciting on successful processing of the form, most likely to show a confirmation message.

Since
1.22 Default is to do nothing

Reimplemented from FormSpecialPage.

Definition at line 115 of file SpecialDisableOATHForUser.php.

References SpecialPage\getOutput().

◆ requiresUnblock()

SpecialDisableOATHForUser::requiresUnblock ( )
Returns
bool

Reimplemented from FormSpecialPage.

Definition at line 43 of file SpecialDisableOATHForUser.php.

Member Data Documentation

◆ $OATHRepository

OATHUserRepository SpecialDisableOATHForUser::$OATHRepository
private

Definition at line 5 of file SpecialDisableOATHForUser.php.


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