3 * Special handling for category description pages.
4 * Modelled after ImagePage.php.
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.
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.
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
25 * Special handling for category description pages, showing pages,
26 * subcategories and file that belong to the category
28 * @property WikiCategoryPage $mPage Set by overwritten newPage() in this class
30 class CategoryPage
extends Article
{
31 # Subclasses can change this to override the viewer class.
32 protected $mCategoryViewerClass = CategoryViewer
::class;
36 * @return WikiCategoryPage
38 protected function newPage( Title
$title ) {
39 // Overload mPage with a category-specific page
40 return new WikiCategoryPage( $title );
44 $request = $this->getContext()->getRequest();
45 $diff = $request->getVal( 'diff' );
46 $diffOnly = $request->getBool( 'diffonly',
47 $this->getContext()->getUser()->getOption( 'diffonly' ) );
49 if ( $diff !== null && $diffOnly ) {
54 // Avoid PHP 7.1 warning of passing $this by reference
55 $categoryPage = $this;
57 if ( !Hooks
::run( 'CategoryPageView', [ &$categoryPage ] ) ) {
61 $title = $this->getTitle();
62 if ( $title->inNamespace( NS_CATEGORY
) ) {
63 $this->openShowCategory();
68 if ( $title->inNamespace( NS_CATEGORY
) ) {
69 $this->closeShowCategory();
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
);
77 function openShowCategory() {
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' );
87 $reqArray = $request->getValues();
90 foreach ( [ 'page', 'subcat', 'file' ] as $type ) {
91 $from[$type] = $request->getVal( "{$type}from", $oldFrom );
92 $until[$type] = $request->getVal( "{$type}until", $oldUntil );
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"];
98 if ( !isset( $reqArray["{$type}to"] ) && isset( $reqArray["to"] ) ) {
99 $reqArray["{$type}to"] = $reqArray["to"];
103 unset( $reqArray["from"] );
104 unset( $reqArray["to"] );
106 $viewer = new $this->mCategoryViewerClass(
107 $this->getContext()->getTitle(),
113 $out = $this->getContext()->getOutput();
114 $out->addHTML( $viewer->getHTML() );
115 $this->addHelpLink( 'Help:Categories' );
118 function getCategoryViewerClass() {
119 return $this->mCategoryViewerClass
;
122 function setCategoryViewerClass( $class ) {
123 $this->mCategoryViewerClass
= $class;