MediaWiki  1.29.1
CategoryPage.php
Go to the documentation of this file.
1 <?php
28 class CategoryPage extends Article {
29  # Subclasses can change this to override the viewer class.
30  protected $mCategoryViewerClass = 'CategoryViewer';
31 
35  protected $mPage;
36 
41  protected function newPage( Title $title ) {
42  // Overload mPage with a category-specific page
43  return new WikiCategoryPage( $title );
44  }
45 
46  function view() {
47  $request = $this->getContext()->getRequest();
48  $diff = $request->getVal( 'diff' );
49  $diffOnly = $request->getBool( 'diffonly',
50  $this->getContext()->getUser()->getOption( 'diffonly' ) );
51 
52  if ( $diff !== null && $diffOnly ) {
53  parent::view();
54  return;
55  }
56 
57  // Avoid PHP 7.1 warning of passing $this by reference
58  $categoryPage = $this;
59 
60  if ( !Hooks::run( 'CategoryPageView', [ &$categoryPage ] ) ) {
61  return;
62  }
63 
64  $title = $this->getTitle();
65  if ( $title->inNamespace( NS_CATEGORY ) ) {
66  $this->openShowCategory();
67  }
68 
69  parent::view();
70 
71  if ( $title->inNamespace( NS_CATEGORY ) ) {
72  $this->closeShowCategory();
73  }
74 
75  # Use adaptive TTLs for CDN so delayed/failed purges are noticed less often
76  $outputPage = $this->getContext()->getOutput();
77  $outputPage->adaptCdnTTL( $this->mPage->getTouched(), IExpiringStore::TTL_MINUTE );
78  }
79 
80  function openShowCategory() {
81  # For overloading
82  }
83 
84  function closeShowCategory() {
85  // Use these as defaults for back compat --catrope
86  $request = $this->getContext()->getRequest();
87  $oldFrom = $request->getVal( 'from' );
88  $oldUntil = $request->getVal( 'until' );
89 
90  $reqArray = $request->getValues();
91 
92  $from = $until = [];
93  foreach ( [ 'page', 'subcat', 'file' ] as $type ) {
94  $from[$type] = $request->getVal( "{$type}from", $oldFrom );
95  $until[$type] = $request->getVal( "{$type}until", $oldUntil );
96 
97  // Do not want old-style from/until propagating in nav links.
98  if ( !isset( $reqArray["{$type}from"] ) && isset( $reqArray["from"] ) ) {
99  $reqArray["{$type}from"] = $reqArray["from"];
100  }
101  if ( !isset( $reqArray["{$type}to"] ) && isset( $reqArray["to"] ) ) {
102  $reqArray["{$type}to"] = $reqArray["to"];
103  }
104  }
105 
106  unset( $reqArray["from"] );
107  unset( $reqArray["to"] );
108 
109  $viewer = new $this->mCategoryViewerClass(
110  $this->getContext()->getTitle(),
111  $this->getContext(),
112  $from,
113  $until,
114  $reqArray
115  );
116  $out = $this->getContext()->getOutput();
117  $out->addHTML( $viewer->getHTML() );
118  $this->addHelpLink( 'Help:Categories' );
119  }
120 }
$request
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2612
CategoryPage\closeShowCategory
closeShowCategory()
Definition: CategoryPage.php:84
view
$article view()
CategoryPage
Special handling for category description pages, showing pages, subcategories and file that belong to...
Definition: CategoryPage.php:28
IExpiringStore\TTL_MINUTE
const TTL_MINUTE
Definition: IExpiringStore.php:33
$type
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2536
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:46
CategoryPage\$mPage
WikiCategoryPage $mPage
Definition: CategoryPage.php:35
CategoryPage\newPage
newPage(Title $title)
Definition: CategoryPage.php:41
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
WikiCategoryPage
Special handling for category pages.
Definition: WikiCategoryPage.php:26
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
Article\getTitle
getTitle()
Get the title object of the article.
Definition: Article.php:174
Article\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: Article.php:1485
CategoryPage\$mCategoryViewerClass
$mCategoryViewerClass
Definition: CategoryPage.php:30
Article\getContext
getContext()
Gets the context this Article is executed in.
Definition: Article.php:1932
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:76
CategoryPage\openShowCategory
openShowCategory()
Definition: CategoryPage.php:80
Article\getUser
getUser( $audience=Revision::FOR_PUBLIC, User $user=null)
Call to WikiPage function for backwards compatibility.
Definition: Article.php:2259
Title
Represents a title within MediaWiki.
Definition: Title.php:39
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Article
Class for viewing MediaWiki article and history.
Definition: Article.php:35
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:783