MediaWiki  master
SpecialBotPasswords Class Reference

Let users manage bot passwords. More...

Inheritance diagram for SpecialBotPasswords:
Collaboration diagram for SpecialBotPasswords:

Public Member Functions

 __construct (PasswordFactory $passwordFactory, AuthManager $authManager, CentralIdLookup $centralIdLookup)
 
 execute ( $par)
 Main execution point. More...
 
 isListed ()
 
 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...
 
- Public Member Functions inherited from FormSpecialPage
 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...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 getAuthority ()
 Shortcut to get the Authority executing this instance. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. 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...
 
 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...
 
 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...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 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)
 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...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
 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...
 
- Protected Member Functions inherited from FormSpecialPage
 getForm ()
 Get the HTMLForm to control behavior. 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...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. 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...
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! 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...
 
CentralIdLookup $centralIdLookup
 
Psr Log LoggerInterface $logger
 
string $operation = null
 Operation being performed: create, update, delete. More...
 
string $password = null
 New password set, for communication between onSubmit() and onSuccess() More...
 
PasswordFactory $passwordFactory
 
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...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Detailed Description

Let users manage bot passwords.

Definition at line 32 of file SpecialBotPasswords.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialBotPasswords::__construct ( PasswordFactory  $passwordFactory,
AuthManager  $authManager,
CentralIdLookup  $centralIdLookup 
)
Parameters
PasswordFactory$passwordFactory
AuthManager$authManager
CentralIdLookup$centralIdLookup

Definition at line 60 of file SpecialBotPasswords.php.

References $centralIdLookup, $passwordFactory, and SpecialPage\setAuthManager().

Member Function Documentation

◆ alterForm()

SpecialBotPasswords::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Parameters
HTMLForm$form

Reimplemented from FormSpecialPage.

Definition at line 251 of file SpecialBotPasswords.php.

References HTMLForm\addButton(), HTMLForm\addPreText(), SpecialPage\msg(), HTMLForm\setId(), HTMLForm\setTableId(), HTMLForm\setWrapperLegendMsg(), and HTMLForm\suppressDefaultSubmit().

◆ checkExecutePermissions()

SpecialBotPasswords::checkExecutePermissions ( User  $user)
protected

Called from execute() to check if the given user can perform this action.

Failures here must throw subclasses of ErrorPageError.

Parameters
User$user
Exceptions
UserBlockedError

Reimplemented from FormSpecialPage.

Definition at line 103 of file SpecialBotPasswords.php.

References SpecialPage\getConfig(), and SpecialPage\getUser().

◆ execute()

SpecialBotPasswords::execute (   $par)

Main execution point.

Parameters
string | null$par

Reimplemented from FormSpecialPage.

Definition at line 87 of file SpecialBotPasswords.php.

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

◆ getDisplayFormat()

SpecialBotPasswords::getDisplayFormat ( )
protected

Get display format for the form.

See HTMLForm documentation for available values.

Since
1.25
Returns
string

Reimplemented from FormSpecialPage.

Definition at line 419 of file SpecialBotPasswords.php.

◆ getFormFields()

◆ getGroupName()

SpecialBotPasswords::getGroupName ( )
protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 415 of file SpecialBotPasswords.php.

◆ getLoginSecurityLevel()

SpecialBotPasswords::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.

Stability: stable
to override
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 79 of file SpecialBotPasswords.php.

References SpecialPage\getName().

◆ isListed()

SpecialBotPasswords::isListed ( )
Returns
bool

Reimplemented from SpecialPage.

Definition at line 75 of file SpecialBotPasswords.php.

References SpecialPage\getConfig().

◆ onSubmit()

SpecialBotPasswords::onSubmit ( array  $data)

Process the form on POST submission.

@phpcs:disable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Parameters
array$data
HTMLForm | null$form
Returns
bool|string|array|Status As documented for HTMLForm::trySubmit. @phpcs:enable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Reimplemented from FormSpecialPage.

Definition at line 290 of file SpecialBotPasswords.php.

References SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getUser(), BotPassword\newFromCentralId(), StatusValue\newGood(), and save().

◆ onSuccess()

SpecialBotPasswords::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 378 of file SpecialBotPasswords.php.

References SpecialPage\getOutput(), SpecialPage\getPageTitle(), BotPassword\getSeparator(), SpecialPage\getUser(), and SpecialPage\msg().

◆ 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.

◆ $centralIdLookup

CentralIdLookup SpecialBotPasswords::$centralIdLookup
private

Definition at line 53 of file SpecialBotPasswords.php.

Referenced by __construct().

◆ $logger

Psr Log LoggerInterface SpecialBotPasswords::$logger
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.

Referenced by getFormFields(), and save().

◆ $passwordFactory

PasswordFactory SpecialBotPasswords::$passwordFactory
private

Definition at line 50 of file SpecialBotPasswords.php.

Referenced by __construct().

◆ $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: