PurgeAction Class Reference

Inheritance diagram for PurgeAction:

Collaboration diagram for PurgeAction:

List of all members.

Public Member Functions
	getDescription ()
	Returns the description that goes below the <h1> tag.
	getName ()
	Return the name of the action this object responds to.
	onSubmit ($data)
	Process the form on POST submission.
	onSuccess ()
	Do something exciting on successful processing of the form.
	requiresUnblock ()
	Whether this action can still be executed by a blocked user.
	show ()
	purge is slightly weird because it can be either formed or formless depending on user permissions
Protected Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.
	getFormFields ()
	Just get an empty form with a single submit button.
	postText ()
	preText ()
	Add pre- or post-text to the form.
Private Attributes
	$redirectParams

---

Detailed Description

Definition at line 26 of file PurgeAction.php.

---

Member Function Documentation

PurgeAction::alterForm

(

HTMLForm $

form

)

[protected]

Play with the HTMLForm if you need to more substantially.

Parameters:

$form

HTMLForm

Reimplemented from FormAction.

Definition at line 81 of file PurgeAction.php.

References HTMLForm\setSubmitText(), and wfMsg().

Here is the call graph for this function:

PurgeAction::getDescription

(

)

Returns the description that goes below the <h1> tag.

Returns:

String

Reimplemented from Action.

Definition at line 38 of file PurgeAction.php.

PurgeAction::getFormFields

(

)

[protected]

Just get an empty form with a single submit button.

Returns:

array

Reimplemented from FormAction.

Definition at line 46 of file PurgeAction.php.

PurgeAction::getName

(

)

Return the name of the action this object responds to.

Returns:

String lowercase

Reimplemented from Action.

Definition at line 30 of file PurgeAction.php.

PurgeAction::onSubmit

(

$

data

)

Process the form on POST submission.

If you return false from getFormFields(), this will obviously never be reached. If you don't want to do anything with the form, just return false here

Parameters:

$data

Array

Returns:

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

Reimplemented from FormAction.

Definition at line 50 of file PurgeAction.php.

Referenced by show().

Here is the caller graph for this function:

PurgeAction::onSuccess

(

)

Do something exciting on successful processing of the form.

This might be to show a confirmation message (watch, rollback, etc) or to redirect somewhere else (edit, protect, etc).

Reimplemented from FormAction.

Definition at line 93 of file PurgeAction.php.

References Action\getOutput(), and Action\getTitle().

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

PurgeAction::postText

(

)

[protected]

Returns:

string

Reimplemented from FormAction.

Definition at line 89 of file PurgeAction.php.

References wfMessage().

Here is the call graph for this function:

PurgeAction::preText

(

)

[protected]

Add pre- or post-text to the form.

Returns:

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

Reimplemented from FormAction.

Definition at line 85 of file PurgeAction.php.

References wfMessage().

Here is the call graph for this function:

PurgeAction::requiresUnblock

(

)

Whether this action can still be executed by a blocked user.

Returns:

Bool

Reimplemented from Action.

Definition at line 34 of file PurgeAction.php.

PurgeAction::show

(

)

purge is slightly weird because it can be either formed or formless depending on user permissions

Reimplemented from FormAction.

Definition at line 58 of file PurgeAction.php.

References Action\checkCanExecute(), FormAction\getForm(), Action\getRequest(), Action\getUser(), onSubmit(), onSuccess(), Action\setHeaders(), and wfArrayToCGI().

Here is the call graph for this function:

---

Member Data Documentation

PurgeAction::$redirectParams [private]

Definition at line 28 of file PurgeAction.php.

---

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

• includes/actions/PurgeAction.php