Special page which uses an HTMLForm to handle processing. More...

Inherits MediaWiki\SpecialPage\SpecialPage.

Collaboration diagram for MediaWiki\SpecialPage\FormSpecialPage:

[legend]

Public Member Functions
	execute ( $par)
	Basic SpecialPage workflow: get a form, send it to the user; get some data back,.

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

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

	requiresPost ()
	Whether this action should using POST method to submit, default to true.

	requiresUnblock ()
	Whether this action cannot be executed by a blocked user, default to requiresPost()

	requiresWrite ()
	Whether this action requires the wiki not to be locked, default to requiresPost()

Public Member Functions inherited from MediaWiki\SpecialPage\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.

	doesWrites ()
	Indicates whether POST requests to this special page require write access to the wiki.

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

	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 canonical, unlocalized name of this special page without namespace.

	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.

	getShortDescription (string $path='')
	Similar to getDescription, but takes into account subpages and designed for display in tabs.

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

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	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.

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false)
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	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.

	getForm ()
	Get the HTMLForm to control behavior.

	getFormFields ()
	Get an HTMLForm descriptor array.

	getMessagePrefix ()
	Get message prefix for HTMLForm.

	getShowAlways ()
	Whether the form should always be shown despite the success of submission.

	getSubpageField ()
	Override this function to set the field name used in the subpage syntax.

	postHtml ()
	Add post-HTML to the form.

	postText ()
	Add post-text to the form.

	preHtml ()
	Add pre-HTML 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 MediaWiki\SpecialPage\SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

	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.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	getAuthManager ()

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

	getHookContainer ()

	getHookRunner ()

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

	getRobotPolicy ()
	Return the robot policy.

	getSpecialPageFactory ()

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset, ?SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Protected Attributes
string null	$par = null
	The subpage of the special page.

array null	$reauthPostData = null
	POST data preserved across re-authentication.

Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource	$mContext
	Current request context.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used as the message key for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\SpecialPage\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	newSearchPage (User $user)
	Get the users preferred search page.

Static Protected Member Functions inherited from MediaWiki\SpecialPage\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).

Detailed Description

Special page which uses an HTMLForm to handle processing.

This is mostly a clone of FormAction. More special pages should be built this way; maybe this could be a new structure for SpecialPages.

Definition at line 41 of file FormSpecialPage.php.

Member Function Documentation

◆ alterForm()

MediaWiki\SpecialPage\FormSpecialPage::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Parameters

HTMLForm $form

Definition at line 102 of file FormSpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm().

◆ checkExecutePermissions()

MediaWiki\SpecialPage\FormSpecialPage::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 in MediaWiki\Specials\SpecialBlock, MediaWiki\Specials\SpecialBotPasswords, MediaWiki\Specials\SpecialChangeEmail, MediaWiki\Specials\SpecialLockdb, MediaWiki\Specials\SpecialPasswordReset, and MediaWiki\Specials\SpecialUnlockdb.

Definition at line 282 of file FormSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\checkPermissions(), MediaWiki\SpecialPage\SpecialPage\checkReadOnly(), MediaWiki\User\User\getBlock(), MediaWiki\SpecialPage\SpecialPage\getLanguage(), MediaWiki\SpecialPage\SpecialPage\getRequest(), MediaWiki\SpecialPage\FormSpecialPage\requiresUnblock(), and MediaWiki\SpecialPage\FormSpecialPage\requiresWrite().

Referenced by MediaWiki\SpecialPage\FormSpecialPage\execute().

◆ execute()

MediaWiki\SpecialPage\FormSpecialPage::execute ( $par )

Basic SpecialPage workflow: get a form, send it to the user; get some data back,.

Parameters

string | null $par Subpage string if one was specified

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Reimplemented in MediaWiki\Specials\SpecialBlock, MediaWiki\Specials\SpecialBotPasswords, MediaWiki\Specials\SpecialChangeEmail, MediaWiki\Specials\SpecialMute, MediaWiki\Specials\SpecialPasswordReset, MediaWiki\Specials\SpecialResetTokens, and MediaWiki\Specials\SpecialUserLogout.

