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

Inheritance diagram for WatchAction:

[legend]

Collaboration diagram for WatchAction:

[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...

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

Static Public Member Functions
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 Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially. More...

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

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

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

	preText ()
	Add pre- or post-text to the form. 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
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 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 208 of file WatchAction.php.

References $form.

◆ 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

Parameters

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

Exceptions

UserBlockedError|ReadOnlyError|PermissionsError

Returns: bool True on success

Reimplemented from Action.

Definition at line 82 of file WatchAction.php.

References $user, array(), getName(), Action\getPageTitle(), SpecialPage\getTitleFor(), Linker\linkKnown(), and Action\msg().

Referenced by show().

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

References Action\$page, $title, $user, array(), WikiPage\factory(), Status\newFatal(), User\newFatalPermissionDeniedStatus(), Status\newGood(), and wfRunHooks().

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

◆ doWatch()

static WatchAction::doWatch	(	Title	$title,
		User	$user,
			$checkRights = `WatchedItem::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
int	$checkRights	Passed through to $user->addWatch()

Returns: Status

Definition at line 130 of file WatchAction.php.

References Action\$page, $title, $user, array(), WikiPage\factory(), WatchedItem\IGNORE_USER_RIGHTS, Status\newFatal(), User\newFatalPermissionDeniedStatus(), Status\newGood(), and wfRunHooks().

Referenced by doWatchOrUnwatch(), onSubmit(), UploadBase\performUpload(), SpecialBlock\processForm(), 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 106 of file WatchAction.php.

References $title, $user, doUnwatch(), doWatch(), WatchedItem\IGNORE_USER_RIGHTS, and Status\newGood().

Referenced by Article\delete(), MovePageForm\doSubmit(), FileDeleteForm\execute(), and ProtectionForm\save().

◆ getDescription()

WatchAction::getDescription ( )

protected

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

Returns: string

Reimplemented from Action.

Reimplemented in UnwatchAction.

Definition at line 38 of file WatchAction.php.

References Action\msg().

◆ getFormFields()

WatchAction::getFormFields ( )

protected

Just get an empty form with a single submit button.

Returns: array

Reimplemented from FormAction.

Definition at line 46 of file WatchAction.php.

References array().

◆ getName()

WatchAction::getName ( )

Return the name of the action this object responds to.

Returns: string Lowercase name

Reimplemented from Action.

Reimplemented in UnwatchAction.

Definition at line 30 of file WatchAction.php.

Referenced by checkCanExecute(), and show().

◆ 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

Definition at line 204 of file WatchAction.php.

References $title, $user, and getWatchToken().

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

References $title, $user, and array().

Referenced by SkinTemplate\buildContentNavigationUrls(), UnwatchedpagesPage\formatResult(), and getUnwatchToken().

◆ onSubmit()

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

Reimplemented in UnwatchAction.

Definition at line 50 of file WatchAction.php.

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

Referenced by show().

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

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

Referenced by show().

◆ preText()

WatchAction::preText ( )

protected

Add pre- or post-text to the form.

Returns: string HTML which will be sent to $form->addPreText()

Reimplemented from FormAction.

Reimplemented in UnwatchAction.

Definition at line 212 of file WatchAction.php.

References Action\msg().

◆ requiresUnblock()

WatchAction::requiresUnblock ( )

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

Returns: bool

Reimplemented from Action.

Definition at line 34 of file WatchAction.php.

◆ show()

WatchAction::show ( )

This can be either formed or formless depending on the session token given.

Reimplemented from FormAction.

Definition at line 61 of file WatchAction.php.

References $form, $user, array(), checkCanExecute(), FormAction\getForm(), getName(), Action\getTitle(), Action\getUser(), onSubmit(), onSuccess(), and Action\setHeaders().

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

◆ doUnwatch()

◆ doWatch()

◆ doWatchOrUnwatch()

◆ getDescription()

◆ getFormFields()

◆ getName()

◆ getUnwatchToken()

◆ getWatchToken()

◆ onSubmit()

◆ onSuccess()

◆ preText()

◆ requiresUnblock()

◆ show()