MediaWiki  master
CategoryPage.php
Go to the documentation of this file.
1 <?php
30 class CategoryPage extends Article {
31  # Subclasses can change this to override the viewer class.
32  protected $mCategoryViewerClass = CategoryViewer::class;
33 
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 
120  }
121 
122  function setCategoryViewerClass( $class ) {
123  $this->mCategoryViewerClass = $class;
124  }
125 }
newPage(Title $title)
Class for viewing MediaWiki article and history.
Definition: Article.php:41
getContext()
Gets the context this Article is executed in.
Definition: Article.php:2270
getTitle()
Get the title object of the article.
Definition: Article.php:224
const NS_CATEGORY
Definition: Defines.php:74
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: Article.php:1751
getUser( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)
Call to WikiPage function for backwards compatibility.
Definition: Article.php:2656
setCategoryViewerClass( $class)
Special handling for category pages.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200