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

Inheritance diagram for UnwatchAction:

[legend]

Collaboration diagram for UnwatchAction:

[legend]

Public Member Functions
	__construct (Page $page, IContextSource $context, WatchlistManager $watchlistManager, WatchedItemStore $watchedItemStore)

	doesWrites ()

	getName ()
	Return the name of the action this object responds to.

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

	onSuccess ()
	Show one of 8 possible success messages.

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

Public Member Functions inherited from FormAction
	show ()
	The basic pattern for actions is to display some sort of HTMLForm UI, maybe with some stuff underneath (history etc); to do some processing on submission of that form (delete, protect, etc) and to do something exciting on 'success', be that display something new or redirect to somewhere.

Public Member Functions inherited from Action
	__construct (Page $page, IContextSource $context=null)
	Only public since 1.21.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	getArticle ()
	Get a Article object.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getContext ()
	Get the IContextSource in use here.

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

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

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

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

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

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

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

	getWikiPage ()
	Get a WikiPage object.

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	needsReadRights ()
	Indicates whether this action requires read rights.

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

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

	getFormFields ()
	Get an HTMLForm descriptor array.

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

	getDescription ()
	Returns the description that goes below the `<h1>` element.

	usesOOUI ()
	Whether the form should use OOUI.

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

	postText ()

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

Protected Member Functions inherited from Action
	getHookContainer ()

	getHookRunner ()

	getPageTitle ()
	Returns the name that goes in the `<h1>` page title.

	setHeaders ()
	Set output headers for noindexing etc.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Additional Inherited Members
Static Public Member Functions inherited from WatchAction
static	getExpiryOptions (MessageLocalizer $msgLocalizer, $watchedItem)
	Get options and default for a watchlist expiry select list.

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

static	factory (string $action, Article $article, IContextSource $context=null)
	Get an appropriate Action subclass for the given action.

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

Protected Attributes inherited from WatchAction
string	$expiryFormFieldName = 'expiry'

false WatchedItem	$watchedItem = false

bool	$watchlistExpiry
	The value of the $wgWatchlistExpiry configuration variable.

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

array	$fields
	The fields used to create the HTMLForm.

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

Detailed Description

Page removal from a user's watchlist.

Definition at line 30 of file UnwatchAction.php.

Constructor & Destructor Documentation

◆ __construct()

UnwatchAction::__construct	(	Page	$page,
		IContextSource	$context,
		WatchlistManager	$watchlistManager,
		WatchedItemStore	$watchedItemStore )

Parameters

Page	$page
IContextSource	$context
WatchlistManager	$watchlistManager
WatchedItemStore	$watchedItemStore

Reimplemented from WatchAction.

Definition at line 41 of file UnwatchAction.php.

Member Function Documentation

◆ alterForm()

UnwatchAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Stability: stable: to override

Parameters

HTMLForm $form

Reimplemented from WatchAction.

Definition at line 74 of file UnwatchAction.php.

References HTMLForm\setSubmitTextMsg(), and HTMLForm\setWrapperLegendMsg().

◆ doesWrites()

UnwatchAction::doesWrites ( )

Stability: stable: to override

Returns: bool

Reimplemented from WatchAction.

Definition at line 85 of file UnwatchAction.php.

◆ getFormFields()

UnwatchAction::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Stability: stable: to override

Returns: array

Reimplemented from WatchAction.

Definition at line 64 of file UnwatchAction.php.

References Action\msg().

◆ getName()

UnwatchAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from WatchAction.

Definition at line 51 of file UnwatchAction.php.

◆ onSubmit()

UnwatchAction::onSubmit ( $data )

Process the form on POST submission.

If you don't want to do anything with the form, just return false here.

This method will be passed to the HTMLForm as a submit callback (see HTMLForm::setSubmitCallback) and must return as documented for HTMLForm::trySubmit.

See also: HTMLForm::setSubmitCallback(); HTMLForm::trySubmit()

Parameters

array $data

Returns: bool|string|array|Status Must return as documented for HTMLForm::trySubmit

Reimplemented from WatchAction.

Definition at line 55 of file UnwatchAction.php.

References getAuthority(), and getTitle().

◆ onSuccess()

UnwatchAction::onSuccess ( )

Show one of 8 possible success messages.

The messages are:

addedwatchtext
addedwatchtext-talk
addedwatchindefinitelytext
addedwatchindefinitelytext-talk
addedwatchexpirytext
addedwatchexpirytext-talk
addedwatchexpiryhours
addedwatchexpiryhours-talk

Reimplemented from WatchAction.

Definition at line 80 of file UnwatchAction.php.

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

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

includes/actions/UnwatchAction.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ doesWrites()

◆ getFormFields()

◆ getName()

◆ onSubmit()

◆ onSuccess()