MediaWiki  REL1_31
CategoryViewer Class Reference
Inheritance diagram for CategoryViewer:
Collaboration diagram for CategoryViewer:

Public Member Functions

 __construct ( $title, IContextSource $context, $from=[], $until=[], $query=[])
 
 addImage (Title $title, $sortkey, $pageLength, $isRedirect=false)
 Add a page in the image namespace. More...
 
 addPage ( $title, $sortkey, $pageLength, $isRedirect=false)
 Add a miscellaneous page. More...
 
 addSubcategoryObject (Category $cat, $sortkey, $pageLength)
 Add a subcategory to the internal lists, using a Category object. More...
 
 clearCategoryState ()
 
 doCategoryQuery ()
 
 finaliseCategoryState ()
 
 formatList ( $articles, $articles_start_char, $cutoff=6)
 Format a list of articles chunked by letter, either as a bullet list or a columnar format, depending on the length. More...
 
 generateLink ( $type, Title $title, $isRedirect, $html=null)
 
 getCategoryBottom ()
 
 getCategoryTop ()
 
 getHTML ()
 Format the category data list. More...
 
 getImageSection ()
 
 getPagesSection ()
 
 getSubcategorySection ()
 
 getSubcategorySortChar ( $title, $sortkey)
 Get the character to be used for sorting subcategories. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Static Public Member Functions

static columnList ( $articles, $articles_start_char)
 Format a list of articles chunked by letter in a three-column list, ordered vertically. More...
 
static shortList ( $articles, $articles_start_char)
 Format a list of articles chunked by letter in a bullet list. More...
 

Public Attributes

string[] $articles
 
array $articles_start_char
 
array $children
 
array $children_start_char
 
Collation $collation
 
array $flip
 
array $from
 
ImageGalleryBase $gallery
 
array $imgsNoGallery
 
array $imgsNoGallery_start_char
 
int $limit
 
array $nextPage
 
bool $showGallery
 
Title $title
 
array $until
 

Protected Attributes

array $prevPage
 

Private Member Functions

 addFragmentToTitle ( $title, $section)
 Takes a title, and adds the fragment identifier that corresponds to the correct segment of the category. More...
 
 getCountMessage ( $rescnt, $dbcnt, $type)
 What to do if the category table conflicts with the number of results returned? This function says what. More...
 
 getSectionPagingLinks ( $type)
 Get the paging links for a section (subcats/pages/files), to go at the top and bottom of the output. More...
 
 pagingLinks ( $first, $last, $type='')
 Create paging links, as a helper method to getSectionPagingLinks(). More...
 

Private Attributes

Category $cat
 Category object for this page. More...
 
array $query
 The original query array, to be used in generating paging links. More...
 

Detailed Description

Definition at line 24 of file CategoryViewer.php.

Constructor & Destructor Documentation

◆ __construct()

CategoryViewer::__construct (   $title,
IContextSource  $context,
  $from = [],
  $until = [],
  $query = [] 
)
Since
1.19 $context is a second, required parameter
Parameters
Title$title
IContextSource$context
array$fromAn array with keys page, subcat, and file for offset of results of each section (since 1.17)
array$untilAn array with 3 keys for until of each section (since 1.17)
array$query

Definition at line 88 of file CategoryViewer.php.

References ContextSource\$context, $from, $query, $title, $until, from, IContextSource\getConfig(), ContextSource\getOutput(), Category\newFromTitle(), query, ContextSource\setContext(), Collation\singleton(), and title.

Member Function Documentation

◆ addFragmentToTitle()

CategoryViewer::addFragmentToTitle (   $title,
  $section 
)
private

Takes a title, and adds the fragment identifier that corresponds to the correct segment of the category.

Parameters
Title$titleThe title (usually $this->title)
string$sectionWhich section
Exceptions
MWException
Returns
Title

Definition at line 673 of file CategoryViewer.php.

References $section, $title, Title\getDBkey(), Title\getNamespace(), and Title\makeTitle().

Referenced by pagingLinks().

◆ addImage()

CategoryViewer::addImage ( Title  $title,
  $sortkey,
  $pageLength,
  $isRedirect = false 
)

Add a page in the image namespace.

Parameters
Title$title
string$sortkey
int$pageLength
bool$isRedirect

Definition at line 244 of file CategoryViewer.php.

References $flip, $title, $wgContLang, generateLink(), and global.

Referenced by doCategoryQuery().

◆ addPage()

CategoryViewer::addPage (   $title,
  $sortkey,
  $pageLength,
  $isRedirect = false 
)

