Inheritance diagram for CategoryViewer:

[legend]

Collaboration diagram for CategoryViewer:

[legend]

Public Member Functions
	__construct ( $title, IContextSource $context, $from=[], $until=[], $query=[])

	addImage (Title $title, $sortkey, $pageLength, $isRedirect=false)
	Add a page in the image namespace.

	addPage ( $title, $sortkey, $pageLength, $isRedirect=false)
	Add a miscellaneous page.

	addSubcategoryObject (Category $cat, $sortkey, $pageLength)
	Add a subcategory to the internal lists, using a Category object.

	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.

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

	getCategoryBottom ()

	getCategoryTop ()

	getHTML ()
	Format the category data list.

	getImageSection ()

	getPagesSection ()

	getSubcategorySection ()

	getSubcategorySortChar ( $title, $sortkey)
	Get the character to be used for sorting subcategories.

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key)
	Get a Message object with context set Parameters are the same as wfMessage()

	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.

static	shortList ( $articles, $articles_start_char)
	Format a list of articles chunked by letter in a bullet list.

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.

	getCountMessage ( $rescnt, $dbcnt, $type)
	What to do if the category table conflicts with the number of results returned? This function says what.

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

	pagingLinks ( $first, $last, $type='')
	Create paging links, as a helper method to getSectionPagingLinks().

Private Attributes
Category	$cat
	Category object for this page.

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

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	$from	An array with keys page, subcat, and file for offset of results of each section (since 1.17)
array	$until	An 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(), 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	$title	The title (usually $this->title)
string	$section	Which section

Exceptions

MWException

Returns: Title

Definition at line 666 of file CategoryViewer.php.

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

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 242 of file CategoryViewer.php.

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

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 265 of file CategoryViewer.php.

References generateLink().

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 ( )

Definition at line 152 of file CategoryViewer.php.

References $e, ImageGalleryBase\factory(), ContextSource\getContext(), and ContextSource\getRequest().

Referenced by getHTML().

◆ 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[]	$articles	HTML links to each article
string[]	$articles_start_char	The header characters for each article

Returns: string HTML to output

Access:\n private

Definition at line 559 of file CategoryViewer.php.

References $article, $articles, $articles_start_char, $ret, and as.

Referenced by formatList().

◆ doCategoryQuery()

CategoryViewer::doCategoryQuery ( )

Definition at line 287 of file CategoryViewer.php.

References $cat, $dbr, $res, $title, $type, addImage(), addPage(), addSubcategoryObject(), as, DB_REPLICA, false, from, Title\getCategorySortkey(), Title\getNamespace(), NS_CATEGORY, NS_FILE, title, and wfGetDB().

Referenced by getHTML().

◆ finaliseCategoryState()

CategoryViewer::finaliseCategoryState ( )

Definition at line 272 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 528 of file CategoryViewer.php.

References $articles, $articles_start_char, $attribs, columnList(), 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, and $type.

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

◆ getCategoryBottom()

CategoryViewer::getCategoryBottom ( )

Returns: string

Definition at line 514 of file CategoryViewer.php.

Referenced by getCategoryTop(), and getHTML().

◆ getCategoryTop()

CategoryViewer::getCategoryTop ( )

Returns: string

Definition at line 392 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	$rescnt	The number of items returned by our database query.
int	$dbcnt	The 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 696 of file CategoryViewer.php.

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

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

◆ getHTML()

CategoryViewer::getHTML ( )

Format the category data list.

Returns: string HTML output

Definition at line 110 of file CategoryViewer.php.

References $attribs, $lang, clearCategoryState(), doCategoryQuery(), finaliseCategoryState(), getCategoryBottom(), getCategoryTop(), ContextSource\getConfig(), getImageSection(), ContextSource\getLanguage(), ContextSource\getOutput(), getPagesSection(), getSubcategorySection(), and ContextSource\msg().

◆ getImageSection()

CategoryViewer::getImageSection ( )

Returns: string

Definition at line 456 of file CategoryViewer.php.

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

Referenced by getHTML().

◆ getPagesSection()

CategoryViewer::getPagesSection ( )

Returns: string

Definition at line 426 of file CategoryViewer.php.

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

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 489 of file CategoryViewer.php.

References $type, from, and pagingLinks().

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

◆ getSubcategorySection()

CategoryViewer::getSubcategorySection ( )

Returns: string

Definition at line 402 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	$sortkey	The human-readable sortkey (before transforming to icu or whatever).

Returns: string

Definition at line 223 of file CategoryViewer.php.

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

Referenced by addSubcategoryObject().

◆ pagingLinks()

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

private

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

Parameters

string	$first	The 'until' parameter for the generated URL
string	$last	The 'from' parameter for the generated URL
string	$type	A prefix for parameters, 'page' or 'subcat' or 'file'

Returns: string HTML

Definition at line 624 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[]	$articles	HTML links to each article
string[]	$articles_start_char	The header characters for each article

Returns: string HTML to output

Access:\n private

Definition at line 600 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

Title CategoryViewer::$title

Definition at line 65 of file CategoryViewer.php.

Referenced by __construct(), addFragmentToTitle(), addImage(), addSubcategoryObject(), doCategoryQuery(), generateLink(), and getSubcategorySortChar().

◆ $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:

includes/CategoryViewer.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFragmentToTitle()

◆ addImage()

◆ addPage()

◆ addSubcategoryObject()

◆ clearCategoryState()

◆ columnList()

◆ doCategoryQuery()

◆ finaliseCategoryState()

◆ formatList()

◆ generateLink()

◆ getCategoryBottom()

◆ getCategoryTop()

◆ getCountMessage()

◆ getHTML()

◆ getImageSection()

◆ getPagesSection()

◆ getSectionPagingLinks()

◆ getSubcategorySection()

◆ getSubcategorySortChar()

◆ pagingLinks()

◆ shortList()

Member Data Documentation

◆ $articles

◆ $articles_start_char

◆ $cat

◆ $children

◆ $children_start_char

◆ $collation

◆ $flip

◆ $from

◆ $gallery

◆ $imgsNoGallery

◆ $imgsNoGallery_start_char

◆ $limit

◆ $nextPage

◆ $prevPage

◆ $query

◆ $showGallery

◆ $title

◆ $until