MediaWiki master
PurgeAction.php
Go to the documentation of this file.
1<?php
26
32class PurgeAction extends FormAction {
33
35 private $redirectParams;
36
37 public function getName() {
38 return 'purge';
39 }
40
41 public function getDescription() {
42 return '';
43 }
44
45 public function onSubmit( $data ) {
46 $authority = $this->getAuthority();
47 $page = $this->getWikiPage();
48
49 $status = PermissionStatus::newEmpty();
50 if ( !$authority->authorizeAction( 'purge', $status ) ) {
51 return Status::wrap( $status );
52 }
53
54 return $page->doPurge();
55 }
56
57 public function show() {
58 $this->setHeaders();
59
60 // This will throw exceptions if there's a problem
61 $this->checkCanExecute( $this->getUser() );
62
63 if ( $this->getRequest()->wasPosted() ) {
64 $this->redirectParams = wfArrayToCgi( array_diff_key(
65 $this->getRequest()->getQueryValues(),
66 [ 'title' => null, 'action' => null ]
67 ) );
68
69 $result = $this->onSubmit( [] );
70 if ( $result === true ) {
71 $this->onSuccess();
72 } elseif ( $result instanceof Status ) {
73 if ( $result->isOK() ) {
74 $this->onSuccess();
75 } else {
76 $this->getOutput()->addHTML( $result->getHTML() );
77 }
78 }
79 } else {
80 $this->redirectParams = $this->getRequest()->getVal( 'redirectparams', '' );
81 $form = $this->getForm();
82 if ( $form->show() ) {
83 $this->onSuccess();
84 }
85 }
86 }
87
88 protected function usesOOUI() {
89 return true;
90 }
91
92 protected function getFormFields() {
93 return [
94 'intro' => [
95 'type' => 'info',
96 'raw' => true,
97 'default' => $this->msg( 'confirm-purge-top' )->parse()
98 ]
99 ];
100 }
101
102 protected function alterForm( HTMLForm $form ) {
103 $form->setWrapperLegendMsg( 'confirm-purge-title' );
104 $form->setSubmitTextMsg( 'confirm_purge_button' );
105 }
106
107 protected function postText() {
108 return $this->msg( 'confirm-purge-bottom' )->parse();
109 }
110
111 public function onSuccess() {
112 $this->getOutput()->redirect( $this->getTitle()->getFullURL( $this->redirectParams ) );
113 }
114
115 public function doesWrites() {
116 return true;
117 }
118}
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:193
checkCanExecute(User $user)
Checks if the given user (identified by an object) can perform this action.
Definition Action.php:328
getTitle()
Shortcut to get the Title object from the page.
Definition Action.php:214
getOutput()
Get the OutputPage being used for this instance.
Definition Action.php:144
getUser()
Shortcut to get the User being used for this instance.
Definition Action.php:154
setHeaders()
Set output headers for noindexing etc.
Definition Action.php:408
msg( $key,... $params)
Get a Message object with context set Parameters are the same as wfMessage()
Definition Action.php:228
getAuthority()
Shortcut to get the Authority executing this instance.
Definition Action.php:164
getRequest()
Get the WebRequest being used for this instance.
Definition Action.php:134
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 in a reusabl...
Definition HTMLForm.php:209
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
A StatusValue for permission errors.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:54
User-requested page cache purging.
usesOOUI()
Whether the form should use OOUI.
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> element.
onSubmit( $data)
Process the form on POST submission.
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.