MediaWiki REL1_35
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 getDescription() {
37 return '';
38 }
39
40 public function onSubmit( $data ) {
41 return $this->getWikiPage()->doPurge();
42 }
43
44 public function show() {
45 $this->setHeaders();
46
47 // This will throw exceptions if there's a problem
48 $this->checkCanExecute( $this->getUser() );
49
50 $user = $this->getUser();
51
52 if ( $user->pingLimiter( 'purge' ) ) {
53 // TODO: Display actionthrottledtext
54 return;
55 }
56
57 if ( $this->getRequest()->wasPosted() ) {
58 $this->redirectParams = wfArrayToCgi( array_diff_key(
59 $this->getRequest()->getQueryValues(),
60 [ 'title' => null, 'action' => null ]
61 ) );
62 if ( $this->onSubmit( [] ) ) {
63 $this->onSuccess();
64 }
65 } else {
66 $this->redirectParams = $this->getRequest()->getVal( 'redirectparams', '' );
67 $form = $this->getForm();
68 if ( $form->show() ) {
69 $this->onSuccess();
70 }
71 }
72 }
73
74 protected function usesOOUI() {
75 return true;
76 }
77
78 protected function getFormFields() {
79 return [
80 'intro' => [
81 'type' => 'info',
82 'vertical-label' => true,
83 'raw' => true,
84 'default' => $this->msg( 'confirm-purge-top' )->parse()
85 ]
86 ];
87 }
88
89 protected function alterForm( HTMLForm $form ) {
90 $form->setWrapperLegendMsg( 'confirm-purge-title' );
91 $form->setSubmitTextMsg( 'confirm_purge_button' );
92 }
93
94 protected function postText() {
95 return $this->msg( 'confirm-purge-bottom' )->parse();
96 }
97
98 public function onSuccess() {
99 $this->getOutput()->redirect( $this->getTitle()->getFullURL( $this->redirectParams ) );
100 }
101
102 public function doesWrites() {
103 return true;
104 }
105}
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
getWikiPage()
Get a WikiPage object.
Definition Action.php:278
checkCanExecute(User $user)
Checks if the given user (identified by an object) can perform this action.
Definition Action.php:421
getTitle()
Shortcut to get the Title object from the page.
Definition Action.php:299
getOutput()
Get the OutputPage being used for this instance.
Definition Action.php:239
getUser()
Shortcut to get the User being used for this instance.
Definition Action.php:249
setHeaders()
Set output headers for noindexing etc.
Definition Action.php:482
msg( $key,... $params)
Get a Message object with context set Parameters are the same as wfMessage()
Definition Action.php:311
getRequest()
Get the WebRequest being used for this instance.
Definition Action.php:229
An action which shows a form and does something based on the input from the form.
getForm()
Get the HTMLForm to control behavior Stable to override.
Object handling generic submission, CSRF protection, layout and other logic for UI forms in a reusabl...
Definition HTMLForm.php:135
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 Stable to override.
postText()
Stable to override.
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()
Stable to override.
getFormFields()
Get an HTMLForm descriptor array Stable to override.
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially Stable to override.
onSuccess()
Do something exciting on successful processing of the form.
getName()
Return the name of the action this object responds to.