Add a miscellaneous page.

Parameters
Title$title
string$sortkey
int$pageLength
bool$isRedirect

Definition at line 268 of file CategoryViewer.php.

References $wgContLang, generateLink(), and global.

Referenced by doCategoryQuery().

◆ addSubcategoryObject()

CategoryViewer::addSubcategoryObject ( Category  $cat,
  $sortkey,
  $pageLength 
)

Add a subcategory to the internal lists, using a Category object.

Parameters
Category$cat
string$sortkey
int$pageLength

Definition at line 180 of file CategoryViewer.php.

References $cat, $title, generateLink(), getSubcategorySortChar(), Title\getText(), Category\getTitle(), and Title\isRedirect().

Referenced by doCategoryQuery().

◆ clearCategoryState()

CategoryViewer::clearCategoryState ( )

◆ columnList()

static CategoryViewer::columnList (   $articles,
  $articles_start_char 
)
static

Format a list of articles chunked by letter in a three-column list, ordered vertically.

This is used for categories with a significant number of pages.

TODO: Take the headers into account when creating columns, so they're more visually equal.

TODO: shortList and columnList are similar, need merging

Parameters
string[]$articlesHTML links to each article
string[]$articles_start_charThe header characters for each article
Returns
string HTML to output
Access:\n private

Definition at line 566 of file CategoryViewer.php.

References $article, $articles, $articles_start_char, $ret, as, Html\closeElement(), and Html\openElement().

Referenced by formatList().

◆ doCategoryQuery()

◆ finaliseCategoryState()

CategoryViewer::finaliseCategoryState ( )

Definition at line 277 of file CategoryViewer.php.

Referenced by getHTML().

◆ formatList()

CategoryViewer::formatList (   $articles,
  $articles_start_char,
  $cutoff = 6 
)

Format a list of articles chunked by letter, either as a bullet list or a columnar format, depending on the length.

Parameters
array$articles
array$articles_start_char
int$cutoff
Returns
string
Access:\n private

Definition at line 535 of file CategoryViewer.php.

References $articles, $articles_start_char, $attribs, columnList(), Html\rawElement(), shortList(), and title.

Referenced by getImageSection(), getPagesSection(), and getSubcategorySection().

◆ generateLink()

CategoryViewer::generateLink (   $type,
Title  $title,
  $isRedirect,
  $html = null 
)

Definition at line 195 of file CategoryViewer.php.

References $html, $link, $linkRenderer, $title, $type, and Hooks\run().

Referenced by addImage(), addPage(), and addSubcategoryObject().

◆ getCategoryBottom()

CategoryViewer::getCategoryBottom ( )
Returns
string

Definition at line 521 of file CategoryViewer.php.

Referenced by getCategoryTop(), and getHTML().

◆ getCategoryTop()

CategoryViewer::getCategoryTop ( )
Returns
string

Definition at line 397 of file CategoryViewer.php.

References getCategoryBottom().

Referenced by getHTML().

◆ getCountMessage()

CategoryViewer::getCountMessage (   $rescnt,
  $dbcnt,
  $type 
)
private

What to do if the category table conflicts with the number of results returned? This function says what.

Each type is considered independently of the other types.

Parameters
int$rescntThe number of items returned by our database query.
int$dbcntThe number of items according to the category table.
string$type'subcat', 'article', or 'file'
Returns
string A message giving the number of items, to output to HTML.

Definition at line 703 of file CategoryViewer.php.

References $type, DeferredUpdates\addCallableUpdate(), from, and ContextSource\msg().

Referenced by getImageSection(), getPagesSection(), and getSubcategorySection().

◆ getHTML()

◆ getImageSection()

CategoryViewer::getImageSection ( )
Returns
string

Definition at line 461 of file CategoryViewer.php.

References formatList(), getCountMessage(), getSectionPagingLinks(), ContextSource\msg(), title, and wfEscapeWikiText().

Referenced by getHTML().

◆ getPagesSection()

CategoryViewer::getPagesSection ( )
Returns
string

Definition at line 431 of file CategoryViewer.php.

References formatList(), getCountMessage(), getSectionPagingLinks(), ContextSource\msg(), title, and wfEscapeWikiText().

Referenced by getHTML().

◆ getSectionPagingLinks()

CategoryViewer::getSectionPagingLinks (   $type)
private

Get the paging links for a section (subcats/pages/files), to go at the top and bottom of the output.

Parameters
string$type'page', 'subcat', or 'file'
Returns
string HTML output, possibly empty if there are no other pages

Definition at line 496 of file CategoryViewer.php.

