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
|
<?php
/**
* Abstract to simplify creation of redirect special 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.
* http://www.gnu.org/copyleft/gpl.html
*
* @stable to extend
*
* @file
* @ingroup SpecialPage
* @author DannyS712
*/
abstract class SpecialRedirectWithAction extends RedirectSpecialPage {
protected $action, $msgPrefix;
/**
* @stable to call
*
* @param string $name
* @param string $action
* @param string $msgPrefix
*/
public function __construct( $name, $action, $msgPrefix ) {
parent::__construct( $name );
$this->action = $action;
$this->msgPrefix = $msgPrefix;
}
/**
* @inheritDoc
*/
public function getRedirect( $subpage ) {
if ( $subpage === null || $subpage === '' ) {
return false;
}
$this->mAddedRedirectParams['title'] = $subpage;
$this->mAddedRedirectParams['action'] = $this->action;
return true;
}
/**
* @stable to override
*/
protected function showNoRedirectPage() {
$this->setHeaders();
$this->outputHeader();
$this->showForm();
}
private function showForm() {
// Dynamic messages used:
// 'special' . $this->msgPrefix . '-page'
// 'special' . $this->msgPrefix . '-submit'
// Each special page that extends this should include those as comments for grep
$form = HTMLForm::factory( 'ooui', [
'page' => [
'type' => 'text',
'name' => 'page',
'label-message' => 'special' . $this->msgPrefix . '-page',
'required' => true,
],
], $this->getContext(), $this->msgPrefix );
$form->setSubmitTextMsg( 'special' . $this->msgPrefix . '-submit' );
$form->setSubmitCallback( [ $this, 'onFormSubmit' ] );
$form->show();
}
/**
* @stable to override
*
* @param array $formData
*
* @return Status|null
*/
public function onFormSubmit( $formData ) {
$title = $formData['page'];
try {
$page = Title::newFromTextThrow( $title );
} catch ( MalformedTitleException $e ) {
return Status::newFatal( $e->getMessageObject() );
}
$query = [ 'action' => $this->action ];
$url = $page->getFullUrlForRedirect( $query );
$this->getOutput()->redirect( $url );
}
/**
* @stable to override
* @return bool
*/
public function isListed() {
return true;
}
/**
* @stable to override
* @return string
*/
protected function getGroupName() {
return 'redirects';
}
}
|