Definition at line 225 of file FormSpecialPage.php.

◆ getDisplayFormat()

MediaWiki\SpecialPage\FormSpecialPage::getDisplayFormat ( )

protected

Get display format for the form.

See HTMLForm documentation for available values.

Since: 1.25

Returns: string

Definition at line 121 of file FormSpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm().

◆ getForm()

MediaWiki\SpecialPage\FormSpecialPage::getForm ( )

protected

Get the HTMLForm to control behavior.

Returns: HTMLForm|null

Reimplemented in MediaWiki\Specials\SpecialMute.

Definition at line 129 of file FormSpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\execute().

◆ getFormFields()

MediaWiki\SpecialPage\FormSpecialPage::getFormFields ( )

abstractprotected

Get an HTMLForm descriptor array.

Returns: array

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm().

◆ getMessagePrefix()

MediaWiki\SpecialPage\FormSpecialPage::getMessagePrefix ( )

protected

Get message prefix for HTMLForm.

Since: 1.21

Returns: string

Reimplemented in MediaWiki\Specials\Redirects\SpecialTalkPage.

Definition at line 111 of file FormSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getName().

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm().

◆ getShowAlways()

MediaWiki\SpecialPage\FormSpecialPage::getShowAlways ( )

protected

Whether the form should always be shown despite the success of submission.

Since: 1.40

Returns: bool

Reimplemented in MediaWiki\Specials\SpecialWhatLinksHere.

Definition at line 255 of file FormSpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\execute().

◆ getSubpageField()

MediaWiki\SpecialPage\FormSpecialPage::getSubpageField ( )

protected

Override this function to set the field name used in the subpage syntax.

Since: 1.40

Returns: false|string

Reimplemented in MediaWiki\Specials\SpecialRandomInCategory, and MediaWiki\Specials\SpecialWhatLinksHere.

Definition at line 272 of file FormSpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm().

◆ onSubmit()

MediaWiki\SpecialPage\FormSpecialPage::onSubmit ( array $data )

abstract

Process the form on 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

◆ onSuccess()

MediaWiki\SpecialPage\FormSpecialPage::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

Definition at line 217 of file FormSpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\execute().

◆ postHtml()

MediaWiki\SpecialPage\FormSpecialPage::postHtml ( )

protected

Add post-HTML to the form.

Returns: string HTML which will be sent to $form->addPostHtml()

Since: 1.38

Reimplemented in MediaWiki\Specials\SpecialBlock, MediaWiki\Specials\SpecialChangeContentModel, and MediaWiki\Specials\SpecialPageLanguage.

Definition at line 74 of file FormSpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm(), and MediaWiki\SpecialPage\FormSpecialPage\postText().

◆ postText()

MediaWiki\SpecialPage\FormSpecialPage::postText ( )

protected

Add post-text to the form.

Returns: string HTML which will be sent to $form->addPostHtml()

Deprecated: since 1.38, use postHtml() instead, hard-deprecated since 1.43

Definition at line 93 of file FormSpecialPage.php.

References MediaWiki\SpecialPage\FormSpecialPage\postHtml(), and wfDeprecated().

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm().

◆ preHtml()

MediaWiki\SpecialPage\FormSpecialPage::preHtml ( )

protected

Add pre-HTML to the form.

Returns: string HTML which will be sent to $form->addPreHtml()

Since: 1.38

Reimplemented in MediaWiki\Specials\SpecialBlock, and MediaWiki\Specials\SpecialPageLanguage.

Definition at line 65 of file FormSpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm(), and MediaWiki\SpecialPage\FormSpecialPage\preText().

◆ preText()

MediaWiki\SpecialPage\FormSpecialPage::preText ( )

protected

Add pre-text to the form.

Returns: string HTML which will be sent to $form->addPreHtml()

Deprecated: since 1.38, use preHtml() instead, hard-deprecated since 1.43

Definition at line 83 of file FormSpecialPage.php.

