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

Collaboration diagram for MediaWiki\Actions\UnwatchAction:

[legend]

Public Member Functions

__construct (Article $article, IContextSource $context, WatchlistManager $watchlistManager, WatchedItemStore $watchedItemStore, UserOptionsLookup $userOptionsLookup)

doesWrites ()

Stability: stable: to override

Returns: bool

getName ()

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

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

onSuccess ()

Show one of 8 possible success messages.The messages are:

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

Public Member Functions inherited from MediaWiki\Actions\WatchAction

__construct (Article $article, IContextSource $context, WatchlistManager $watchlistManager, WatchedItemStoreInterface $watchedItemStore, UserOptionsLookup $userOptionsLookup)

Only public since 1.21.

getRestriction ()

Get the permission required to perform this action.Often, but not always, the same as the action nameImplementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.

Since: 1.17

Stability: stable: to override

Returns: string|null

requiresUnblock ()

Whether this action can still be executed by a blocked user.Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.

Since: 1.17

Stability: stable: to override

Returns: bool

Public Member Functions inherited from MediaWiki\Actions\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 MediaWiki\Actions\Action

__construct (Article $article, IContextSource $context)

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.

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 ()

Indicates whether this action page write access to the wiki.

setHookContainer (HookContainer $hookContainer)

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

	getFormFields ()
	Get an HTMLForm descriptor array. Stability: stable to override Returns array

Protected Member Functions inherited from MediaWiki\Actions\WatchAction
	checkCanExecute (User $user)

	getDescription ()
	Returns the description that goes below the `<h1>` element. Since 1.17 Stability: stable to override Returns string HTML

	makeSuccessMessage (string $submittedExpiry)

	usesOOUI ()
	Whether the form should use OOUI. Stability: stable to override Returns bool

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

	postText ()

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

Protected Member Functions inherited from MediaWiki\Actions\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 MediaWiki\Actions\WatchAction
static	getExpiryOptions (MessageLocalizer $msgLocalizer, $watchedItem, string $defaultExpiry='infinite')
	Get options and default for a watchlist expiry select list.

static	getExpiryOptionsFromMessage (MessageLocalizer $msgLocalizer, ?string $lang=null)
	Parse expiry options message.

Static Public Member Functions inherited from MediaWiki\Actions\Action
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 MediaWiki\Actions\WatchAction
string	$expiryFormFieldName = 'expiry'

false WatchedItem	$watchedItem = false

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

Protected Attributes inherited from MediaWiki\Actions\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.

Detailed Description

Page removal from a user's watchlist.

Definition at line 24 of file UnwatchAction.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Actions\UnwatchAction::__construct	(	Article	$article,
		IContextSource	$context,
		WatchlistManager	$watchlistManager,
		WatchedItemStore	$watchedItemStore,
		UserOptionsLookup	$userOptionsLookup )

Parameters

Article	$article
IContextSource	$context
WatchlistManager	$watchlistManager
WatchedItemStore	$watchedItemStore
UserOptionsLookup	$userOptionsLookup

Definition at line 35 of file UnwatchAction.php.

References MediaWiki\Actions\Action\$context.

Member Function Documentation

◆ alterForm()

MediaWiki\Actions\UnwatchAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Stability: stable: to override

Parameters

HTMLForm $form

Reimplemented from MediaWiki\Actions\WatchAction.

Definition at line 72 of file UnwatchAction.php.

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

◆ doesWrites()

MediaWiki\Actions\UnwatchAction::doesWrites ( )

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Actions\WatchAction.

Definition at line 85 of file UnwatchAction.php.

◆ getFormFields()

MediaWiki\Actions\UnwatchAction::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Actions\WatchAction.

Definition at line 62 of file UnwatchAction.php.

References MediaWiki\Actions\Action\msg().

◆ getName()

MediaWiki\Actions\UnwatchAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from MediaWiki\Actions\WatchAction.

Definition at line 47 of file UnwatchAction.php.

◆ onSubmit()

MediaWiki\Actions\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.