SpecialPageAction.php

Go to the documentation of this file.

<?php
use MediaWiki\SpecialPage\SpecialPageFactory;
 
class SpecialPageAction extends FormlessAction {
    public static $actionToSpecialPageMapping = [
        'revisiondelete' => 'Revisiondelete',
        'editchangetags' => 'EditTags',
    ];
 
    private $specialPageFactory;
 
    private $actionName;
 
    public function __construct(
        Page $page,
        IContextSource $context,
        SpecialPageFactory $specialPageFactory,
        string $actionName
    ) {
        parent::__construct( $page, $context );
        $this->specialPageFactory = $specialPageFactory;
        if ( !isset( self::$actionToSpecialPageMapping[$actionName] ) ) {
            throw new InvalidArgumentException(
                __CLASS__ . " does not support the action $actionName"
            );
        }
        $this->actionName = $actionName;
    }
 
    public function getName() {
        return $this->actionName;
    }
 
    public function requiresUnblock() {
        return false;
    }
 
    public function getDescription() {
        return '';
    }
 
    public function onView() {
        return '';
    }
 
    public function show() {
        $special = $this->getSpecialPage();
        if ( !$special ) {
            throw new ErrorPageError(
                $this->msg( 'nosuchaction' ), $this->msg( 'nosuchactiontext' ) );
        }
 
        $special->setContext( $this->getContext() );
        $special->getContext()->setTitle( $special->getPageTitle() );
        $special->run( '' );
    }
 
    public function doesWrites() {
        $special = $this->getSpecialPage();
 
        return $special ? $special->doesWrites() : false;
    }
 
    protected function getSpecialPage() {
        // map actions to (allowed) special pages
        return $this->specialPageFactory->getPage(
            self::$actionToSpecialPageMapping[$this->actionName]
        );
    }
}