3 * Special handling for category description pages
4 * Modelled after ImagePage.php
9 if( !defined( 'MEDIAWIKI' ) )
15 class CategoryPage
extends Article
{
17 if(!wfRunHooks('CategoryPageView', array(&$this))) return;
19 if ( NS_CATEGORY
== $this->mTitle
->getNamespace() ) {
20 $this->openShowCategory();
25 # If the article we've just shown is in the "Image" namespace,
26 # follow it with the history list and link list for the image
29 if ( NS_CATEGORY
== $this->mTitle
->getNamespace() ) {
30 $this->closeShowCategory();
34 function openShowCategory() {
38 function closeShowCategory() {
39 global $wgOut, $wgRequest;
40 $from = $wgRequest->getVal( 'from' );
41 $until = $wgRequest->getVal( 'until' );
43 $viewer = new CategoryViewer( $this->mTitle
, $from, $until );
44 $wgOut->addHTML( $viewer->getHTML() );
48 class CategoryViewer
{
49 var $title, $limit, $from, $until,
50 $articles, $articles_start_char,
51 $children, $children_start_char,
52 $showGallery, $gallery,
55 function __construct( $title, $from = '', $until = '' ) {
56 global $wgCategoryPagingLimit;
57 $this->title
= $title;
59 $this->until
= $until;
60 $this->limit
= $wgCategoryPagingLimit;
64 * Format the category data list.
66 * @param string $from -- return only sort keys from this item on
67 * @param string $until -- don't return keys after this point.
68 * @return string HTML output
72 global $wgOut, $wgCategoryMagicGallery, $wgCategoryPagingLimit;
73 wfProfileIn( __METHOD__
);
75 $this->showGallery
= $wgCategoryMagicGallery && !$wgOut->mNoGallery
;
77 $this->clearCategoryState();
78 $this->doCategoryQuery();
79 $this->finaliseCategoryState();
81 $r = $this->getCategoryTop() .
82 $this->getSubcategorySection() .
83 $this->getPagesSection() .
84 $this->getImageSection() .
85 $this->getCategoryBottom();
87 wfProfileOut( __METHOD__
);
91 function clearCategoryState() {
92 $this->articles
= array();
93 $this->articles_start_char
= array();
94 $this->children
= array();
95 $this->children_start_char
= array();
96 if( $this->showGallery
) {
97 $this->gallery
= new ImageGallery();
98 $this->gallery
->setParsing();
103 if ( !$this->skin
) {
105 $this->skin
= $wgUser->getSkin();
111 * Add a subcategory to the internal lists
113 function addSubcategory( $title, $sortkey, $pageLength ) {
115 // Subcategory; strip the 'Category' namespace from the link text.
116 $this->children
[] = $this->getSkin()->makeKnownLinkObj(
117 $title, $wgContLang->convertHtml( $title->getText() ) );
119 // If there's a link from Category:A to Category:B, the sortkey of the resulting
120 // entry in the categorylinks table is Category:A, not A, which it SHOULD be.
121 // Workaround: If sortkey == "Category:".$title, than use $title for sorting,
122 // else use sortkey...
123 if( $title->getPrefixedText() == $sortkey ) {
124 $firstChar = $wgContLang->firstChar( $title->getDBkey() );
126 $firstChar = $wgContLang->firstChar( $sortkey );
128 $this->children_start_char
[] = $wgContLang->convert( $firstChar );
132 * Add a page in the image namespace
134 function addImage( $title, $sortkey, $pageLength ) {
135 if ( $this->showGallery
) {
136 $image = new Image( $title );
138 $this->gallery
->insert( $image );
140 $this->gallery
->add( $image );
143 $this->addPage( $title, $sortkey, $pageLength );
148 * Add a miscellaneous page
150 function addPage( $title, $sortkey, $pageLength ) {
152 $this->articles
[] = $this->getSkin()->makeSizeLinkObj(
153 $pageLength, $title, $wgContLang->convert( $title->getPrefixedText() )
155 $this->articles_start_char
[] = $wgContLang->convert( $wgContLang->firstChar( $sortkey ) );
158 function finaliseCategoryState() {
160 $this->children
= array_reverse( $this->children
);
161 $this->children_start_char
= array_reverse( $this->children_start_char
);
162 $this->articles
= array_reverse( $this->articles
);
163 $this->articles_start_char
= array_reverse( $this->articles_start_char
);
167 function doCategoryQuery() {
168 $dbr =& wfGetDB( DB_SLAVE
);
169 if( $this->from
!= '' ) {
170 $pageCondition = 'cl_sortkey >= ' . $dbr->addQuotes( $this->from
);
172 } elseif( $this->until
!= '' ) {
173 $pageCondition = 'cl_sortkey < ' . $dbr->addQuotes( $this->until
);
176 $pageCondition = '1 = 1';
180 array( 'page', 'categorylinks' ),
181 array( 'page_title', 'page_namespace', 'page_len', 'cl_sortkey' ),
182 array( $pageCondition,
184 'cl_to' => $this->title
->getDBKey()),
185 #'page_is_redirect' => 0),
188 array( 'ORDER BY' => $this->flip ?
'cl_sortkey DESC' : 'cl_sortkey',
189 'LIMIT' => $this->limit +
1 ) );
192 $this->nextPage
= null;
193 while( $x = $dbr->fetchObject ( $res ) ) {
194 if( ++
$count > $this->limit
) {
195 // We've reached the one extra which shows that there are
196 // additional pages to be had. Stop here...
197 $this->nextPage
= $x->cl_sortkey
;
201 $title = Title
::makeTitle( $x->page_namespace
, $x->page_title
);
203 if( $title->getNamespace() == NS_CATEGORY
) {
204 $this->addSubcategory( $title, $x->cl_sortkey
, $x->page_len
);
205 } elseif( $title->getNamespace() == NS_IMAGE
) {
206 $this->addImage( $title, $x->cl_sortkey
, $x->page_len
);
208 $this->addPage( $title, $x->cl_sortkey
, $x->page_len
);
211 $dbr->freeResult( $res );
214 function getCategoryTop() {
215 $r = "<br style=\"clear:both;\"/>\n";
216 if( $this->until
!= '' ) {
217 $r .= $this->pagingLinks( $this->title
, $this->nextPage
, $this->until
, $this->limit
);
218 } elseif( $this->nextPage
!= '' ||
$this->from
!= '' ) {
219 $r .= $this->pagingLinks( $this->title
, $this->from
, $this->nextPage
, $this->limit
);
224 function getSubcategorySection() {
225 # Don't show subcategories section if there are none.
227 if( count( $this->children
) > 0 ) {
228 # Showing subcategories
229 $r .= '<h2>' . wfMsg( 'subcategories' ) . "</h2>\n";
230 $r .= wfMsgExt( 'subcategorycount', array( 'parse' ), count( $this->children
) );
231 $r .= $this->formatList( $this->children
, $this->children_start_char
);
236 function getPagesSection() {
237 $ti = htmlspecialchars( $this->title
->getText() );
238 $r = '<h2>' . wfMsg( 'category_header', $ti ) . "</h2>\n";
239 $r .= wfMsgExt( 'categoryarticlecount', array( 'parse' ), count( $this->articles
) );
240 $r .= $this->formatList( $this->articles
, $this->articles_start_char
);
244 function getImageSection() {
245 if( $this->showGallery
&& ! $this->gallery
->isEmpty() ) {
246 return $this->gallery
->toHTML();
252 function getCategoryBottom() {
253 if( $this->until
!= '' ) {
254 return $this->pagingLinks( $this->title
, $this->nextPage
, $this->until
, $this->limit
);
255 } elseif( $this->nextPage
!= '' ||
$this->from
!= '' ) {
256 return $this->pagingLinks( $this->title
, $this->from
, $this->nextPage
, $this->limit
);
263 * Format a list of articles chunked by letter, either as a
264 * bullet list or a columnar format, depending on the length.
266 * @param array $articles
267 * @param array $articles_start_char
272 function formatList( $articles, $articles_start_char, $cutoff = 6 ) {
273 if ( count ( $articles ) > $cutoff ) {
274 return $this->columnList( $articles, $articles_start_char );
275 } elseif ( count($articles) > 0) {
276 // for short lists of articles in categories.
277 return $this->shortList( $articles, $articles_start_char );
283 * Format a list of articles chunked by letter in a three-column
284 * list, ordered vertically.
286 * @param array $articles
287 * @param array $articles_start_char
291 function columnList( $articles, $articles_start_char ) {
292 // divide list into three equal chunks
293 $chunk = (int) (count ( $articles ) / 3);
295 // get and display header
296 $r = '<table width="100%"><tr valign="top">';
298 $prev_start_char = 'none';
300 // loop through the chunks
301 for($startChunk = 0, $endChunk = $chunk, $chunkIndex = 0;
303 $chunkIndex++
, $startChunk = $endChunk, $endChunk +
= $chunk +
1)
308 // output all articles in category
309 for ($index = $startChunk ;
310 $index < $endChunk && $index < count($articles);
313 // check for change of starting letter or begining of chunk
314 if ( ($index == $startChunk) ||
315 ($articles_start_char[$index] != $articles_start_char[$index - 1]) )
319 $atColumnTop = false;
324 if ( $articles_start_char[$index] == $prev_start_char )
325 $cont_msg = wfMsgHtml('listingcontinuesabbrev');
326 $r .= "<h3>" . htmlspecialchars( $articles_start_char[$index] ) . "$cont_msg</h3>\n<ul>";
327 $prev_start_char = $articles_start_char[$index];
330 $r .= "<li>{$articles[$index]}</li>";
332 if( !$atColumnTop ) {
339 $r .= '</tr></table>';
344 * Format a list of articles chunked by letter in a bullet list.
345 * @param array $articles
346 * @param array $articles_start_char
350 function shortList( $articles, $articles_start_char ) {
351 $r = '<h3>' . htmlspecialchars( $articles_start_char[0] ) . "</h3>\n";
352 $r .= '<ul><li>'.$articles[0].'</li>';
353 for ($index = 1; $index < count($articles); $index++
)
355 if ($articles_start_char[$index] != $articles_start_char[$index - 1])
357 $r .= "</ul><h3>" . htmlspecialchars( $articles_start_char[$index] ) . "</h3>\n<ul>";
360 $r .= "<li>{$articles[$index]}</li>";
367 * @param Title $title
368 * @param string $first
369 * @param string $last
371 * @param array $query - additional query options to pass
375 function pagingLinks( $title, $first, $last, $limit, $query = array() ) {
376 global $wgUser, $wgLang;
377 $sk =& $this->getSkin();
378 $limitText = $wgLang->formatNum( $limit );
380 $prevLink = htmlspecialchars( wfMsg( 'prevn', $limitText ) );
382 $prevLink = $sk->makeLinkObj( $title, $prevLink,
383 wfArrayToCGI( $query +
array( 'until' => $first ) ) );
385 $nextLink = htmlspecialchars( wfMsg( 'nextn', $limitText ) );
387 $nextLink = $sk->makeLinkObj( $title, $nextLink,
388 wfArrayToCGI( $query +
array( 'from' => $last ) ) );
391 return "($prevLink) ($nextLink)";