RedirectSpecialPage.php

Go to the documentation of this file.

<?php
abstract class RedirectSpecialPage extends UnlistedSpecialPage {
    // Query parameters that can be passed through redirects
    protected $mAllowedRedirectParams = [];

    // Query parameters added by redirects
    protected $mAddedRedirectParams = [];

    public function execute( $subpage ) {
        $redirect = $this->getRedirect( $subpage );
        $query = $this->getRedirectQuery( $subpage );

        if ( $redirect instanceof Title ) {
            // Redirect to a page title with possible query parameters
            $url = $redirect->getFullUrlForRedirect( $query );
            $this->getOutput()->redirect( $url );
        } elseif ( $redirect === true ) {
            // Redirect to index.php with query parameters
            $url = wfAppendQuery( wfScript( 'index' ), $query );
            $this->getOutput()->redirect( $url );
        } else {
            $this->showNoRedirectPage();
        }
    }

    abstract public function getRedirect( $subpage );

    public function getRedirectQuery( $subpage ) {
        $params = [];
        $request = $this->getRequest();

        foreach ( array_merge( $this->mAllowedRedirectParams,
                [ 'uselang', 'useskin', 'debug' ] // parameters which can be passed to all pages
            ) as $arg ) {
            if ( $request->getVal( $arg, null ) !== null ) {
                $params[$arg] = $request->getVal( $arg );
            } elseif ( $request->getArray( $arg, null ) !== null ) {
                $params[$arg] = $request->getArray( $arg );
            }
        }

        foreach ( $this->mAddedRedirectParams as $arg => $val ) {
            $params[$arg] = $val;
        }

        return count( $params )
            ? $params
            : false;
    }

    public function personallyIdentifiableTarget() {
        return false;
    }

    protected function showNoRedirectPage() {
        $class = static::class;
        throw new MWException( "RedirectSpecialPage $class doesn't redirect!" );
    }
}