MediaWiki  master
SpecialBotPasswords Class Reference

Let users manage bot passwords. More...

Inheritance diagram for SpecialBotPasswords:
Collaboration diagram for SpecialBotPasswords:

Public Member Functions

 __construct ()
 
 execute ( $par)
 Main execution point. More...
 
 isListed ()
 
 onSubmit (array $data)
 
 onSuccess ()
 
- Public Member Functions inherited from FormSpecialPage
 execute ( $par)
 Basic SpecialPage workflow: get a form, send it to the user; get some data back,. More...
 
 onSubmit (array $data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form, most likely to show a confirmation message. More...
 
 requiresUnblock ()
 Whether this action cannot be executed by a blocked user. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 
- 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...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. 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...
 
 execute ( $subPage)
 Default execute method Checks user permissions. 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...
 

Protected Member Functions

 alterForm (HTMLForm $form)
 
 checkExecutePermissions (User $user)
 
 getDisplayFormat ()
 
 getFormFields ()
 
 getGroupName ()
 
 getLoginSecurityLevel ()
 
- Protected Member Functions inherited from FormSpecialPage
 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 checkExecutePermissions (User $user)
 Called from execute() to check if the given user can perform this action. More...
 
 getDisplayFormat ()
 Get display format for the form. More...
 
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
 getMessagePrefix ()
 Get message prefix for HTMLForm. More...
 
 postText ()
 Add post-text to the form. More...
 
 preText ()
 Add pre-text to the form. More...
 
 setParameter ( $par)
 Maybe do something interesting with the subpage parameter. More...
 
 setReauthPostData (array $data)
 Preserve POST data across reauthentication. 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...
 

Private Member Functions

 save (array $data)
 

Private Attributes

BotPassword null $botPassword = null
 Bot password being edited, if any. More...
 
Psr Log LoggerInterface $logger = null
 
string $operation = null
 Operation being performed: create, update, delete. More...
 
string $password = null
 New password set, for communication between onSubmit() and onSuccess() More...
 
int $userId = 0
 Central user ID. More...
 

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...
 
- 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...
 
- Protected Attributes inherited from FormSpecialPage
string null $par = null
 The sub-page of the special page. More...
 
array null $reauthPostData = null
 POST data preserved across re-authentication. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

Let users manage bot passwords.

Definition at line 32 of file SpecialBotPasswords.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialBotPasswords::__construct ( )

Definition at line 49 of file SpecialBotPasswords.php.

Member Function Documentation

◆ alterForm()

◆ checkExecutePermissions()

SpecialBotPasswords::checkExecutePermissions ( User  $user)
protected

◆ execute()

SpecialBotPasswords::execute (   $par)

Main execution point.

Parameters
string | null$par

Definition at line 69 of file SpecialBotPasswords.php.

References FormSpecialPage\$par, SpecialPage\addHelpLink(), BotPassword\APPID_MAXLENGTH, SpecialPage\getOutput(), and SpecialPage\requireLogin().

◆ getDisplayFormat()

SpecialBotPasswords::getDisplayFormat ( )
protected

Definition at line 394 of file SpecialBotPasswords.php.

◆ getFormFields()

◆ getGroupName()

SpecialBotPasswords::getGroupName ( )
protected

Definition at line 390 of file SpecialBotPasswords.php.

◆ getLoginSecurityLevel()

SpecialBotPasswords::getLoginSecurityLevel ( )
protected

Definition at line 61 of file SpecialBotPasswords.php.

References SpecialPage\getName().

◆ isListed()

SpecialBotPasswords::isListed ( )
Returns
bool

Definition at line 57 of file SpecialBotPasswords.php.

References SpecialPage\getConfig().

◆ onSubmit()

◆ onSuccess()

◆ save()

Member Data Documentation

◆ $botPassword

BotPassword null SpecialBotPasswords::$botPassword = null
private

Bot password being edited, if any.

Definition at line 38 of file SpecialBotPasswords.php.

◆ $logger

Psr Log LoggerInterface SpecialBotPasswords::$logger = null
private

Definition at line 47 of file SpecialBotPasswords.php.

◆ $operation

string SpecialBotPasswords::$operation = null
private

Operation being performed: create, update, delete.

Definition at line 41 of file SpecialBotPasswords.php.

◆ $password

string SpecialBotPasswords::$password = null
private

New password set, for communication between onSubmit() and onSuccess()

Definition at line 44 of file SpecialBotPasswords.php.

◆ $userId

int SpecialBotPasswords::$userId = 0
private

Central user ID.

Definition at line 35 of file SpecialBotPasswords.php.


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