includes/page/CategoryPage.php

   1 <?php
   2 /**
   3  * Special handling for category description pages.
   4  * Modelled after ImagePage.php.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  */
  23
  24 /**
  25  * Special handling for category description pages, showing pages,
  26  * subcategories and file that belong to the category
  27  *
  28  * @property WikiCategoryPage $mPage Set by overwritten newPage() in this class
  29  */
  30 class CategoryPage extends Article {
  31         # Subclasses can change this to override the viewer class.
  32         protected $mCategoryViewerClass = CategoryViewer::class;
  33
  34         /**
  35          * @param Title $title
  36          * @return WikiCategoryPage
  37          */
  38         protected function newPage( Title $title ) {
  39                 // Overload mPage with a category-specific page
  40                 return new WikiCategoryPage( $title );
  41         }
  42
  43         function view() {
  44                 $request = $this->getContext()->getRequest();
  45                 $diff = $request->getVal( 'diff' );
  46                 $diffOnly = $request->getBool( 'diffonly',
  47                         $this->getContext()->getUser()->getOption( 'diffonly' ) );
  48
  49                 if ( $diff !== null && $diffOnly ) {
  50                         parent::view();
  51                         return;
  52                 }
  53
  54                 // Avoid PHP 7.1 warning of passing $this by reference
  55                 $categoryPage = $this;
  56
  57                 if ( !Hooks::run( 'CategoryPageView', [ &$categoryPage ] ) ) {
  58                         return;
  59                 }
  60
  61                 $title = $this->getTitle();
  62                 if ( $title->inNamespace( NS_CATEGORY ) ) {
  63                         $this->openShowCategory();
  64                 }
  65
  66                 parent::view();
  67
  68                 if ( $title->inNamespace( NS_CATEGORY ) ) {
  69                         $this->closeShowCategory();
  70                 }
  71
  72                 # Use adaptive TTLs for CDN so delayed/failed purges are noticed less often
  73                 $outputPage = $this->getContext()->getOutput();
  74                 $outputPage->adaptCdnTTL( $this->mPage->getTouched(), IExpiringStore::TTL_MINUTE );
  75         }
  76
  77         function openShowCategory() {
  78                 # For overloading
  79         }
  80
  81         function closeShowCategory() {
  82                 // Use these as defaults for back compat --catrope
  83                 $request = $this->getContext()->getRequest();
  84                 $oldFrom = $request->getVal( 'from' );
  85                 $oldUntil = $request->getVal( 'until' );
  86
  87                 $reqArray = $request->getValues();
  88
  89                 $from = $until = [];
  90                 foreach ( [ 'page', 'subcat', 'file' ] as $type ) {
  91                         $from[$type] = $request->getVal( "{$type}from", $oldFrom );
  92                         $until[$type] = $request->getVal( "{$type}until", $oldUntil );
  93
  94                         // Do not want old-style from/until propagating in nav links.
  95                         if ( !isset( $reqArray["{$type}from"] ) && isset( $reqArray["from"] ) ) {
  96                                 $reqArray["{$type}from"] = $reqArray["from"];
  97                         }
  98                         if ( !isset( $reqArray["{$type}to"] ) && isset( $reqArray["to"] ) ) {
  99                                 $reqArray["{$type}to"] = $reqArray["to"];
 100                         }
 101                 }
 102
 103                 unset( $reqArray["from"] );
 104                 unset( $reqArray["to"] );
 105
 106                 $viewer = new $this->mCategoryViewerClass(
 107                         $this->getContext()->getTitle(),
 108                         $this->getContext(),
 109                         $from,
 110                         $until,
 111                         $reqArray
 112                 );
 113                 $out = $this->getContext()->getOutput();
 114                 $out->addHTML( $viewer->getHTML() );
 115                 $this->addHelpLink( 'Help:Categories' );
 116         }
 117
 118         function getCategoryViewerClass() {
 119                 return $this->mCategoryViewerClass;
 120         }
 121
 122         function setCategoryViewerClass( $class ) {
 123                 $this->mCategoryViewerClass = $class;
 124         }
 125 }