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  public 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  if ( !$this->getHookRunner()->onCategoryPageView( $this ) ) {
55  return;
56  }
57 
58  $title = $this->getTitle();
59  if ( $title->inNamespace( NS_CATEGORY ) ) {
60  $this->openShowCategory();
61  }
62 
63  parent::view();
64 
65  if ( $title->inNamespace( NS_CATEGORY ) ) {
66  $this->closeShowCategory();
67  }
68 
69  # Use adaptive TTLs for CDN so delayed/failed purges are noticed less often
70  $outputPage = $this->getContext()->getOutput();
71  $outputPage->adaptCdnTTL(
72  $this->getPage()->getTouched(),
73  IExpiringStore::TTL_MINUTE
74  );
75  }
76 
77  public function openShowCategory() {
78  # For overloading
79  }
80 
81  public 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 
121  public function getCategoryViewerClass() {
122  wfDeprecated( __METHOD__, '1.35' );
124  }
125 
129  public function setCategoryViewerClass( $class ) {
130  wfDeprecated( __METHOD__, '1.35' );
131  $this->mCategoryViewerClass = $class;
132  }
133 }
CategoryPage\closeShowCategory
closeShowCategory()
Definition: CategoryPage.php:81
getUser
getUser()
CategoryPage
Special handling for category description pages, showing pages, subcategories and file that belong to...
Definition: CategoryPage.php:30
CategoryPage\view
view()
This is the default action of the index.php entry point: just view the page of the given title.
Definition: CategoryPage.php:43
CategoryPage\newPage
newPage(Title $title)
Definition: CategoryPage.php:38
WikiCategoryPage
Special handling for category pages.
Definition: WikiCategoryPage.php:26
Article\getTouched
getTouched()
Definition: Article.php:2705
Article\getTitle
getTitle()
Get the title object of the article.
Definition: Article.php:255
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that $function is deprecated.
Definition: GlobalFunctions.php:1027
Article\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: Article.php:1816
Article\getPage
getPage()
Get the WikiPage object of this instance.
Definition: Article.php:265
CategoryPage\$mCategoryViewerClass
$mCategoryViewerClass
Definition: CategoryPage.php:32
Article\getContext
getContext()
Gets the context this Article is executed in.
Definition: Article.php:2353
$title
$title
Definition: testCompression.php:38
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:83
CategoryPage\setCategoryViewerClass
setCategoryViewerClass( $class)
Definition: CategoryPage.php:129
CategoryPage\getCategoryViewerClass
getCategoryViewerClass()
Definition: CategoryPage.php:121
CategoryPage\openShowCategory
openShowCategory()
Definition: CategoryPage.php:77
Title
Represents a title within MediaWiki.
Definition: Title.php:41
Article
Class for viewing MediaWiki article and history.
Definition: Article.php:46
$type
$type
Definition: testCompression.php:52