3 * Base classes for actions done on pages.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 * @defgroup Actions Action done on pages
27 * An action which just does something, without showing a form first.
29 abstract class FormlessAction
extends Action
{
32 * Show something on GET request.
33 * @return string|null Will be added to the HTMLForm if present, or just added to the
34 * output if not. Return null to not add anything
36 abstract public function onView();
38 public function show() {
41 // This will throw exceptions if there's a problem
42 $this->checkCanExecute( $this->getUser() );
44 $this->getOutput()->addHTML( $this->onView() );
48 * Execute the action silently, not giving any output. Since these actions don't have
49 * forms, they probably won't have any data, but some (eg rollback) may do
50 * @param array $data Values that would normally be in the GET request
51 * @param bool $captureErrors Whether to catch exceptions and just return false
52 * @throws ErrorPageError|Exception
53 * @return bool Whether execution was successful
55 public function execute( array $data = null, $captureErrors = true ) {
57 // Set a new context so output doesn't leak.
58 $this->context
= clone $this->getContext();
59 if ( is_array( $data ) ) {
60 $this->context
->setRequest( new FauxRequest( $data, false ) );
63 // This will throw exceptions if there's a problem
64 $this->checkCanExecute( $this->getUser() );
69 catch ( ErrorPageError
$e ) {
70 if ( $captureErrors ) {