References MediaWiki\SpecialPage\FormSpecialPage\preHtml(), and wfDeprecated().

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm().

◆ requiresPost()

MediaWiki\SpecialPage\FormSpecialPage::requiresPost ( )

Whether this action should using POST method to submit, default to true.

Since: 1.40

Returns: bool

Reimplemented in MediaWiki\Specials\SpecialRandomInCategory, MediaWiki\Specials\SpecialRedirect, and MediaWiki\Specials\SpecialWhatLinksHere.

Definition at line 307 of file FormSpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\getForm(), MediaWiki\SpecialPage\FormSpecialPage\requiresUnblock(), and MediaWiki\SpecialPage\FormSpecialPage\requiresWrite().

◆ requiresUnblock()

MediaWiki\SpecialPage\FormSpecialPage::requiresUnblock ( )

Whether this action cannot be executed by a blocked user, default to requiresPost()

Returns: bool

Reimplemented in MediaWiki\Specials\Redirects\SpecialTalkPage, MediaWiki\Specials\SpecialBlock, MediaWiki\Specials\SpecialChangeEmail, MediaWiki\Specials\SpecialMute, MediaWiki\Specials\SpecialResetTokens, and MediaWiki\Specials\SpecialUserLogout.

Definition at line 323 of file FormSpecialPage.php.

References MediaWiki\SpecialPage\FormSpecialPage\requiresPost().

Referenced by MediaWiki\SpecialPage\FormSpecialPage\checkExecutePermissions().

◆ requiresWrite()

MediaWiki\SpecialPage\FormSpecialPage::requiresWrite ( )

Whether this action requires the wiki not to be locked, default to requiresPost()

Returns: bool

Reimplemented in MediaWiki\Specials\Redirects\SpecialTalkPage, MediaWiki\Specials\SpecialLockdb, and MediaWiki\Specials\SpecialUnlockdb.

Definition at line 315 of file FormSpecialPage.php.

References MediaWiki\SpecialPage\FormSpecialPage\requiresPost().

Referenced by MediaWiki\SpecialPage\FormSpecialPage\checkExecutePermissions().

◆ setParameter()

MediaWiki\SpecialPage\FormSpecialPage::setParameter ( $par )

protected

Maybe do something interesting with the subpage parameter.

Parameters

string | null $par

Reimplemented in MediaWiki\Specials\SpecialBlock, MediaWiki\Specials\SpecialChangeContentModel, MediaWiki\Specials\SpecialWhatLinksHere, and MediaWiki\Specials\SpecialRedirect.

Definition at line 263 of file FormSpecialPage.php.

References MediaWiki\SpecialPage\FormSpecialPage\$par.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\execute().

◆ setReauthPostData()

MediaWiki\SpecialPage\FormSpecialPage::setReauthPostData ( array $data )

protected

Preserve POST data across reauthentication.

Since: 1.32

Parameters

array $data

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 333 of file FormSpecialPage.php.

Member Data Documentation

◆ $par

string null MediaWiki\SpecialPage\FormSpecialPage::$par = null

protected

The subpage of the special page.

Definition at line 46 of file FormSpecialPage.php.

◆ $reauthPostData

array null MediaWiki\SpecialPage\FormSpecialPage::$reauthPostData = null

protected

POST data preserved across re-authentication.

Since: 1.32

Definition at line 52 of file FormSpecialPage.php.

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

includes/specialpage/FormSpecialPage.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ alterForm()

◆ checkExecutePermissions()

◆ execute()

◆ getDisplayFormat()

◆ getForm()

◆ getFormFields()

◆ getMessagePrefix()

◆ getShowAlways()

◆ getSubpageField()

◆ onSubmit()

◆ onSuccess()

◆ postHtml()

◆ postText()

◆ preHtml()

◆ preText()

◆ requiresPost()

◆ requiresUnblock()

◆ requiresWrite()

◆ setParameter()

◆ setReauthPostData()

Member Data Documentation

◆ $par

◆ $reauthPostData