1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
<?php
/**
* Base classes for actions done on pages.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*
* @file
* @ingroup Actions
*/
/**
* An action which shows a form and does something based on the input from the form
*
* @ingroup Actions
*/
abstract class FormAction extends Action {
/**
* Get an HTMLForm descriptor array
* @return array
*/
protected function getFormFields() {
// Default to an empty form with just a submit button
return [];
}
/**
* Add pre- or post-text to the form
* @return string HTML which will be sent to $form->addPreText()
*/
protected function preText() {
return '';
}
/**
* @return string
*/
protected function postText() {
return '';
}
/**
* Play with the HTMLForm if you need to more substantially
* @param HTMLForm $form
*/
protected function alterForm( HTMLForm $form ) {
}
/**
* Whether the form should use OOUI
* @return bool
*/
protected function usesOOUI() {
return false;
}
/**
* Get the HTMLForm to control behavior
* @return HTMLForm|null
*/
protected function getForm() {
$this->fields = $this->getFormFields();
// Give hooks a chance to alter the form, adding extra fields or text etc
Hooks::run( 'ActionModifyFormFields', [ $this->getName(), &$this->fields, $this->page ] );
if ( $this->usesOOUI() ) {
$form = HTMLForm::factory( 'ooui', $this->fields, $this->getContext(), $this->getName() );
} else {
$form = new HTMLForm( $this->fields, $this->getContext(), $this->getName() );
}
$form->setSubmitCallback( [ $this, 'onSubmit' ] );
$title = $this->getTitle();
$form->setAction( $title->getLocalURL( [ 'action' => $this->getName() ] ) );
// Retain query parameters (uselang etc)
$params = array_diff_key(
$this->getRequest()->getQueryValues(),
[ 'action' => null, 'title' => null ]
);
if ( $params ) {
$form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
}
$form->addPreText( $this->preText() );
$form->addPostText( $this->postText() );
$this->alterForm( $form );
// Give hooks a chance to alter the form, adding extra fields or text etc
Hooks::run( 'ActionBeforeFormDisplay', [ $this->getName(), &$form, $this->page ] );
return $form;
}
/**
* Process the form on POST submission.
*
* If you don't want to do anything with the form, just return false here.
*
* @param array $data
* @return bool|array True for success, false for didn't-try, array of errors on failure
*/
abstract public function onSubmit( $data );
/**
* Do something exciting on successful processing of the form. This might be to show
* a confirmation message (watch, rollback, etc) or to redirect somewhere else (edit,
* protect, etc).
*/
abstract public function onSuccess();
/**
* The basic pattern for actions is to display some sort of HTMLForm UI, maybe with
* some stuff underneath (history etc); to do some processing on submission of that
* form (delete, protect, etc) and to do something exciting on 'success', be that
* display something new or redirect to somewhere. Some actions have more exotic
* behavior, but that's what subclassing is for :D
*/
public function show() {
$this->setHeaders();
// This will throw exceptions if there's a problem
$this->checkCanExecute( $this->getUser() );
$form = $this->getForm();
if ( $form->show() ) {
$this->onSuccess();
}
}
public function doesWrites() {
return true;
}
}
|
