MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
28 class PurgeAction extends FormAction {
30  private $redirectParams;
32  public function getName() {
33  return 'purge';
34  }
36  public function requiresUnblock() {
37  return false;
38  }
40  public function getDescription() {
41  return '';
42  }
44  public function onSubmit( $data ) {
45  return $this->page->doPurge( WikiPage::PURGE_ALL );
46  }
48  public function show() {
49  $this->setHeaders();
51  // This will throw exceptions if there's a problem
52  $this->checkCanExecute( $this->getUser() );
54  $user = $this->getUser();
56  if ( $user->pingLimiter( 'purge' ) ) {
57  // TODO: Display actionthrottledtext
58  return;
59  }
61  if ( $this->getRequest()->wasPosted() ) {
62  $this->redirectParams = wfArrayToCgi( array_diff_key(
63  $this->getRequest()->getQueryValues(),
64  [ 'title' => null, 'action' => null ]
65  ) );
66  if ( $this->onSubmit( [] ) ) {
67  $this->onSuccess();
68  }
69  } else {
70  $this->redirectParams = $this->getRequest()->getVal( 'redirectparams', '' );
71  $form = $this->getForm();
72  if ( $form->show() ) {
73  $this->onSuccess();
74  }
75  }
76  }
78  protected function alterForm( HTMLForm $form ) {
79  $form->setSubmitTextMsg( 'confirm_purge_button' );
80  }
82  protected function preText() {
83  return $this->msg( 'confirm-purge-top' )->parse();
84  }
86  protected function postText() {
87  return $this->msg( 'confirm-purge-bottom' )->parse();
88  }
90  public function onSuccess() {
91  $this->getOutput()->redirect( $this->getTitle()->getFullURL( $this->redirectParams ) );
92  }
94  public function doesWrites() {
95  return true;
96  }
97 }
Get the HTMLForm to control behavior.
Definition: FormAction.php:65
Definition: WikiPage.php:89
Get the OutputPage being used for this instance.
Definition: Action.php:207
Shortcut to get the Title object from the page.
Definition: Action.php:246
Shortcut to get the User being used for this instance.
Definition: Action.php:217
Definition: PurgeAction.php:44
An action which shows a form and does something based on the input from the form. ...
Definition: FormAction.php:28
Set the text for the submit button to a message.
Definition: HTMLForm.php:1348
Set output headers for noindexing etc.
Definition: Action.php:355
Object handling generic submission, CSRF protection, layout and other logic for UI forms...
Definition: HTMLForm.php:128
checkCanExecute(User $user)
Checks if the given user (identified by an object) can perform this action.
Definition: Action.php:308
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
User-requested page cache purging.
Definition: PurgeAction.php:28
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
wfArrayToCgi($array1, $array2=null, $prefix= '')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
alterForm(HTMLForm $form)
Definition: PurgeAction.php:78
Get a Message object with context set Parameters are the same as wfMessage()
Definition: Action.php:256
Get the WebRequest being used for this instance.
Definition: Action.php:197
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk page
Definition: hooks.txt:2491