Page addition to a user's watchlist. More...

Inheritance diagram for WatchAction:

[legend]

Collaboration diagram for WatchAction:

[legend]

Public Member Functions
	doesWrites ()
	Indicates whether this action may perform database writes.

	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.

	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.

	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.

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

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

Static Public Member Functions
static	doUnwatch (Title $title, User $user)
	Unwatch a page.

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

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

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

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

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

static	factory ( $action, Page $page, 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 Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

	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\> tag.

	getFormFields ()
	Get an HTMLForm descriptor array.

	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
	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
Protected Attributes inherited from Action
	$context
	IContextSource if specified; otherwise we'll use the Context from the Page.

	$fields
	The fields used to create the HTMLForm.

	$page
	Page on which we're performing the action.

Detailed Description

Page addition to a user's watchlist.

Definition at line 28 of file WatchAction.php.

Member Function Documentation

◆ alterForm()

WatchAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Parameters

HTMLForm $form

Reimplemented from FormAction.

Reimplemented in UnwatchAction.

Definition at line 70 of file WatchAction.php.

◆ checkCanExecute()

WatchAction::checkCanExecute ( User $user )

protected

Checks if the given user (identified by an object) can perform this action.

Can be overridden by sub-classes with more complicated permissions schemes. Failures here must throw subclasses of ErrorPageError

Since: 1.17

Parameters

User $user The user to check, or null to use the context user

Exceptions

UserBlockedError|ReadOnlyError|PermissionsError

Reimplemented from Action.

Definition at line 46 of file WatchAction.php.

◆ doesWrites()

WatchAction::doesWrites ( )

Indicates whether this action may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from FormAction.

Reimplemented in UnwatchAction.

Definition at line 191 of file WatchAction.php.

◆ doUnwatch()

static WatchAction::doUnwatch	(	Title	$title,
		User	$user )

static

Unwatch a page.

Since: 1.22 Returns Status

Parameters

Title	$title	Page to watch/unwatch
User	$user	User who is watching/unwatching

Returns: Status

Definition at line 142 of file WatchAction.php.

References User\newFatalPermissionDeniedStatus().

Referenced by doWatchOrUnwatch(), UnwatchAction\onSubmit(), and ApiWatch\watchTitle().

◆ doWatch()

static WatchAction::doWatch	(	Title	$title,
		User	$user,
			$checkRights = User::CHECK_USER_RIGHTS )

static

Watch a page.

Since: 1.22 Returns Status, $checkRights parameter added

Parameters

Title	$title	Page to watch/unwatch
User	$user	User who is watching/unwatching
bool	$checkRights	Passed through to $user->addWatch() Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.

Returns: Status

Definition at line 114 of file WatchAction.php.

References User\newFatalPermissionDeniedStatus().

Referenced by doWatchOrUnwatch(), onSubmit(), UploadBase\performUpload(), SpecialBlock\processForm(), ReplaceTextJob\run(), WatchActionTest\testDoWatchCallsUserAddWatch(), WatchActionTest\testDoWatchNoCheckRights(), WatchActionTest\testDoWatchUserNotPermittedStatusNotGood(), and ApiWatch\watchTitle().

◆ doWatchOrUnwatch()

static WatchAction::doWatchOrUnwatch	(		$watch,
		Title	$title,
		User	$user )

static

Watch or unwatch a page.

Since: 1.22

Parameters

bool	$watch	Whether to watch or unwatch the page
Title	$title	Page to watch/unwatch
User	$user	User who is watching/unwatching

Returns: Status

Definition at line 89 of file WatchAction.php.

References doUnwatch(), doWatch(), and User\IGNORE_USER_RIGHTS.

Referenced by Article\delete(), MovePageForm\doSubmit(), FileDeleteForm\execute(), ProtectionForm\save(), ApiBase\setWatch(), WatchActionTest\testDoWatchOrUnwatchSkipsIfAlreadyUnWatched(), WatchActionTest\testDoWatchOrUnwatchSkipsIfAlreadyWatched(), WatchActionTest\testDoWatchOrUnwatchUnwatchesIfUnwatch(), WatchActionTest\testDoWatchOrUnwatchUserNotLoggedIn(), WatchActionTest\testDoWatchOrUnwatchWatchesIfWatch(), and EditPage\updateWatchlist().

◆ getDescription()

WatchAction::getDescription ( )

protected

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

Since: 1.17

Returns: string HTML

Reimplemented from Action.

Definition at line 38 of file WatchAction.php.

◆ getFormFields()

WatchAction::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from FormAction.

Reimplemented in UnwatchAction.

Definition at line 59 of file WatchAction.php.

References Action\msg().

◆ getName()

WatchAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from Action.

Reimplemented in UnwatchAction.

Definition at line 30 of file WatchAction.php.

◆ getUnwatchToken()

static WatchAction::getUnwatchToken	(	Title	$title,
		User	$user,
			$action = 'unwatch' )

static

Get token to unwatch (or watch) a page for a user.

Parameters

Title	$title	Title object of page to unwatch
User	$user	User for whom the action is going to be performed
string	$action	Optionally override the action to 'watch'

Returns: string Token

Since: 1.18

Deprecated: since 1.32 Use WatchAction::getWatchToken() with action 'unwatch' directly.

Definition at line 186 of file WatchAction.php.

References getWatchToken(), and wfDeprecated().

◆ getWatchToken()

static WatchAction::getWatchToken	(	Title	$title,
		User	$user,
			$action = 'watch' )

static

Get token to watch (or unwatch) a page for a user.

Parameters

Title	$title	Title object of page to watch
User	$user	User for whom the action is going to be performed
string	$action	Optionally override the action to 'unwatch'

Returns: string Token

Since: 1.18

Definition at line 168 of file WatchAction.php.

Referenced by getUnwatchToken(), WatchActionTest\testGetWatchTokenNormalizesToWatch(), and WatchActionTest\testGetWatchTokenProxiesUserGetEditToken().

◆ onSubmit()

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

Reimplemented in UnwatchAction.

Definition at line 42 of file WatchAction.php.

References doWatch(), Action\getTitle(), and Action\getUser().

◆ onSuccess()

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

Reimplemented in UnwatchAction.

Definition at line 76 of file WatchAction.php.

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

Referenced by WatchActionTest\testOnSuccessMainNamespaceTitle(), and WatchActionTest\testOnSuccessTalkPage().

◆ requiresUnblock()

WatchAction::requiresUnblock ( )

Whether this action can still be executed by a blocked user.

Since: 1.17

Returns: bool

Reimplemented from Action.

Definition at line 34 of file WatchAction.php.

◆ usesOOUI()

WatchAction::usesOOUI ( )

protected

Whether the form should use OOUI.

Returns: bool

Reimplemented from FormAction.

Definition at line 55 of file WatchAction.php.

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

includes/actions/WatchAction.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ alterForm()

◆ checkCanExecute()

◆ doesWrites()

◆ doUnwatch()

◆ doWatch()

◆ doWatchOrUnwatch()

◆ getDescription()

◆ getFormFields()

◆ getName()

◆ getUnwatchToken()

◆ getWatchToken()

◆ onSubmit()

◆ onSuccess()

◆ requiresUnblock()

◆ usesOOUI()