MediaWiki  master
UnwatchAction Class Reference

Page removal from a user's watchlist. More...

Inheritance diagram for UnwatchAction:
Collaboration diagram for UnwatchAction:

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...
 
- Public Member Functions inherited from WatchAction
 __construct (Page $page, IContextSource $context=null)
 Only public since 1.21. 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
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 getArticle ()
 Get a Article object. 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...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 

Protected Member Functions

 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
- Protected Member Functions inherited from WatchAction
 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...
 
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from WatchAction
static doUnwatch (Title $title, User $user)
 Unwatch a page. More...
 
static doWatch (Title $title, User $user, $checkRights=User::CHECK_USER_RIGHTS, ?string $expiry=null)
 Watch a page. More...
 
static doWatchOrUnwatch ( $watch, Title $title, User $user)
 Watch or unwatch a page. More...
 
static getExpiryOptions (IContextSource $context, $expiryTime=false)
 Get options and default for a watchlist expiry select list. 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 (string $name)
 Check if a given action is recognised, even if it's disabled. More...
 
static factory (?string $action, Page $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 Attributes inherited from WatchAction
string $expiryFormFieldName = 'expiry'
 
false WatchedItem $watchedItem = false
 
bool $watchlistExpiry
 The value of the $wgWatchlistExpiry configuration variable. More...
 
- Protected Attributes inherited from Action
IContextSource $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 removal from a user's watchlist.

Definition at line 28 of file UnwatchAction.php.

Member Function Documentation

◆ alterForm()

UnwatchAction::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Parameters
HTMLForm$form

Reimplemented from WatchAction.

Definition at line 51 of file UnwatchAction.php.

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

◆ doesWrites()

UnwatchAction::doesWrites ( )

Indicates whether this action may perform database writes.

Returns
bool
Since
1.27

Reimplemented from WatchAction.

Definition at line 62 of file UnwatchAction.php.

◆ getFormFields()

UnwatchAction::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Returns
array

Reimplemented from WatchAction.

Definition at line 40 of file UnwatchAction.php.

References Action\msg().

◆ getName()

UnwatchAction::getName ( )

Return the name of the action this object responds to.

Since
1.17
Returns
string Lowercase name

Reimplemented from WatchAction.

Definition at line 30 of file UnwatchAction.php.

◆ onSubmit()

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

Definition at line 34 of file UnwatchAction.php.

References WatchAction\doUnwatch(), Action\getTitle(), and Action\getUser().

◆ onSuccess()

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

Definition at line 57 of file UnwatchAction.php.

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


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