MediaWiki  master
UnwatchAction.php
Go to the documentation of this file.
1 <?php
28 class UnwatchAction extends WatchAction {
29 
30  public function getName() {
31  return 'unwatch';
32  }
33 
34  public function onSubmit( $data ) {
35  self::doUnwatch( $this->getTitle(), $this->getUser() );
36 
37  return true;
38  }
39 
40  protected function getFormFields() {
41  return [
42  'intro' => [
43  'type' => 'info',
44  'vertical-label' => true,
45  'raw' => true,
46  'default' => $this->msg( 'confirm-unwatch-top' )->parse()
47  ]
48  ];
49  }
50 
51  protected function alterForm( HTMLForm $form ) {
52  parent::alterForm( $form );
53  $form->setWrapperLegendMsg( 'removewatch' );
54  $form->setSubmitTextMsg( 'confirm-unwatch-button' );
55  }
56 
57  public function onSuccess() {
58  $msgKey = $this->getTitle()->isTalkPage() ? 'removedwatchtext-talk' : 'removedwatchtext';
59  $this->getOutput()->addWikiMsg( $msgKey, $this->getTitle()->getPrefixedText() );
60  }
61 
62  public function doesWrites() {
63  return true;
64  }
65 }
UnwatchAction\doesWrites
doesWrites()
Stable to override.
Definition: UnwatchAction.php:62
UnwatchAction\onSuccess
onSuccess()
Do something exciting on successful processing of the form.
Definition: UnwatchAction.php:57
WatchAction\doUnwatch
static doUnwatch(Title $title, User $user)
Unwatch a page.
Definition: WatchAction.php:249
UnwatchAction\alterForm
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially Stable to override.
Definition: UnwatchAction.php:51
WatchAction
Page addition to a user's watchlist.
Definition: WatchAction.php:31
UnwatchAction
Page removal from a user's watchlist.
Definition: UnwatchAction.php:28
UnwatchAction\getName
getName()
Return the name of the action this object responds to.
Definition: UnwatchAction.php:30
UnwatchAction\onSubmit
onSubmit( $data)
Process the form on POST submission.
Definition: UnwatchAction.php:34
Action\getUser
getUser()
Shortcut to get the User being used for this instance.
Definition: Action.php:249
Action\getTitle
getTitle()
Shortcut to get the Title object from the page.
Definition: Action.php:299
UnwatchAction\getFormFields
getFormFields()
Get an HTMLForm descriptor array Stable to override.
Definition: UnwatchAction.php:40
HTMLForm\setSubmitTextMsg
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1407
Action\msg
msg( $key,... $params)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: Action.php:311
HTMLForm\setWrapperLegendMsg
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.
Definition: HTMLForm.php:1594
Action\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: Action.php:239
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms in a reusabl...
Definition: HTMLForm.php:135