References $type, from, and pagingLinks().

Referenced by getImageSection(), getPagesSection(), and getSubcategorySection().

◆ getSubcategorySection()

CategoryViewer::getSubcategorySection ( )
Returns
string

Definition at line 407 of file CategoryViewer.php.

References formatList(), getCountMessage(), getSectionPagingLinks(), and ContextSource\msg().

Referenced by getHTML().

◆ getSubcategorySortChar()

CategoryViewer::getSubcategorySortChar (   $title,
  $sortkey 
)

Get the character to be used for sorting subcategories.

If there's a link from Category:A to Category:B, the sortkey of the resulting entry in the categorylinks table is Category:A, not A, which it SHOULD be. Workaround: If sortkey == "Category:".$title, than use $title for sorting, else use sortkey...

Parameters
Title$title
string$sortkeyThe human-readable sortkey (before transforming to icu or whatever).
Returns
string

Definition at line 223 of file CategoryViewer.php.

References $title, $wgContLang, Title\getDBkey(), Title\getPrefixedText(), and global.

Referenced by addSubcategoryObject().

◆ pagingLinks()

CategoryViewer::pagingLinks (   $first,
  $last,
  $type = '' 
)
private

Create paging links, as a helper method to getSectionPagingLinks().

Parameters
string$firstThe 'until' parameter for the generated URL
string$lastThe 'from' parameter for the generated URL
string$typeA prefix for parameters, 'page' or 'subcat' or 'file'
Returns
string HTML

Definition at line 631 of file CategoryViewer.php.

References $last, $linkRenderer, $query, $type, addFragmentToTitle(), ContextSource\msg(), and title.

Referenced by getSectionPagingLinks().

◆ shortList()

static CategoryViewer::shortList (   $articles,
  $articles_start_char 
)
static

Format a list of articles chunked by letter in a bullet list.

This is used for categories with a small number of pages (when columns aren't needed).

Parameters
string[]$articlesHTML links to each article
string[]$articles_start_charThe header characters for each article
Returns
string HTML to output
Access:\n private

Definition at line 607 of file CategoryViewer.php.

References $articles, and $articles_start_char.

Referenced by formatList().

Member Data Documentation

◆ $articles

string [] CategoryViewer::$articles

Definition at line 35 of file CategoryViewer.php.

Referenced by columnList(), formatList(), and shortList().

◆ $articles_start_char

array CategoryViewer::$articles_start_char

Definition at line 38 of file CategoryViewer.php.

Referenced by columnList(), formatList(), and shortList().

◆ $cat

Category CategoryViewer::$cat
private

Category object for this page.

Definition at line 74 of file CategoryViewer.php.

Referenced by addSubcategoryObject(), and doCategoryQuery().

◆ $children

array CategoryViewer::$children

Definition at line 41 of file CategoryViewer.php.

◆ $children_start_char

array CategoryViewer::$children_start_char

Definition at line 44 of file CategoryViewer.php.

◆ $collation

Collation CategoryViewer::$collation

Definition at line 68 of file CategoryViewer.php.

◆ $flip

array CategoryViewer::$flip

Definition at line 62 of file CategoryViewer.php.

Referenced by addImage().

◆ $from

array CategoryViewer::$from

Definition at line 29 of file CategoryViewer.php.

Referenced by __construct().

◆ $gallery

ImageGalleryBase CategoryViewer::$gallery

Definition at line 71 of file CategoryViewer.php.

◆ $imgsNoGallery

array CategoryViewer::$imgsNoGallery

Definition at line 53 of file CategoryViewer.php.

◆ $imgsNoGallery_start_char

array CategoryViewer::$imgsNoGallery_start_char

Definition at line 50 of file CategoryViewer.php.

◆ $limit

int CategoryViewer::$limit

Definition at line 26 of file CategoryViewer.php.

◆ $nextPage

array CategoryViewer::$nextPage

Definition at line 56 of file CategoryViewer.php.

◆ $prevPage

array CategoryViewer::$prevPage
protected

Definition at line 59 of file CategoryViewer.php.

◆ $query

array CategoryViewer::$query
private

The original query array, to be used in generating paging links.

Definition at line 77 of file CategoryViewer.php.

Referenced by __construct(), and pagingLinks().

◆ $showGallery

bool CategoryViewer::$showGallery

Definition at line 47 of file CategoryViewer.php.

◆ $title

◆ $until

array CategoryViewer::$until

Definition at line 32 of file CategoryViewer.php.

Referenced by __construct().


The documentation for this class was generated from the following file: