MediaWiki  1.30.0
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()
Indicates whether this action may perform database writes.
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:146
UnwatchAction\alterForm
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
Definition: UnwatchAction.php:51
WatchAction
Page addition to a user's watchlist.
Definition: WatchAction.php:28
UnwatchAction
Page removal from a user's watchlist.
Definition: UnwatchAction.php:28
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
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\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: Action.php:256
Action\getUser
getUser()
Shortcut to get the User being used for this instance.
Definition: Action.php:217
Action\getTitle
getTitle()
Shortcut to get the Title object from the page.
Definition: Action.php:246
UnwatchAction\getFormFields
getFormFields()
Get an HTMLForm descriptor array.
Definition: UnwatchAction.php:40
HTMLForm\setSubmitTextMsg
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1365
HTMLForm\setWrapperLegendMsg
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.
Definition: HTMLForm.php:1539
Action\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: Action.php:207
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:128