MediaWiki  REL1_22
SpecialResetTokens Class Reference

Let users reset tokens like the watchlist token. More...

Inheritance diagram for SpecialResetTokens:
Collaboration diagram for SpecialResetTokens:

List of all members.

Public Member Functions

 __construct ()
 execute ($par)
 Basic SpecialPage workflow: get a form, send it to the user; get some data back,.
 isListed ()
 Whether this special page is listed in Special:SpecialPages.
 onSubmit (array $formData)
 Process the form on POST submission.
 onSuccess ()
 Do something exciting on successful processing of the form, most likely to show a confirmation message.

Protected Member Functions

 alterForm (HTMLForm $form)
 Suppress the submit button if there's nothing to do; provide additional message on it otherwise.
 getFormFields ()
 Display appropriate message if there's nothing to do.
 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'.
 getTokensList ()
 Returns the token information list for this page after running the hook and filtering out disabled preferences.

Private Attributes

 $tokensList

Detailed Description

Let users reset tokens like the watchlist token.

Definition at line 29 of file SpecialResetTokens.php.


Constructor & Destructor Documentation


Member Function Documentation

SpecialResetTokens::alterForm ( HTMLForm form) [protected]

Suppress the submit button if there's nothing to do; provide additional message on it otherwise.

Reimplemented from FormSpecialPage.

Definition at line 116 of file SpecialResetTokens.php.

References getTokensList(), HTMLForm\setSubmitTextMsg(), and HTMLForm\suppressDefaultSubmit().

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

Definition at line 61 of file SpecialResetTokens.php.

References FormSpecialPage\$par, SpecialPage\getOutput(), and SpecialPage\getTitleFor().

Display appropriate message if there's nothing to do.

The submit button is also suppressed in this case (see alterForm()).

Reimplemented from FormSpecialPage.

Definition at line 81 of file SpecialResetTokens.php.

References $user, array(), as, getTokensList(), SpecialPage\getUser(), and SpecialPage\msg().

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 138 of file SpecialResetTokens.php.

Returns the token information list for this page after running the hook and filtering out disabled preferences.

Returns:
array

Definition at line 42 of file SpecialResetTokens.php.

References array(), global, and wfRunHooks().

Referenced by alterForm(), getFormFields(), and isListed().

Whether this special page is listed in Special:SpecialPages.

Since:
r3583 (v1.3)
Returns:
Bool

Reimplemented from SpecialPage.

Definition at line 142 of file SpecialResetTokens.php.

References getTokensList().

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 124 of file SpecialResetTokens.php.

References $user, as, and SpecialPage\getUser().

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 70 of file SpecialResetTokens.php.

References SpecialPage\getOutput().


Member Data Documentation

SpecialResetTokens::$tokensList [private]

Definition at line 30 of file SpecialResetTokens.php.


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