MediaWiki REL1_33
PurgeAction.php
Go to the documentation of this file.
1<?php
28class PurgeAction extends FormAction {
29
31
32 public function getName() {
33 return 'purge';
34 }
35
36 public function requiresUnblock() {
37 return false;
38 }
39
40 public function getDescription() {
41 return '';
42 }
43
44 public function onSubmit( $data ) {
45 return $this->page->doPurge();
46 }
47
48 public function show() {
49 $this->setHeaders();
50
51 // This will throw exceptions if there's a problem
52 $this->checkCanExecute( $this->getUser() );
53
54 $user = $this->getUser();
55
56 if ( $user->pingLimiter( 'purge' ) ) {
57 // TODO: Display actionthrottledtext
58 return;
59 }
60
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 }
77
78 protected function usesOOUI() {
79 return true;
80 }
81
82 protected function getFormFields() {
83 return [
84 'intro' => [
85 'type' => 'info',
86 'vertical-label' => true,
87 'raw' => true,
88 'default' => $this->msg( 'confirm-purge-top' )->parse()
89 ]
90 ];
91 }
92
93 protected function alterForm( HTMLForm $form ) {
94 $form->setWrapperLegendMsg( 'confirm-purge-title' );
95 $form->setSubmitTextMsg( 'confirm_purge_button' );
96 }
97
98 protected function postText() {
99 return $this->msg( 'confirm-purge-bottom' )->parse();
100 }
101
102 public function onSuccess() {
103 $this->getOutput()->redirect( $this->getTitle()->getFullURL( $this->redirectParams ) );
104 }
105
106 public function doesWrites() {
107 return true;
108 }
109}
target page
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
checkCanExecute(User $user)
Checks if the given user (identified by an object) can perform this action.
Definition Action.php:307
getTitle()
Shortcut to get the Title object from the page.
Definition Action.php:247
getOutput()
Get the OutputPage being used for this instance.
Definition Action.php:208
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition Action.php:257
getUser()
Shortcut to get the User being used for this instance.
Definition Action.php:218
setHeaders()
Set output headers for noindexing etc.
Definition Action.php:359
getRequest()
Get the WebRequest being used for this instance.
Definition Action.php:198
An action which shows a form and does something based on the input from the form.
getForm()
Get the HTMLForm to control behavior.
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition HTMLForm.php:133
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.
User-requested page cache purging.
usesOOUI()
Whether the form should use OOUI.
requiresUnblock()
Whether this action can still be executed by a blocked user.
show()
The basic pattern for actions is to display some sort of HTMLForm UI, maybe with some stuff underneat...
getDescription()
Returns the description that goes below the <h1> tag.
onSubmit( $data)
Process the form on POST submission.
doesWrites()
Indicates whether this action may perform database writes.
getFormFields()
Get an HTMLForm descriptor array.
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
onSuccess()
Do something exciting on successful processing of the form.
getName()
Return the name of the action this object responds to.
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
return true to allow those checks to and false if checking is done & $user
Definition hooks.txt:1510
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:37