MediaWiki  REL1_22
SpecialUnlockdb Class Reference

Implements Special:Unlockdb. More...

Inheritance diagram for SpecialUnlockdb:
Collaboration diagram for SpecialUnlockdb:

List of all members.

Public Member Functions

 __construct ()
 checkExecutePermissions (User $user)
 Called from execute() to check if the given user can perform this action.
 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.
 requiresWrite ()
 Whether this action requires the wiki not to be locked.

Protected Member Functions

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

Detailed Description

Implements Special:Unlockdb.

Definition at line 29 of file SpecialUnlockdb.php.


Constructor & Destructor Documentation

Definition at line 31 of file SpecialUnlockdb.php.


Member Function Documentation

SpecialUnlockdb::alterForm ( HTMLForm form) [protected]

Play with the HTMLForm if you need to more substantially.

Parameters:
$formHTMLForm

Reimplemented from FormSpecialPage.

Definition at line 58 of file SpecialUnlockdb.php.

References SpecialPage\msg(), HTMLForm\setHeaderText(), HTMLForm\setSubmitTextMsg(), and HTMLForm\setWrapperLegend().

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 from FormSpecialPage.

Definition at line 39 of file SpecialUnlockdb.php.

References global.

Get an HTMLForm descriptor array.

Returns:
Array

Reimplemented from FormSpecialPage.

Definition at line 49 of file SpecialUnlockdb.php.

References array().

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 88 of file SpecialUnlockdb.php.

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 from FormSpecialPage.

Definition at line 64 of file SpecialUnlockdb.php.

References $res, global, Status\newFatal(), Status\newGood(), wfRestoreWarnings(), and wfSuppressWarnings().

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 82 of file SpecialUnlockdb.php.

References $out, SpecialPage\getOutput(), and SpecialPage\msg().

Whether this action requires the wiki not to be locked.

Returns:
Bool

Reimplemented from FormSpecialPage.

Definition at line 35 of file SpecialUnlockdb.php.


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