MediaWiki REL1_31
UnwatchAction.php
Go to the documentation of this file.
1<?php
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}
getTitle()
Shortcut to get the Title object from the page.
Definition Action.php:246
getOutput()
Get the OutputPage being used for this instance.
Definition Action.php:207
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition Action.php:256
getUser()
Shortcut to get the User being used for this instance.
Definition Action.php:217
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition HTMLForm.php:130
Page removal from a user's watchlist.
onSubmit( $data)
Process the form on POST submission.
getFormFields()
Get an HTMLForm descriptor array.
doesWrites()
Indicates whether this action may perform database writes.
getName()
Return the name of the action this object responds to.
onSuccess()
Do something exciting on successful processing of the form.
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
Page addition to a user's watchlist.
static doUnwatch(Title $title, User $user)
Unwatch a page.