CategoryTreePage.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
class CategoryTreePage extends SpecialPage {
    public $target = '';
 
    public $tree = null;
 
    public function __construct() {
        parent::__construct( 'CategoryTree' );
    }
 
    private function getOption( $name ) {
        global $wgCategoryTreeDefaultOptions;
 
        if ( $this->tree ) {
            return $this->tree->getOption( $name );
        } else {
            return $wgCategoryTreeDefaultOptions[$name];
        }
    }
 
    public function execute( $par ) {
        global $wgCategoryTreeDefaultOptions, $wgCategoryTreeSpecialPageOptions;
 
        $this->setHeaders();
        $this->addHelpLink( 'Extension:CategoryTree' );
        $request = $this->getRequest();
        if ( $par ) {
            $this->target = $par;
        } else {
            $this->target = $request->getVal( 'target' );
            if ( $this->target === null ) {
                $rootcategory = $this->msg( 'rootcategory' );
                if ( $rootcategory->exists() ) {
                    $this->target = $rootcategory->text();
                }
            }
        }
 
        $this->target = trim( $this->target );
 
        $options = [];
 
        # grab all known options from the request. Normalization is done by the CategoryTree class
        foreach ( $wgCategoryTreeDefaultOptions as $option => $default ) {
            if ( isset( $wgCategoryTreeSpecialPageOptions[$option] ) ) {
                $default = $wgCategoryTreeSpecialPageOptions[$option];
            }
 
            $options[$option] = $request->getVal( $option, $default );
        }
 
        $this->tree = new CategoryTree( $options );
 
        $output = $this->getOutput();
        $output->addWikiMsg( 'categorytree-header' );
 
        $this->executeInputForm();
 
        if ( $this->target !== '' && $this->target !== null ) {
            if ( !CategoryTreeHooks::shouldForceHeaders() ) {
                CategoryTree::setHeaders( $output );
            }
 
            $title = CategoryTree::makeTitle( $this->target );
 
            if ( $title && $title->getArticleID() ) {
                $output->addHTML( Xml::openElement( 'div', [ 'class' => 'CategoryTreeParents' ] ) );
                $output->addHTML( $this->msg( 'categorytree-parents' )->parse() );
                $output->addHTML( $this->msg( 'colon-separator' )->escaped() );
 
                $parents = $this->tree->renderParents( $title );
 
                if ( $parents == '' ) {
                    $output->addHTML( $this->msg( 'categorytree-no-parent-categories' )->parse() );
                } else {
                    $output->addHTML( $parents );
                }
 
                $output->addHTML( Xml::closeElement( 'div' ) );
 
                $output->addHTML( Xml::openElement( 'div', [ 'class' => 'CategoryTreeResult' ] ) );
                $output->addHTML( $this->tree->renderNode( $title, 1 ) );
                $output->addHTML( Xml::closeElement( 'div' ) );
            } else {
                $output->addHTML( Xml::openElement( 'div', [ 'class' => 'CategoryTreeNotice' ] ) );
                $output->addHTML( $this->msg( 'categorytree-not-found', $this->target )->parse() );
                $output->addHTML( Xml::closeElement( 'div' ) );
            }
        }
    }
 
    private function executeInputForm() {
        $namespaces = $this->getRequest()->getVal( 'namespaces', '' );
        // mode may be overriden by namespaces option
        $mode = ( $namespaces == '' ? $this->getOption( 'mode' ) : CategoryTreeMode::ALL );
        if ( $mode == CategoryTreeMode::CATEGORIES ) {
            $modeDefault = 'categories';
        } elseif ( $mode == CategoryTreeMode::PAGES ) {
            $modeDefault = 'pages';
        } else {
            $modeDefault = 'all';
        }
 
        $formDescriptor = [
            'category' => [
                'type' => 'title',
                'name' => 'target',
                'label-message' => 'categorytree-category',
                'namespace' => NS_CATEGORY,
            ],
 
            'mode' => [
                'type' => 'select',
                'name' => 'mode',
                'label-message' => 'categorytree-mode-label',
                'options-messages' => [
                    'categorytree-mode-categories' => 'categories',
                    'categorytree-mode-pages' => 'pages',
                    'categorytree-mode-all' => 'all',
                ],
                'default' => $modeDefault,
                'nodata' => true,
            ],
 
            'namespace' => [
                'type' => 'namespaceselect',
                'name' => 'namespaces',
                'label-message' => 'namespace',
                'all' => '',
            ],
        ];
 
        HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
            ->addHiddenFields( [ 'title' => $this->getPageTitle()->getPrefixedDbKey() ] )
            ->setWrapperLegendMsg( 'categorytree-legend' )
            ->setSubmitTextMsg( 'categorytree-go' )
            ->setMethod( 'get' )
            ->prepareForm()
            ->displayForm( false );
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $title = Title::newFromText( $search, NS_CATEGORY );
        if ( $title && $title->getNamespace() !== NS_CATEGORY ) {
            // Someone searching for something like "Wikipedia:Foo"
            $title = Title::makeTitleSafe( NS_CATEGORY, $search );
        }
        if ( !$title ) {
            // No prefix suggestion outside of category namespace
            return [];
        }
        $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
        $searchEngine->setLimitOffset( $limit, $offset );
        // Autocomplete subpage the same as a normal search, but just for categories
        $searchEngine->setNamespaces( [ NS_CATEGORY ] );
        $result = $searchEngine->defaultPrefixSearch( $search );
 
        return array_map( function ( Title $t ) {
            // Remove namespace in search suggestion
            return $t->getText();
        }, $result );
    }
 
    protected function getGroupName() {
        return 'pages';
    }
 
}