Inherits MediaWiki\Context\ContextSource.

Collaboration diagram for MediaWiki\Category\CategoryViewer:

[legend]

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

	addImage (PageReference $page, string $sortkey, int $pageLength, bool $isRedirect=false)
	Add a page in the image namespace.

	addPage (PageReference $page, string $sortkey, int $pageLength, bool $isRedirect=false)
	Add a miscellaneous page.

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

	getHTML ()
	Format the category data list.

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

Public Member Functions inherited from MediaWiki\Context\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.

	getActionName ()
	Get the action name for the current web request.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.

	getLanguage ()

	getLanguageCode ()

	getOutput ()

	getRequest ()

	getSkin ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key,... $params)
	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, $cssClasses='mw-category mw-category-columns')
	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

array	$until

Protected Member Functions
	clearCategoryState ()

	doCategoryQuery ()

	finaliseCategoryState ()

	getCategoryBottom ()

	getCategoryTop ()

	getImageSection ()

	getPagesSection ()

	getSubcategorySection ()

Protected Attributes
PageIdentity	$page

array	$prevPage

Detailed Description

Definition at line 33 of file CategoryViewer.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Category\CategoryViewer::__construct	(	PageIdentity	$page,
		IContextSource	$context,
		array	$from = [],
		array	$until = [],
		array	$query = [] )

Since: 1.19 $context is a second, required parameter

Parameters

PageIdentity	$page
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 103 of file CategoryViewer.php.

