MediaWiki  REL1_31
WatchAction Class Reference

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

Inheritance diagram for WatchAction:
Collaboration diagram for WatchAction:

Public Member Functions

 doesWrites ()
 Indicates whether this action may perform database writes. More...
 
 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...
 
- 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. More...
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Only public since 1.21. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 getContext ()
 Get the IContextSource in use here. 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 ( $key)
 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=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)
 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 ()
 Get an HTMLForm descriptor array. More...
 
 usesOOUI ()
 Whether the form should use OOUI. More...
 
- Protected Member Functions inherited from FormAction
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 postText ()
 
 preText ()
 Add pre- or post-text to the form. More...
 
- 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...
 
 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

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

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

◆ 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$userThe user to check, or null to use the context user
Exceptions
UserBlockedError|ReadOnlyError|PermissionsError

Reimplemented from Action.

Definition at line 48 of file WatchAction.php.

References $user.

◆ 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$titlePage to watch/unwatch
User$userUser who is watching/unwatching
Returns
Status

Definition at line 144 of file WatchAction.php.

References Action\$page, $title, $user, WikiPage\factory(), StatusValue\newFatal(), User\newFatalPermissionDeniedStatus(), StatusValue\newGood(), and Hooks\run().

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$titlePage to watch/unwatch
User$userUser who is watching/unwatching
bool$checkRightsPassed through to $user->addWatch() Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
Returns
Status

Definition at line 116 of file WatchAction.php.

References Action\$page, $title, $user, WikiPage\factory(), StatusValue\newFatal(), User\newFatalPermissionDeniedStatus(), StatusValue\newGood(), and Hooks\run().

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$watchWhether to watch or unwatch the page
Title$titlePage to watch/unwatch
User$userUser who is watching/unwatching
Returns
Status

Definition at line 91 of file WatchAction.php.

References $title, $user, doUnwatch(), doWatch(), User\IGNORE_USER_RIGHTS, and StatusValue\newGood().

Referenced by Article\delete(), MovePageForm\doSubmit(), FileDeleteForm\execute(), ProtectionForm\save(), ApiBase\setWatch(), 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 61 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$titleTitle object of page to unwatch
User$userUser for whom the action is going to be performed
string$actionOptionally override the action to 'watch'
Returns
string Token
Since
1.18

Definition at line 187 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$titleTitle object of page to watch
User$userUser for whom the action is going to be performed
string$actionOptionally override the action to 'unwatch'
Returns
string Token
Since
1.18

Definition at line 170 of file WatchAction.php.

References $user.

Referenced by getUnwatchToken().

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

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

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

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


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