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

Inheritance diagram for WatchAction:

Collaboration diagram for WatchAction:

Public Member Functions
	doesWrites ()

	getName ()

	onSubmit ($data)

	onSuccess ()

	requiresUnblock ()

Public Member Functions inherited from FormAction
	doesWrites ()

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

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

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

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

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

	doesWrites ()
	Indicates whether this action may perform database writes. More...

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

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

	getName ()
	Return the name of the action this object responds to. 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...

	requiresUnblock ()
	Whether this action can still be executed by a blocked user. More...

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

	show ()
	The main action entry point. More...

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

static	doWatch (Title $title, User $user, $checkRights=User::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)

	checkCanExecute (User $user)

	getDescription ()

	preText ()

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

	getForm ()
	Get the HTMLForm to control behavior. More...

	getFormFields ()
	Get an HTMLForm descriptor array. More...

	postText ()

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

Protected Member Functions inherited from Action
	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...

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

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

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

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

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

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

Detailed Description

Page addition to a user's watchlist.

Definition at line 28 of file WatchAction.php.

Member Function Documentation

WatchAction::alterForm ( HTMLForm $form )

protected

Definition at line 60 of file WatchAction.php.

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

WatchAction::checkCanExecute ( User $user )

protected

Definition at line 51 of file WatchAction.php.

References User\isAnon().

WatchAction::doesWrites ( )

Definition at line 184 of file WatchAction.php.

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

References Action\$page, $status, WikiPage\factory(), User\isAllowed(), StatusValue\newFatal(), User\newFatalPermissionDeniedStatus(), StatusValue\newGood(), User\removeWatch(), and Hooks\run().

Referenced by ApiWatch\watchTitle().

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

References Action\$page, $status, User\addWatch(), WikiPage\factory(), User\isAllowed(), StatusValue\newFatal(), User\newFatalPermissionDeniedStatus(), StatusValue\newGood(), and Hooks\run().

Referenced by UploadBase\performUpload(), SpecialBlock\processForm(), and ApiWatch\watchTitle().

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

References User\IGNORE_USER_RIGHTS, User\isLoggedIn(), User\isWatched(), and StatusValue\newGood().

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

WatchAction::getDescription ( )

protected

Returns: string HTML

Definition at line 41 of file WatchAction.php.

References Action\msg().

WatchAction::getName ( )

Definition at line 30 of file WatchAction.php.

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

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'