MediaWiki  master
WatchAction Class Reference

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

Inheritance diagram for WatchAction:
Collaboration diagram for WatchAction:

Public Member Functions

 __construct (Page $page, IContextSource $context, WatchlistManager $watchlistManager, WatchedItemStore $watchedItemStore)
 Only public since 1.21. More...
 
 doesWrites ()
 
 getName ()
 Return the name of the action this object responds to. More...
 
 onSubmit ( $data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Show one of 8 possible success messages. 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...
 
 getArticle ()
 Get a Article object. More...
 
 getAuthority ()
 Shortcut to get the Authority executing this instance. 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...
 
 getWikiPage ()
 Get a WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 needsReadRights ()
 Indicates whether this action requires read rights. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 

Static Public Member Functions

static getExpiryOptions (MessageLocalizer $msgLocalizer, $watchedItem)
 Get options and default for a watchlist expiry select list. More...
 
- Static Public Member Functions inherited from Action
static exists (string $name)
 Check if a given action is recognised, even if it's disabled. More...
 
static factory (string $action, Article $article, 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> element. 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
 getHookContainer ()
 
 getHookRunner ()
 
 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...
 

Protected Attributes

string $expiryFormFieldName = 'expiry'
 
false WatchedItem $watchedItem = false
 
bool $watchlistExpiry
 The value of the $wgWatchlistExpiry configuration variable. More...
 
- Protected Attributes inherited from Action
IContextSource null $context
 IContextSource if specified; otherwise we'll use the Context from the Page. More...
 
array $fields
 The fields used to create the HTMLForm. More...
 
WikiPage Article ImagePage CategoryPage Page $page
 Page on which we're performing the action. More...
 

Detailed Description

Page addition to a user's watchlist.

Definition at line 32 of file WatchAction.php.

Constructor & Destructor Documentation

◆ __construct()

WatchAction::__construct ( Page  $page,
IContextSource  $context,
WatchlistManager  $watchlistManager,
WatchedItemStore  $watchedItemStore 
)

Only public since 1.21.

Parameters
Page$page
IContextSource$context
WatchlistManager$watchlistManager
WatchedItemStore$watchedItemStore

Reimplemented in UnwatchAction.

Definition at line 54 of file WatchAction.php.

References Action\$context, Action\$page, Action\getContext(), Action\getTitle(), Action\getUser(), and WatchedItemStore\getWatchedItem().

Member Function Documentation

◆ alterForm()

WatchAction::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Stability: stable
to override
Parameters
HTMLForm$form

Reimplemented from FormAction.

Reimplemented in UnwatchAction.

Definition at line 196 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
Stability: stable
to override
Parameters
User$user
Exceptions
UserBlockedError|ReadOnlyError|PermissionsError

Reimplemented from Action.

Definition at line 97 of file WatchAction.php.

References User\isNamed().

◆ doesWrites()

WatchAction::doesWrites ( )
Stability: stable
to override
Returns
bool

Reimplemented from FormAction.

Reimplemented in UnwatchAction.

Definition at line 247 of file WatchAction.php.

◆ getDescription()

WatchAction::getDescription ( )
protected

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

Since
1.17
Stability: stable
to override
Returns
string HTML

Reimplemented from Action.

Definition at line 80 of file WatchAction.php.

◆ getExpiryOptions()

static WatchAction::getExpiryOptions ( MessageLocalizer  $msgLocalizer,
  $watchedItem 
)
static

Get options and default for a watchlist expiry select list.

If an expiry time is provided, it will be added to the top of the list as 'x days left'.

Since
1.35
Todo:
Move this somewhere better when it's being used in more than just this action.
Parameters
MessageLocalizer$msgLocalizer
WatchedItem | bool$watchedItem
Returns
mixed[] With keys options (string[]) and default (string).

Definition at line 145 of file WatchAction.php.

References $watchedItem, WatchedItem\getExpiry(), and WatchedItem\getExpiryInDaysText().

◆ getFormFields()

WatchAction::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Stability: stable
to override
Returns
array

Reimplemented from FormAction.

Reimplemented in UnwatchAction.

Definition at line 109 of file WatchAction.php.

References Action\getContext(), and 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 72 of file WatchAction.php.

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

References Action\getAuthority(), Action\getRequest(), Action\getTitle(), and Status\wrap().

◆ onSuccess()

WatchAction::onSuccess ( )

Show one of 8 possible success messages.

The messages are:

  1. addedwatchtext
  2. addedwatchtext-talk
  3. addedwatchindefinitelytext
  4. addedwatchindefinitelytext-talk
  5. addedwatchexpirytext
  6. addedwatchexpirytext-talk
  7. addedwatchexpiryhours
  8. addedwatchexpiryhours-talk

Reimplemented from FormAction.

Reimplemented in UnwatchAction.

Definition at line 216 of file WatchAction.php.

References WatchedItem\calculateExpiryInDays(), getContext(), getTitle(), and wfIsInfinity().

◆ requiresUnblock()

WatchAction::requiresUnblock ( )

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

Since
1.17
Stability: stable
to override
Returns
bool

Reimplemented from Action.

Definition at line 76 of file WatchAction.php.

◆ usesOOUI()

WatchAction::usesOOUI ( )
protected

Whether the form should use OOUI.

Stability: stable
to override
Returns
bool

Reimplemented from FormAction.

Definition at line 105 of file WatchAction.php.

Member Data Documentation

◆ $expiryFormFieldName

string WatchAction::$expiryFormFieldName = 'expiry'
protected

Definition at line 38 of file WatchAction.php.

◆ $watchedItem

false WatchedItem WatchAction::$watchedItem = false
protected

Definition at line 41 of file WatchAction.php.

Referenced by getExpiryOptions().

◆ $watchlistExpiry

bool WatchAction::$watchlistExpiry
protected

The value of the $wgWatchlistExpiry configuration variable.

Definition at line 35 of file WatchAction.php.


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