CategoryPage.php

Go to the documentation of this file.

<?php
class CategoryPage extends Article {
    # Subclasses can change this to override the viewer class.
    protected $mCategoryViewerClass = CategoryViewer::class;

    protected function newPage( Title $title ) {
        // Overload mPage with a category-specific page
        return new WikiCategoryPage( $title );
    }

    function view() {
        $request = $this->getContext()->getRequest();
        $diff = $request->getVal( 'diff' );
        $diffOnly = $request->getBool( 'diffonly',
            $this->getContext()->getUser()->getOption( 'diffonly' ) );

        if ( $diff !== null && $diffOnly ) {
            parent::view();
            return;
        }

        // Avoid PHP 7.1 warning of passing $this by reference
        $categoryPage = $this;

        if ( !Hooks::run( 'CategoryPageView', [ &$categoryPage ] ) ) {
            return;
        }

        $title = $this->getTitle();
        if ( $title->inNamespace( NS_CATEGORY ) ) {
            $this->openShowCategory();
        }

        parent::view();

        if ( $title->inNamespace( NS_CATEGORY ) ) {
            $this->closeShowCategory();
        }

        # Use adaptive TTLs for CDN so delayed/failed purges are noticed less often
        $outputPage = $this->getContext()->getOutput();
        $outputPage->adaptCdnTTL( $this->mPage->getTouched(), IExpiringStore::TTL_MINUTE );
    }

    function openShowCategory() {
        # For overloading
    }

    function closeShowCategory() {
        // Use these as defaults for back compat --catrope
        $request = $this->getContext()->getRequest();
        $oldFrom = $request->getVal( 'from' );
        $oldUntil = $request->getVal( 'until' );

        $reqArray = $request->getValues();

        $from = $until = [];
        foreach ( [ 'page', 'subcat', 'file' ] as $type ) {
            $from[$type] = $request->getVal( "{$type}from", $oldFrom );
            $until[$type] = $request->getVal( "{$type}until", $oldUntil );

            // Do not want old-style from/until propagating in nav links.
            if ( !isset( $reqArray["{$type}from"] ) && isset( $reqArray["from"] ) ) {
                $reqArray["{$type}from"] = $reqArray["from"];
            }
            if ( !isset( $reqArray["{$type}to"] ) && isset( $reqArray["to"] ) ) {
                $reqArray["{$type}to"] = $reqArray["to"];
            }
        }

        unset( $reqArray["from"] );
        unset( $reqArray["to"] );

        $viewer = new $this->mCategoryViewerClass(
            $this->getContext()->getTitle(),
            $this->getContext(),
            $from,
            $until,
            $reqArray
        );
        $out = $this->getContext()->getOutput();
        $out->addHTML( $viewer->getHTML() );
        $this->addHelpLink( 'Help:Categories' );
    }

    function getCategoryViewerClass() {
        return $this->mCategoryViewerClass;
    }

    function setCategoryViewerClass( $class ) {
        $this->mCategoryViewerClass = $class;
    }
}