UnwatchAction Class Reference

Inheritance diagram for UnwatchAction:

Collaboration diagram for UnwatchAction:

List of all members.

Public Member Functions
	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.
Protected Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.
	getDescription ()
	Returns the description that goes below the <h1> tag.
	preText ()
	Add pre- or post-text to the form.

---

Detailed Description

Definition at line 151 of file WatchAction.php.

---

Member Function Documentation

UnwatchAction::alterForm

(

HTMLForm $

form

)

[protected]

Play with the HTMLForm if you need to more substantially.

Parameters:

$form

HTMLForm

Reimplemented from WatchAction.

Definition at line 168 of file WatchAction.php.

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

Here is the call graph for this function:

UnwatchAction::getDescription

(

)

[protected]

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

Returns:

String

Reimplemented from WatchAction.

Definition at line 157 of file WatchAction.php.

References wfMsg().

Here is the call graph for this function:

UnwatchAction::getName

(

)

Return the name of the action this object responds to.

Returns:

String lowercase

Reimplemented from WatchAction.

Definition at line 153 of file WatchAction.php.

UnwatchAction::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 WatchAction.

Definition at line 161 of file WatchAction.php.

References WatchAction\doUnwatch(), Action\getTitle(), Action\getUser(), wfProfileIn(), and wfProfileOut().

Here is the call graph for this function:

UnwatchAction::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 WatchAction.

Definition at line 176 of file WatchAction.php.

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

Here is the call graph for this function:

UnwatchAction::preText

(

)

[protected]

Add pre- or post-text to the form.

Returns:

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

Reimplemented from WatchAction.

Definition at line 172 of file WatchAction.php.

References wfMessage().

Here is the call graph for this function:

---

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

• includes/actions/WatchAction.php