Let users manage bot passwords. More...

Inheritance diagram for SpecialBotPasswords:

[legend]

Collaboration diagram for SpecialBotPasswords:

[legend]

Public Member Functions
	__construct ()

	execute ( $par)
	Main execution point.

	isListed ()

	onSubmit (array $data)
	Process the form on POST submission.

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

Public Member Functions inherited from FormSpecialPage
	requiresUnblock ()
	Whether this action cannot be executed by a blocked user.

	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.

	doesWrites ()
	Indicates whether this special page may perform database writes.

	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.

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

	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,... $params)
	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
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

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

	getDisplayFormat ()
	Get display format for the form.

	getFormFields ()
	Get an HTMLForm descriptor array.

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

	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 ()

	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 Member Functions
	save (array $data)

Private Attributes
BotPassword null	$botPassword = null
	Bot password being edited, if any.

Psr Log LoggerInterface	$logger = null

string	$operation = null
	Operation being performed: create, update, delete.

string	$password = null
	New password set, for communication between onSubmit() and onSuccess()

int	$userId = 0
	Central user ID.

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

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()

SpecialBotPasswords::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Parameters

HTMLForm $form

Reimplemented from FormSpecialPage.

Definition at line 231 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 85 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 69 of file SpecialBotPasswords.php.

References FormSpecialPage\$par, SpecialPage\addHelpLink(), 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 394 of file SpecialBotPasswords.php.

◆ getFormFields()

SpecialBotPasswords::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from FormSpecialPage.

Definition at line 98 of file SpecialBotPasswords.php.

References $dbr, $lang, SpecialPage\$linkRenderer, FormSpecialPage\$par, $password, $res, DB_REPLICA, MWGrants\getHiddenGrants(), SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getPageTitle(), MWGrants\getRightsByGrant(), SpecialPage\getUser(), MWGrants\getValidGrants(), and SpecialPage\msg().

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

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 390 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.

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

References SpecialPage\getName().

◆ isListed()

SpecialBotPasswords::isListed ( )

Returns: bool

Reimplemented from SpecialPage.

Definition at line 57 of file SpecialBotPasswords.php.

References SpecialPage\getConfig().

◆ onSubmit()

SpecialBotPasswords::onSubmit ( array $data )

Process the form on POST submission.

Parameters

array	$data
HTMLForm \| null	$form	PhanCommentParamWithoutRealParam Many implementations don't have $form

Returns: bool|string|array|Status As documented for HTMLForm::trySubmit.

Reimplemented from FormSpecialPage.

Definition at line 270 of file SpecialBotPasswords.php.

References SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getUser(), 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 353 of file SpecialBotPasswords.php.

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

◆ save()

SpecialBotPasswords::save ( array $data )

private

Definition at line 312 of file SpecialBotPasswords.php.

References $password, SpecialPage\getConfig(), MWGrants\getHiddenGrants(), SpecialPage\getName(), and SpecialPage\getUser().

Referenced by onSubmit().

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.

Referenced by getFormFields(), and save().

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

includes/specials/SpecialBotPasswords.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ checkExecutePermissions()

◆ execute()

◆ getDisplayFormat()

◆ getFormFields()

◆ getGroupName()

◆ getLoginSecurityLevel()

◆ isListed()

◆ onSubmit()

◆ onSuccess()

◆ save()

Member Data Documentation

◆ $botPassword

◆ $logger

◆ $operation

◆ $password

◆ $userId