SpecialRedirectWithAction.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\SpecialPage;
 
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\MediaWikiServices;
use MediaWiki\Status\Status;
use MediaWiki\Title\MalformedTitleException;
use MediaWiki\Title\Title;
use SearchEngineFactory;
 
abstract class SpecialRedirectWithAction extends RedirectSpecialPage {
    protected $action;
 
    protected $msgPrefix;
 
    private $searchEngineFactory;
 
    public function __construct(
        $name,
        $action,
        $msgPrefix,
        SearchEngineFactory $searchEngineFactory = null
    ) {
        parent::__construct( $name );
        $this->action = $action;
        $this->msgPrefix = $msgPrefix;
        if ( !$searchEngineFactory ) {
            // Fallback to global state if the new parameter was not provided
            wfDeprecated( __METHOD__ . ' without providing SearchEngineFactory', '1.39' );
            $searchEngineFactory = MediaWikiServices::getInstance()->getSearchEngineFactory();
        }
        $this->searchEngineFactory = $searchEngineFactory;
    }
 
    public function getRedirect( $subpage ) {
        if ( $subpage === null || $subpage === '' ) {
            return false;
        }
        $this->mAddedRedirectParams['title'] = $subpage;
        $this->mAddedRedirectParams['action'] = $this->action;
        return true;
    }
 
    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();
    }
 
    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 );
    }
 
    public function isListed() {
        return true;
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        return $this->prefixSearchString( $search, $limit, $offset, $this->searchEngineFactory );
    }
 
    protected function getGroupName() {
        return 'redirects';
    }
}
 
class_alias( SpecialRedirectWithAction::class, 'SpecialRedirectWithAction' );