Page removal from a user's watchlist. More...

Inheritance diagram for UnwatchAction:

Collaboration diagram for UnwatchAction:

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

Page removal from a user's watchlist.

Definition at line 209 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 226 of file WatchAction.php.

References HTMLForm\setSubmitTextMsg().

UnwatchAction::getDescription ( ) [protected]

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

Returns:: String

Reimplemented from WatchAction.

Definition at line 215 of file WatchAction.php.

References Action\msg().

UnwatchAction::getName ( )

Return the name of the action this object responds to.

Returns:: String lowercase

Reimplemented from WatchAction.

Definition at line 211 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 219 of file WatchAction.php.

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

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 234 of file WatchAction.php.

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

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 230 of file WatchAction.php.

References Action\msg().

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

includes/actions/WatchAction.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation