MediaWiki  1.28.1
SpecialSpecialpages.php
Go to the documentation of this file.
1 <?php
30 
31  function __construct() {
32  parent::__construct( 'Specialpages' );
33  }
34 
35  function execute( $par ) {
36  $out = $this->getOutput();
37  $this->setHeaders();
38  $this->outputHeader();
39  $out->allowClickjacking();
40  $out->addModuleStyles( 'mediawiki.special' );
41 
42  $groups = $this->getPageGroups();
43 
44  if ( $groups === false ) {
45  return;
46  }
47 
48  $this->addHelpLink( 'Help:Special pages' );
49  $this->outputPageList( $groups );
50  }
51 
52  private function getPageGroups() {
53  $pages = SpecialPageFactory::getUsablePages( $this->getUser() );
54 
55  if ( !count( $pages ) ) {
56  # Yeah, that was pointless. Thanks for coming.
57  return false;
58  }
59 
61  $groups = [];
63  foreach ( $pages as $page ) {
64  if ( $page->isListed() ) {
65  $group = $page->getFinalGroupName();
66  if ( !isset( $groups[$group] ) ) {
67  $groups[$group] = [];
68  }
69  $groups[$group][$page->getDescription()] = [
70  $page->getPageTitle(),
71  $page->isRestricted(),
72  $page->isCached()
73  ];
74  }
75  }
76 
78  foreach ( $groups as $group => $sortedPages ) {
79  ksort( $groups[$group] );
80  }
81 
83  if ( array_key_exists( 'other', $groups ) ) {
84  $other = $groups['other'];
85  unset( $groups['other'] );
86  $groups['other'] = $other;
87  }
88 
89  return $groups;
90  }
91 
92  private function outputPageList( $groups ) {
93  $out = $this->getOutput();
94 
95  $includesRestrictedPages = false;
96  $includesCachedPages = false;
97 
98  foreach ( $groups as $group => $sortedPages ) {
99 
100  $out->wrapWikiMsg(
101  "<h2 class=\"mw-specialpagesgroup\" id=\"mw-specialpagesgroup-$group\">$1</h2>\n",
102  "specialpages-group-$group"
103  );
104  $out->addHTML(
105  Html::openElement( 'div', [ 'class' => 'mw-specialpages-list' ] )
106  . '<ul>'
107  );
108  foreach ( $sortedPages as $desc => $specialpage ) {
109  list( $title, $restricted, $cached ) = $specialpage;
110 
111  $pageClasses = [];
112  if ( $cached ) {
113  $includesCachedPages = true;
114  $pageClasses[] = 'mw-specialpagecached';
115  }
116  if ( $restricted ) {
117  $includesRestrictedPages = true;
118  $pageClasses[] = 'mw-specialpagerestricted';
119  }
120 
121  $link = Linker::linkKnown( $title, htmlspecialchars( $desc ) );
122  $out->addHTML( Html::rawElement(
123  'li',
124  [ 'class' => implode( ' ', $pageClasses ) ],
125  $link
126  ) . "\n" );
127  }
128  $out->addHTML(
129  Html::closeElement( 'ul' ) .
130  Html::closeElement( 'div' )
131  );
132  }
133 
134  if ( $includesRestrictedPages || $includesCachedPages ) {
135  $out->wrapWikiMsg( "<h2 class=\"mw-specialpages-note-top\">$1</h2>", 'specialpages-note-top' );
136  $out->wrapWikiMsg( "<div class=\"mw-specialpages-notes\">\n$1\n</div>", 'specialpages-note' );
137  }
138  }
139 }
static closeElement($element)
Returns "".
Definition: Html.php:305
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
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:802
Shortcut to construct a special page which is unlisted by default.
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
getOutput()
Get the OutputPage being used for this instance.
addHelpLink($to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
outputHeader($summaryMessageKey= '')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2889
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:247
A special page that lists special pages.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static linkKnown($target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
Definition: Linker.php:255
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
static getUsablePages(User $user=null)
Return categorised listable special pages which are available for the current user, and everyone.
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
getUser()
Shortcut to get the User executing this instance.
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 $page
Definition: hooks.txt:2491