MediaWiki  1.23.8
FormSpecialPage Class Reference

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

Inheritance diagram for FormSpecialPage:
Collaboration diagram for FormSpecialPage:

Public Member Functions

 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='default', $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...
 
 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...
 
 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...
 
 getFile ()
 Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. 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...
 
 getLang ()
 Shortcut to get user's language. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 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...
 
 getTitle ( $subpage=false)
 Get a self-referential title object. 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...
 
 msg ()
 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...
 
 requireLogin ( $reasonMsg=null, $titleMsg=null)
 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...
 
 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)
 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...
 
 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...
 
- 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...
 
 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...
 
 getRobotPolicy ()
 Return the robot policy. More...
 

Protected Attributes

string $par = null
 The sub-page of the special page. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 

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

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 31 of file FormSpecialPage.php.

Member Function Documentation

◆ alterForm()

FormSpecialPage::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Parameters
$formHTMLForm

Reimplemented in SpecialRedirect, SpecialChangePassword, SpecialResetTokens, SpecialPasswordReset, SpecialBlock, SpecialLockdb, and SpecialUnlockdb.

Definition at line 63 of file FormSpecialPage.php.

Referenced by getForm().

◆ checkExecutePermissions()

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
$userUser
Exceptions
UserBlockedError
Returns
Bool true

Reimplemented in SpecialBlock, SpecialChangePassword, SpecialPasswordReset, SpecialLockdb, and SpecialUnlockdb.

Definition at line 161 of file FormSpecialPage.php.

References $user, SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), User\isBlocked(), requiresUnblock(), and requiresWrite().

Referenced by execute().

◆ execute()

FormSpecialPage::execute (   $par)

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

Parameters
string$parSubpage string if one was specified

Reimplemented from SpecialPage.

Reimplemented in SpecialResetTokens, and SpecialChangePassword.

Definition at line 133 of file FormSpecialPage.php.

References $form, checkExecutePermissions(), getForm(), SpecialPage\getUser(), onSuccess(), SpecialPage\setHeaders(), and setParameter().

◆ getForm()

FormSpecialPage::getForm ( )
protected

◆ getFormFields()

FormSpecialPage::getFormFields ( )
abstractprotected

Get an HTMLForm descriptor array.

Returns
Array

Reimplemented in SpecialRedirect, SpecialBlock, SpecialResetTokens, SpecialChangePassword, SpecialPasswordReset, SpecialLockdb, and SpecialUnlockdb.

Referenced by getForm().

◆ getMessagePrefix()

FormSpecialPage::getMessagePrefix ( )
protected

Get message prefix for HTMLForm.

Since
1.21
Returns
string

Definition at line 72 of file FormSpecialPage.php.

References SpecialPage\getName().

Referenced by SpecialRedirect\alterForm(), SpecialRedirect\dispatch(), getForm(), and SpecialRedirect\getFormFields().

◆ onSubmit()

FormSpecialPage::onSubmit ( array  $data)
abstract

Process the form on POST submission.

Parameters
$dataArray
Returns
Bool|Array true for success, false for didn't-try, array of errors on failure

Reimplemented in SpecialResetTokens, SpecialBlock, SpecialRedirect, SpecialChangePassword, SpecialPasswordReset, SpecialLockdb, and SpecialUnlockdb.

◆ onSuccess()

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

Reimplemented in SpecialBlock, SpecialPasswordReset, SpecialRedirect, SpecialChangePassword, SpecialLockdb, SpecialUnlockdb, and SpecialResetTokens.

Definition at line 125 of file FormSpecialPage.php.

Referenced by execute().

◆ postText()

FormSpecialPage::postText ( )
protected

Add post-text to the form.

Returns
String HTML which will be sent to $form->addPostText()

Reimplemented in SpecialBlock.

Definition at line 55 of file FormSpecialPage.php.

Referenced by getForm().

◆ preText()

FormSpecialPage::preText ( )
protected

Add pre-text to the form.

Returns
String HTML which will be sent to $form->addPreText()

Reimplemented in SpecialBlock.

Definition at line 47 of file FormSpecialPage.php.

Referenced by getForm().

◆ requiresUnblock()

FormSpecialPage::requiresUnblock ( )

Whether this action cannot be executed by a blocked user.

Returns
Bool

Reimplemented in SpecialChangePassword.

Definition at line 188 of file FormSpecialPage.php.

Referenced by checkExecutePermissions().

◆ requiresWrite()

FormSpecialPage::requiresWrite ( )

Whether this action requires the wiki not to be locked.

Returns
Bool

Reimplemented in SpecialLockdb, and SpecialUnlockdb.

Definition at line 180 of file FormSpecialPage.php.

Referenced by checkExecutePermissions().

◆ setParameter()

FormSpecialPage::setParameter (   $par)
protected

Maybe do something interesting with the subpage parameter.

Parameters
string$par

Reimplemented in SpecialRedirect, and SpecialBlock.

Definition at line 150 of file FormSpecialPage.php.

References $par.

Referenced by execute().

Member Data Documentation

◆ $par

string FormSpecialPage::$par = null
protected

The sub-page of the special page.

Definition at line 35 of file FormSpecialPage.php.

Referenced by SpecialChangePassword\execute(), SpecialResetTokens\execute(), SpecialBlock\setParameter(), and setParameter().


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