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

Inheritance diagram for UnwatchAction:

[legend]

Collaboration diagram for UnwatchAction:

[legend]

Public Member Functions
	getName ()
	Return the name of the action this object responds to. More...

	onSubmit ( $data)
	Process the form on POST submission. More...

	onSuccess ()
	Do something exciting on successful processing of the form. More...

Public Member Functions inherited from WatchAction
	requiresUnblock ()
	Whether this action can still be executed by a blocked user. More...

	show ()
	This can be either formed or formless depending on the session token given. More...

Public Member Functions inherited from FormAction
	execute (array $data=null, $captureErrors=true)

Public Member Functions inherited from Action
	__construct (Page $page, IContextSource $context=null)
	Constructor. More...

	execute ()
	Execute the action in a silent fashion: do not display anything or release any errors. More...

	getContext ()
	Get the IContextSource in use here. More...

	getLang ()
	Shortcut to get the user Language being used for this instance. More...

	getLanguage ()
	Shortcut to get the user Language being used for this instance. More...

	getOutput ()
	Get the OutputPage being used for this instance. More...

	getRequest ()
	Get the WebRequest being used for this instance. More...

	getRestriction ()
	Get the permission required to perform this action. More...

	getSkin ()
	Shortcut to get the Skin being used for this instance. More...

	getTitle ()
	Shortcut to get the Title object from the page. More...

	getUser ()
	Shortcut to get the User being used for this instance. More...

	msg ()
	Get a Message object with context set Parameters are the same as wfMessage() More...

	requiresWrite ()
	Whether this action requires the wiki not to be locked. More...

Protected Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially. More...

	getDescription ()
	Returns the description that goes below the <h1> tag. More...

	preText ()
	Add pre- or post-text to the form. More...

Protected Member Functions inherited from WatchAction
	checkCanExecute (User $user)
	Checks if the given user (identified by an object) can perform this action. More...

	getFormFields ()
	Just get an empty form with a single submit button. More...

Protected Member Functions inherited from FormAction
	getForm ()
	Get the HTMLForm to control behavior. More...

	postText ()

Protected Member Functions inherited from Action
	getPageTitle ()
	Returns the name that goes in the <h1> page title. More...

	setHeaders ()
	Set output headers for noindexing etc. More...

Additional Inherited Members
Static Public Member Functions inherited from WatchAction
static	doUnwatch (Title $title, User $user)
	Unwatch a page. More...

static	doWatch (Title $title, User $user, $checkRights=WatchedItem::CHECK_USER_RIGHTS)
	Watch a page. More...

static	doWatchOrUnwatch ( $watch, Title $title, User $user)
	Watch or unwatch a page. More...

static	getUnwatchToken (Title $title, User $user, $action='unwatch')
	Get token to unwatch (or watch) a page for a user. More...

static	getWatchToken (Title $title, User $user, $action='watch')
	Get token to watch (or unwatch) a page for a user. More...

Static Public Member Functions inherited from Action
static	exists ( $name)
	Check if a given action is recognised, even if it's disabled. More...

static	factory ( $action, Page $page, IContextSource $context=null)
	Get an appropriate Action subclass for the given action. More...

static	getActionName (IContextSource $context)
	Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter. More...

Protected Attributes inherited from Action
IContextSource	$context
	IContextSource if specified; otherwise we'll use the Context from the Page $context. More...

array	$fields
	The fields used to create the HTMLForm $fields. More...

WikiPage Article ImagePage CategoryPage Page	$page
	Page on which we're performing the action $page. More...

Detailed Description

Page removal from a user's watchlist.

Definition at line 226 of file WatchAction.php.

Member Function Documentation

◆ alterForm()

UnwatchAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Parameters

HTMLForm $form

Reimplemented from WatchAction.

Definition at line 244 of file WatchAction.php.

References $form.

◆ getDescription()

UnwatchAction::getDescription ( )

protected

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

Returns: string

Reimplemented from WatchAction.

Definition at line 232 of file WatchAction.php.

References Action\msg().

◆ getName()

UnwatchAction::getName ( )

Return the name of the action this object responds to.

Returns: string Lowercase name

Reimplemented from WatchAction.

Definition at line 228 of file WatchAction.php.

◆ onSubmit()

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

array $data

Returns: bool|array True for success, false for didn't-try, array of errors on failure

Reimplemented from WatchAction.

Definition at line 236 of file WatchAction.php.

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

◆ onSuccess()

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

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

◆ preText()

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 248 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

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ alterForm()

◆ getDescription()

◆ getName()

◆ onSubmit()

◆ onSuccess()

◆ preText()