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

SpecialResetTokens::__construct

(

)

Definition at line 32 of file SpecialResetTokens.php.

---

Member Function Documentation

SpecialResetTokens::alterForm

(

HTMLForm $

form

)

[protected]

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

Parameters:

HTMLForm

$form

Reimplemented from FormSpecialPage.

Definition at line 118 of file SpecialResetTokens.php.

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

SpecialResetTokens::execute

(

$

par

)

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

Parameters:

string

$par

Subpage string if one was specified

Reimplemented from FormSpecialPage.

Definition at line 60 of file SpecialResetTokens.php.

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

SpecialResetTokens::getFormFields

(

)

[protected]

Display appropriate message if there's nothing to do.

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

Returns:

array

Reimplemented from FormSpecialPage.

Definition at line 82 of file SpecialResetTokens.php.

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

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

SpecialResetTokens::getTokensList

(

)

[protected]

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(), SpecialPage\getConfig(), and wfRunHooks().

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

SpecialResetTokens::isListed

(

)

Whether this special page is listed in Special:SpecialPages.

Since:

1.3 (r3583)

Returns:

bool

Reimplemented from SpecialPage.

Definition at line 144 of file SpecialResetTokens.php.

References getTokensList().

SpecialResetTokens::onSubmit

(

array $

data

)

Process the form on POST submission.

Parameters:

array	$data
HTMLForm	$form

Returns:

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

Reimplemented from FormSpecialPage.

Definition at line 126 of file SpecialResetTokens.php.

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

SpecialResetTokens::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 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:

• includes/specials/SpecialResetTokens.php