Inherits MediaWiki\Context\ContextSource.

Collaboration diagram for MediaWiki\Category\CategoryViewer:

[legend]

Public Member Functions
	__construct (protected PageIdentity $page, IContextSource $context, public readonly array $from=[], public readonly array $until=[], private 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, string $sortkey, int $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
array string[]	$articles = []

array string[]	$articles_start_char = []

array string[]	$children = []

array string[]	$children_start_char = []

readonly Collation	$collation

array array< 'page'\| 'subcat'\| 'file', bool >	$flip = []
	Sorting order for each type.

ImageGalleryBase	$gallery

array string[]	$imgsNoGallery = []

array string[]	$imgsNoGallery_start_char = []

readonly int	$limit

array array< 'page'\| 'subcat'\| 'file',?string >	$nextPage = []

bool	$showGallery

Protected Member Functions
	clearCategoryState ()

	doCategoryQuery ()

	finaliseCategoryState ()

	getImageSection ()

	getPagesSection ()

	getSubcategorySection ()

Protected Attributes
array array< 'page'\| 'subcat'\| 'file',?string >	$prevPage = []

Detailed Description

Definition at line 35 of file CategoryViewer.php.

Constructor & Destructor Documentation

◆ __construct()

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

Since: 1.19 $context is a second, required parameter

Parameters

PageIdentity	$page
IContextSource	$context
	array<'page'\|'subcat'\|'file',?string>	$from An array with keys page, subcat, and file for offset of results of each section (since 1.17)
	array<'page'\|'subcat'\|'file',?string>	$until An array with 3 keys for until of each section (since 1.17)
array	$query	The original query array, to be used in generating paging links.

Definition at line 77 of file CategoryViewer.php.

References 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 249 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 279 of file CategoryViewer.php.

◆ addSubcategoryObject()

MediaWiki\Category\CategoryViewer::addSubcategoryObject	(	Category	$cat,
		string	$sortkey,
		int	$pageLength )

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

Parameters

Category	$cat
string	$sortkey
int	$pageLength

Definition at line 163 of file CategoryViewer.php.

◆ clearCategoryState()

MediaWiki\Category\CategoryViewer::clearCategoryState ( )

protected

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

◆ doCategoryQuery()

MediaWiki\Category\CategoryViewer::doCategoryQuery ( )

protected

Definition at line 306 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 291 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 110 of file CategoryViewer.php.

References MediaWiki\MainConfigNames\CategoryMagicGallery, MediaWiki\Category\CategoryViewer\clearCategoryState(), MediaWiki\Category\CategoryViewer\doCategoryQuery(), MediaWiki\Category\CategoryViewer\finaliseCategoryState(), MediaWiki\Context\ContextSource\getConfig(), MediaWiki\Category\CategoryViewer\getImageSection(), MediaWiki\Context\ContextSource\getLanguage(), MediaWiki\Context\ContextSource\getOutput(), MediaWiki\Category\CategoryViewer\getPagesSection(), MediaWiki\Category\CategoryViewer\getSubcategorySection(), and MediaWiki\Context\ContextSource\msg().

◆ getImageSection()

MediaWiki\Category\CategoryViewer::getImageSection ( )

protected

Returns: string HTML

Definition at line 501 of file CategoryViewer.php.

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

◆ getPagesSection()

MediaWiki\Category\CategoryViewer::getPagesSection ( )

protected

Returns: string HTML

Definition at line 468 of file CategoryViewer.php.

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

◆ getSubcategorySection()

MediaWiki\Category\CategoryViewer::getSubcategorySection ( )

protected

Returns: string HTML

Definition at line 445 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 235 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 658 of file CategoryViewer.php.

Member Data Documentation

◆ $articles

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

Definition at line 41 of file CategoryViewer.php.

◆ $articles_start_char

array string [] MediaWiki\Category\CategoryViewer::$articles_start_char = []

Definition at line 43 of file CategoryViewer.php.

◆ $children

array string [] MediaWiki\Category\CategoryViewer::$children = []

Definition at line 45 of file CategoryViewer.php.

◆ $children_start_char

array string [] MediaWiki\Category\CategoryViewer::$children_start_char = []

Definition at line 47 of file CategoryViewer.php.

◆ $collation

readonly Collation MediaWiki\Category\CategoryViewer::$collation

Definition at line 60 of file CategoryViewer.php.

◆ $flip

array array<'page'|'subcat'|'file',bool> MediaWiki\Category\CategoryViewer::$flip = []

Sorting order for each type.

Definition at line 58 of file CategoryViewer.php.

◆ $gallery

ImageGalleryBase MediaWiki\Category\CategoryViewer::$gallery

Definition at line 61 of file CategoryViewer.php.

◆ $imgsNoGallery

array string [] MediaWiki\Category\CategoryViewer::$imgsNoGallery = []

Definition at line 52 of file CategoryViewer.php.

◆ $imgsNoGallery_start_char

array string [] MediaWiki\Category\CategoryViewer::$imgsNoGallery_start_char = []

Definition at line 50 of file CategoryViewer.php.

◆ $limit

readonly int MediaWiki\Category\CategoryViewer::$limit

Definition at line 39 of file CategoryViewer.php.

◆ $nextPage

array array<'page'|'subcat'|'file',?string> MediaWiki\Category\CategoryViewer::$nextPage = []

Definition at line 54 of file CategoryViewer.php.

◆ $prevPage

array array<'page'|'subcat'|'file',?string> MediaWiki\Category\CategoryViewer::$prevPage = []

protected

Definition at line 56 of file CategoryViewer.php.

◆ $showGallery

bool MediaWiki\Category\CategoryViewer::$showGallery

Definition at line 48 of file CategoryViewer.php.

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

◆ getHTML()

◆ getImageSection()

◆ getPagesSection()

◆ getSubcategorySection()

◆ getSubcategorySortChar()

◆ shortList()

Member Data Documentation

◆ $articles

◆ $articles_start_char

◆ $children

◆ $children_start_char

◆ $collation

◆ $flip

◆ $gallery

◆ $imgsNoGallery

◆ $imgsNoGallery_start_char

◆ $limit

◆ $nextPage

◆ $prevPage

◆ $showGallery