MediaWiki  1.23.2
SpecialCategories.php
Go to the documentation of this file.
1 <?php
28 
32  protected $linkRenderer = null;
33 
34  public function __construct() {
35  parent::__construct( 'Categories' );
36 
37  // Since we don't control the constructor parameters, we can't inject services that way.
38  // Instead, we initialize services in the execute() method, and allow them to be overridden
39  // using the initServices() method.
40  }
41 
50  public function setPageLinkRenderer(
52  ) {
53  $this->linkRenderer = $linkRenderer;
54  }
55 
60  private function initServices() {
61  if ( !$this->linkRenderer ) {
62  $lang = $this->getContext()->getLanguage();
63  $titleFormatter = new MediaWikiTitleCodec( $lang, GenderCache::singleton() );
64  $this->linkRenderer = new MediaWikiPageLinkRenderer( $titleFormatter );
65  }
66  }
67 
68  public function execute( $par ) {
69  $this->initServices();
70 
71  $this->setHeaders();
72  $this->outputHeader();
73  $this->getOutput()->allowClickjacking();
74 
75  $from = $this->getRequest()->getText( 'from', $par );
76 
77  $cap = new CategoryPager( $this->getContext(), $from, $this->linkRenderer );
78  $cap->doQuery();
79 
80  $this->getOutput()->addHTML(
81  Html::openElement( 'div', array( 'class' => 'mw-spcontent' ) ) .
82  $this->msg( 'categoriespagetext', $cap->getNumRows() )->parseAsBlock() .
83  $cap->getStartForm( $from ) .
84  $cap->getNavigationBar() .
85  '<ul>' . $cap->getBody() . '</ul>' .
86  $cap->getNavigationBar() .
87  Html::closeElement( 'div' )
88  );
89  }
90 
91  protected function getGroupName() {
92  return 'pages';
93  }
94 }
95 
102 class CategoryPager extends AlphabeticPager {
103 
107  protected $linkRenderer;
108 
115  ) {
116  parent::__construct( $context );
117  $from = str_replace( ' ', '_', $from );
118  if ( $from !== '' ) {
120  $this->setOffset( $from );
121  $this->setIncludeOffset( true );
122  }
123 
124  $this->linkRenderer = $linkRenderer;
125  }
126 
127  function getQueryInfo() {
128  return array(
129  'tables' => array( 'category' ),
130  'fields' => array( 'cat_title', 'cat_pages' ),
131  'conds' => array( 'cat_pages > 0' ),
132  'options' => array( 'USE INDEX' => 'cat_title' ),
133  );
134  }
135 
136  function getIndexField() {
137 # return array( 'abc' => 'cat_title', 'count' => 'cat_pages' );
138  return 'cat_title';
139  }
140 
141  function getDefaultQuery() {
142  parent::getDefaultQuery();
143  unset( $this->mDefaultQuery['from'] );
144 
145  return $this->mDefaultQuery;
146  }
147 
148 # protected function getOrderTypeMessages() {
149 # return array( 'abc' => 'special-categories-sort-abc',
150 # 'count' => 'special-categories-sort-count' );
151 # }
152 
153  protected function getDefaultDirections() {
154 # return array( 'abc' => false, 'count' => true );
155  return false;
156  }
157 
158  /* Override getBody to apply LinksBatch on resultset before actually outputting anything. */
159  public function getBody() {
160  $batch = new LinkBatch;
161 
162  $this->mResult->rewind();
163 
164  foreach ( $this->mResult as $row ) {
165  $batch->addObj( Title::makeTitleSafe( NS_CATEGORY, $row->cat_title ) );
166  }
167  $batch->execute();
168  $this->mResult->rewind();
169 
170  return parent::getBody();
171  }
172 
173  function formatRow( $result ) {
174  $title = new TitleValue( NS_CATEGORY, $result->cat_title );
175  $text = $title->getText();
176  $link = $this->linkRenderer->renderHtmlLink( $title, $text );
177 
178  $count = $this->msg( 'nmembers' )->numParams( $result->cat_pages )->escaped();
179  return Html::rawElement( 'li', null, $this->getLanguage()->specialList( $link, $count ) ) . "\n";
180  }
181 
182  public function getStartForm( $from ) {
183  global $wgScript;
184 
185  return Xml::tags(
186  'form',
187  array( 'method' => 'get', 'action' => $wgScript ),
188  Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) .
190  $this->msg( 'categories' )->text(),
192  $this->msg( 'categoriesfrom' )->text(),
193  'from', 'from', 20, $from ) .
194  ' ' .
195  Xml::submitButton( $this->msg( 'allpagessubmit' )->text()
196  )
197  )
198  );
199  }
200 }
GenderCache\singleton
static singleton()
Definition: GenderCache.php:39
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
MediaWikiTitleCodec
A codec for MediaWiki page titles.
Definition: MediaWikiTitleCodec.php:35
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ContextSource\msg
msg()
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:175
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:30
Xml\tags
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:131
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:535
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
CategoryPager\$linkRenderer
PageLinkRenderer $linkRenderer
Definition: SpecialCategories.php:105
$from
$from
Definition: importImages.php:90
CategoryPager\getDefaultDirections
getDefaultDirections()
Return the default sorting direction: false for ascending, true for descending.
Definition: SpecialCategories.php:151
SpecialCategories\execute
execute( $par)
Default execute method Checks user permissions, calls the function given in mFunction.
Definition: SpecialCategories.php:67
AlphabeticPager
IndexPager with an alphabetic list and a formatted navigation bar.
Definition: Pager.php:743
Html\hidden
static hidden( $name, $value, $attribs=array())
Convenience function to produce an input element with type=hidden.
Definition: Html.php:662
$link
set to $title object and return false for a match for latest after cache objects are set use the ContentHandler facility to handle CSS and JavaScript for highlighting & $link
Definition: hooks.txt:2149
ContextSource\getTitle
getTitle()
Get the Title object.
Definition: ContextSource.php:87
SpecialCategories
Definition: SpecialCategories.php:27
ContextSource\getLanguage
getLanguage()
Get the Language object.
Definition: ContextSource.php:154
CategoryPager\getBody
getBody()
Get the formatted result list.
Definition: SpecialCategories.php:157
CategoryPager\getQueryInfo
getQueryInfo()
This function should be overridden to provide all parameters needed for the main paged query.
Definition: SpecialCategories.php:125
Html\closeElement
static closeElement( $element)
Returns "</$element>", except if $wgWellFormedXml is off, in which case it returns the empty string w...
Definition: Html.php:235
CategoryPager\getStartForm
getStartForm( $from)
Definition: SpecialCategories.php:180
Html\openElement
static openElement( $element, $attribs=array())
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:166
SpecialCategories\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialCategories.php:90
SpecialCategories\__construct
__construct()
Definition: SpecialCategories.php:33
PageLinkRenderer
Represents a link rendering service for MediaWiki.
Definition: PageLinkRenderer.php:33
SpecialCategories\setPageLinkRenderer
setPageLinkRenderer(PageLinkRenderer $linkRenderer)
Initialize or override the PageLinkRenderer SpecialCategories collaborates with.
Definition: SpecialCategories.php:49
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:352
CategoryPager\getDefaultQuery
getDefaultQuery()
Get an array of query parameters that should be put into self-links.
Definition: SpecialCategories.php:139
Xml\inputLabel
static inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array())
Convenience function to build an HTML text input field with a label.
Definition: Xml.php:398
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:93
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:508
CategoryPager
TODO: Allow sorting by count.
Definition: SpecialCategories.php:101
IndexPager\setIncludeOffset
setIncludeOffset( $include)
Set whether a row matching exactly the offset should be also included in the result or not.
Definition: Pager.php:286
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:422
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
SpecialPage\msg
msg()
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:609
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:33
SpecialCategories\initServices
initServices()
Initialize any services we'll need (unless it has already been provided via a setter).
Definition: SpecialCategories.php:59
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:525
IndexPager\setOffset
setOffset( $offset)
Set the offset from an other source than the request.
Definition: Pager.php:248
CategoryPager\formatRow
formatRow( $result)
Abstract formatting function.
Definition: SpecialCategories.php:171
IContextSource
Interface for objects which can provide a context on request.
Definition: IContextSource.php:29
SpecialCategories\$linkRenderer
PageLinkRenderer $linkRenderer
Definition: SpecialCategories.php:31
$count
$count
Definition: UtfNormalTest2.php:96
IndexPager\$mDefaultQuery
$mDefaultQuery
Definition: Pager.php:119
Title\capitalize
static capitalize( $text, $ns=NS_MAIN)
Capitalize a text string for a title if it belongs to a namespace that capitalizes.
Definition: Title.php:3269
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
$batch
$batch
Definition: linkcache.txt:23
Xml\submitButton
static submitButton( $value, $attribs=array())
Convenience function to build an HTML submit button.
Definition: Xml.php:463
CategoryPager\__construct
__construct(IContextSource $context, $from, PageLinkRenderer $linkRenderer)
Definition: SpecialCategories.php:112
Html\rawElement
static rawElement( $element, $attribs=array(), $contents='')
Returns an HTML element in a string.
Definition: Html.php:124
MediaWikiPageLinkRenderer
A service for generating links from page titles.
Definition: MediaWikiPageLinkRenderer.php:30
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:443
CategoryPager\getIndexField
getIndexField()
This function should be overridden to return the name of the index fi- eld.
Definition: SpecialCategories.php:134
Xml\fieldset
static fieldset( $legend=false, $content=false, $attribs=array())
Shortcut for creating fieldsets.
Definition: Xml.php:563
TitleValue
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:36