References MediaWiki\Category\CategoryViewer\$from, MediaWiki\Category\CategoryViewer\$page, MediaWiki\Category\CategoryViewer\$until, MediaWiki\MainConfigNames\CategoryPagingLimit, MediaWiki\Context\IContextSource\getConfig(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Context\ContextSource\getOutput(), MediaWiki\Category\Category\newFromTitle(), and MediaWiki\Context\ContextSource\setContext().

Member Function Documentation

◆ addImage()

MediaWiki\Category\CategoryViewer::addImage	(	PageReference	$page,
		string	$sortkey,
		int	$pageLength,
		bool	$isRedirect = false )

Add a page in the image namespace.

Parameters

PageReference	$page
string	$sortkey
int	$pageLength
bool	$isRedirect

Definition at line 292 of file CategoryViewer.php.

◆ addPage()

MediaWiki\Category\CategoryViewer::addPage	(	PageReference	$page,
		string	$sortkey,
		int	$pageLength,
		bool	$isRedirect = false )

Add a miscellaneous page.

Parameters

PageReference	$page
string	$sortkey
int	$pageLength
bool	$isRedirect

Definition at line 319 of file CategoryViewer.php.

◆ addSubcategoryObject()

MediaWiki\Category\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 209 of file CategoryViewer.php.

References MediaWiki\Category\CategoryViewer\$page, MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Category\Category\getPage().

◆ clearCategoryState()

MediaWiki\Category\CategoryViewer::clearCategoryState ( )

protected

Definition at line 181 of file CategoryViewer.php.

References MediaWiki\Gallery\ImageGalleryBase\factory(), MediaWiki\Context\ContextSource\getContext(), and MediaWiki\Context\ContextSource\getRequest().

Referenced by MediaWiki\Category\CategoryViewer\getHTML().

◆ columnList()

static MediaWiki\Category\CategoryViewer::columnList	(	$articles,
		$articles_start_char,
		$cssClasses = 'mw-category mw-category-columns' )

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.

Parameters

string[]	$articles	HTML links to each article
string[]	$articles_start_char	The header characters for each article
string	$cssClasses	CSS classes for the wrapper element

Returns: string HTML to output

Access: internal

Definition at line 634 of file CategoryViewer.php.

◆ doCategoryQuery()

MediaWiki\Category\CategoryViewer::doCategoryQuery ( )

protected

Definition at line 346 of file CategoryViewer.php.

References NS_CATEGORY, and NS_FILE.

Referenced by MediaWiki\Category\CategoryViewer\getHTML().

◆ finaliseCategoryState()

MediaWiki\Category\CategoryViewer::finaliseCategoryState ( )

protected

Definition at line 331 of file CategoryViewer.php.

Referenced by MediaWiki\Category\CategoryViewer\getHTML().

◆ getCategoryBottom()

MediaWiki\Category\CategoryViewer::getCategoryBottom ( )

protected

Returns: string

Definition at line 591 of file CategoryViewer.php.

Referenced by MediaWiki\Category\CategoryViewer\getHTML().

◆ getCategoryTop()

MediaWiki\Category\CategoryViewer::getCategoryTop ( )

protected

Returns: string HTML

Definition at line 453 of file CategoryViewer.php.

Referenced by MediaWiki\Category\CategoryViewer\getHTML().

◆ getHTML()

MediaWiki\Category\CategoryViewer::getHTML ( )

Format the category data list.

Returns: string HTML output

Definition at line 139 of file CategoryViewer.php.

◆ getImageSection()

MediaWiki\Category\CategoryViewer::getImageSection ( )

protected

Returns: string HTML

Definition at line 519 of file CategoryViewer.php.

Referenced by MediaWiki\Category\CategoryViewer\getHTML().

◆ getPagesSection()

MediaWiki\Category\CategoryViewer::getPagesSection ( )

protected

Returns: string HTML

Definition at line 486 of file CategoryViewer.php.

Referenced by MediaWiki\Category\CategoryViewer\getHTML().

◆ getSubcategorySection()

MediaWiki\Category\CategoryViewer::getSubcategorySection ( )

protected

Returns: string HTML

Definition at line 463 of file CategoryViewer.php.

Referenced by MediaWiki\Category\CategoryViewer\getHTML().

◆ getSubcategorySortChar()

MediaWiki\Category\CategoryViewer::getSubcategorySortChar	(	PageIdentity	$page,
		string	$sortkey )

Get the character to be used for sorting subcategories.

Deprecated: since 1.45, treat sortkey for sub-category the same as for others instead.

Parameters

PageIdentity	$page
string	$sortkey	The human-readable sortkey (before transforming to icu or whatever).

Returns: string

Definition at line 278 of file CategoryViewer.php.

◆ shortList()

static MediaWiki\Category\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: internal

Definition at line 683 of file CategoryViewer.php.

Member Data Documentation

◆ $articles

string [] MediaWiki\Category\CategoryViewer::$articles

Definition at line 47 of file CategoryViewer.php.

◆ $articles_start_char

array MediaWiki\Category\CategoryViewer::$articles_start_char

Definition at line 50 of file CategoryViewer.php.

◆ $children

array MediaWiki\Category\CategoryViewer::$children

Definition at line 53 of file CategoryViewer.php.

◆ $children_start_char

array MediaWiki\Category\CategoryViewer::$children_start_char

Definition at line 56 of file CategoryViewer.php.

◆ $collation

Collation MediaWiki\Category\CategoryViewer::$collation

Definition at line 80 of file CategoryViewer.php.

◆ $flip

array MediaWiki\Category\CategoryViewer::$flip

Definition at line 74 of file CategoryViewer.php.

◆ $from

array MediaWiki\Category\CategoryViewer::$from

Definition at line 41 of file CategoryViewer.php.

Referenced by MediaWiki\Category\CategoryViewer\__construct().

◆ $gallery

ImageGalleryBase MediaWiki\Category\CategoryViewer::$gallery

Definition at line 83 of file CategoryViewer.php.

◆ $imgsNoGallery

array MediaWiki\Category\CategoryViewer::$imgsNoGallery

Definition at line 65 of file CategoryViewer.php.

◆ $imgsNoGallery_start_char

array MediaWiki\Category\CategoryViewer::$imgsNoGallery_start_char

Definition at line 62 of file CategoryViewer.php.

◆ $limit

int MediaWiki\Category\CategoryViewer::$limit

Definition at line 38 of file CategoryViewer.php.

◆ $nextPage

array MediaWiki\Category\CategoryViewer::$nextPage

Definition at line 68 of file CategoryViewer.php.

◆ $page

PageIdentity MediaWiki\Category\CategoryViewer::$page

protected

Definition at line 77 of file CategoryViewer.php.

Referenced by MediaWiki\Category\CategoryViewer\__construct(), and MediaWiki\Category\CategoryViewer\addSubcategoryObject().

◆ $prevPage

array MediaWiki\Category\CategoryViewer::$prevPage

protected

Definition at line 71 of file CategoryViewer.php.

◆ $showGallery

bool MediaWiki\Category\CategoryViewer::$showGallery

Definition at line 59 of file CategoryViewer.php.

◆ $until

array MediaWiki\Category\CategoryViewer::$until

Definition at line 44 of file CategoryViewer.php.

Referenced by MediaWiki\Category\CategoryViewer\__construct().

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

includes/Category/CategoryViewer.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addImage()

◆ addPage()

◆ addSubcategoryObject()

◆ clearCategoryState()

◆ columnList()

◆ doCategoryQuery()

◆ finaliseCategoryState()

◆ getCategoryBottom()

◆ getCategoryTop()

◆ getHTML()

◆ getImageSection()

◆ getPagesSection()

◆ getSubcategorySection()

◆ getSubcategorySortChar()

◆ shortList()

Member Data Documentation

◆ $articles

◆ $articles_start_char

◆ $children

◆ $children_start_char

◆ $collation

◆ $flip

◆ $from

◆ $gallery

◆ $imgsNoGallery

◆ $imgsNoGallery_start_char

◆ $limit

◆ $nextPage

◆ $page

◆ $prevPage

◆ $showGallery

◆ $until