Category objects are immutable, strictly speaking. More...

Collaboration diagram for Category:

[legend]

Public Member Functions
	getFileCount ()

	getID ()

	getMembers ( $limit=false, $offset='')
	Fetch a TitleArray of up to $limit category members, beginning after the category sort key $offset.

	getName ()

	getPage ()

	getPageCount ()

	getSubcatCount ()

	getTitle ()

	refreshCounts ()
	Refresh the counts for this category.

	refreshCountsIfEmpty ()
	Call refreshCounts() if there are no entries in the categorylinks table or if the category table has a row that states that there are no entries.

	refreshCountsIfSmall ( $maxSize=self::ROW_COUNT_SMALL)
	Call refreshCounts() if there are few entries in the categorylinks table.

Static Public Member Functions
static	newFromID ( $id)
	Factory function.

static	newFromName ( $name)
	Factory function.

static	newFromRow (stdClass $row, ?PageIdentity $page=null)
	Factory function, for constructing a Category object from a result set.

static	newFromTitle (PageIdentity $page)
	Factory function.

Public Attributes
const	ROW_COUNT_SMALL = 100

Protected Member Functions
	initialize ( $mode=self::LOAD_ONLY)
	Set up all member variables using a database query.

Protected Attributes
const	LAZY_INIT_ROW = 1

const	LOAD_ONLY = 0

Private Member Functions
	__construct ()

	getX ( $key)
	Generic accessor.

Private Attributes
ILoadBalancer	$loadBalancer

	$mFiles = null

	$mID = null

	$mName = null
	Name of the category, normalized to DB-key form.

PageIdentity	$mPage = null
	Category page title.

	$mPages = null
	Counts of membership (cat_pages, cat_subcats, cat_files)

	$mSubcats = null

ReadOnlyMode	$readOnlyMode

Detailed Description

Category objects are immutable, strictly speaking.

If you call methods that change the database, like to refresh link counts, the objects will be appropriately reinitialized. Member variables are lazy-initialized.

Definition at line 33 of file Category.php.

Constructor & Destructor Documentation

◆ __construct()

Category::__construct ( )

private

Definition at line 56 of file Category.php.

Member Function Documentation

◆ getFileCount()

Category::getFileCount ( )

Returns: mixed Number of member files, or false on failure

Definition at line 255 of file Category.php.

◆ getID()

Category::getID ( )

Returns: mixed Category ID, or false on failure

Definition at line 234 of file Category.php.

◆ getMembers()

Category::getMembers	(	$limit = `false`,
		$offset = `''`
	)

Fetch a TitleArray of up to $limit category members, beginning after the category sort key $offset.

Parameters

int \| bool	$limit
string	$offset

Returns: TitleArray TitleArray object for category members.

Definition at line 292 of file Category.php.

References $dbr, DB_REPLICA, and TitleArray\newFromResult().

◆ getName()

Category::getName ( )

Returns: mixed DB key name, or false on failure

Definition at line 227 of file Category.php.

◆ getPage()

Category::getPage ( )

Since: 1.37

Returns: ?PageIdentity the page associated with this category, or null on failure. NOTE: This returns null on failure, unlike getTitle() which returns false.

Definition at line 264 of file Category.php.

Referenced by CategoryViewer\addSubcategoryObject().

◆ getPageCount()

Category::getPageCount ( )

Returns: mixed Total number of member pages, or false on failure

Definition at line 241 of file Category.php.

◆ getSubcatCount()

Category::getSubcatCount ( )

Returns: mixed Number of subcategories, or false on failure

Definition at line 248 of file Category.php.

◆ getTitle()

Category::getTitle ( )

Deprecated:: since 1.37, use getPage() instead.

Returns: Title|bool Title for this category, or false on failure.

Definition at line 281 of file Category.php.

◆ getX()

Category::getX ( $key )

private

Generic accessor.

Parameters

string $key

Returns: mixed

Definition at line 325 of file Category.php.

◆ initialize()

Category::initialize ( $mode = self::LOAD_ONLY )

protected

Set up all member variables using a database query.

Parameters

int $mode One of (Category::LOAD_ONLY, Category::LAZY_INIT_ROW)

Exceptions

MWException

Returns: bool True on success, false on failure.

Definition at line 68 of file Category.php.

References $dbr, and DB_REPLICA.

◆ newFromID()

static Category::newFromID ( $id )

static

Factory function.

Parameters

int $id A category id. Warning, no validation is performed!

Returns: Category

Definition at line 174 of file Category.php.

◆ newFromName()

static Category::newFromName ( $name )

static

Factory function.

Parameters

string $name A category name (no "Category:" prefix). It need not be normalized, with spaces replaced by underscores.

Returns: Category|bool Category, or false on a totally invalid name

Definition at line 139 of file Category.php.

References $title, and NS_CATEGORY.

◆ newFromRow()

static Category::newFromRow	(	stdClass	$row,
		?PageIdentity	$page = `null`
	)

static

Factory function, for constructing a Category object from a result set.

Parameters

stdClass	$row	Result set row, must contain the cat_xxx fields. If the fields are null, the resulting Category object will represent an empty category if a page object was given. If the fields are null and no PageIdentity was given, this method fails and returns false.
PageIdentity \| null	$page	This must be provided if there is no cat_title field in $row.

Returns: Category|false

Definition at line 190 of file Category.php.

References MediaWiki\Page\PageReference\getDBkey().

◆ newFromTitle()

static Category::newFromTitle ( PageIdentity $page )

static

Factory function.

Parameters

PageIdentity $page Category page. Warning, no validation is performed!

Returns: Category

Definition at line 159 of file Category.php.

◆ refreshCounts()

Category::refreshCounts ( )

Refresh the counts for this category.

Returns: bool True on success, false on failure

Definition at line 337 of file Category.php.

References DB_PRIMARY, NS_CATEGORY, and NS_FILE.

◆ refreshCountsIfEmpty()

Category::refreshCountsIfEmpty ( )

Call refreshCounts() if there are no entries in the categorylinks table or if the category table has a row that states that there are no entries.

Due to lock errors or other failures, the precomputed counts can get out of sync, making it hard to know when to delete the category row without checking the categorylinks table.

Returns: bool Whether links were refreshed

Since: 1.32

Definition at line 456 of file Category.php.

◆ refreshCountsIfSmall()

Category::refreshCountsIfSmall ( $maxSize = self::ROW_COUNT_SMALL )

Call refreshCounts() if there are few entries in the categorylinks table.

Due to lock errors or other failures, the precomputed counts can get out of sync, making it hard to know when to delete the category row without checking the categorylinks table.

This method will do a non-locking select first to reduce contention.

Parameters

int $maxSize Only refresh if there are this or less many backlinks

Returns: bool Whether links were refreshed

Since: 1.34

Definition at line 473 of file Category.php.

References DB_PRIMARY.

Member Data Documentation

◆ $loadBalancer

ILoadBalancer Category::$loadBalancer

private

Definition at line 51 of file Category.php.

◆ $mFiles

Category::$mFiles = null

private

Definition at line 43 of file Category.php.

◆ $mID

Category::$mID = null

private

Definition at line 36 of file Category.php.

◆ $mName

Category::$mName = null

private

Name of the category, normalized to DB-key form.

Definition at line 35 of file Category.php.

◆ $mPage

PageIdentity Category::$mPage = null

private

Category page title.

Definition at line 41 of file Category.php.

◆ $mPages

Category::$mPages = null

private

Counts of membership (cat_pages, cat_subcats, cat_files)

Definition at line 43 of file Category.php.

◆ $mSubcats

Category::$mSubcats = null

private

Definition at line 43 of file Category.php.

◆ $readOnlyMode

ReadOnlyMode Category::$readOnlyMode

private

Definition at line 54 of file Category.php.

◆ LAZY_INIT_ROW

const Category::LAZY_INIT_ROW = 1

protected

Definition at line 46 of file Category.php.

◆ LOAD_ONLY

const Category::LOAD_ONLY = 0

protected

Definition at line 45 of file Category.php.

◆ ROW_COUNT_SMALL

const Category::ROW_COUNT_SMALL = 100

Definition at line 48 of file Category.php.

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

includes/Category.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFileCount()

◆ getID()

◆ getMembers()

◆ getName()

◆ getPage()

◆ getPageCount()

◆ getSubcatCount()

◆ getTitle()

◆ getX()

◆ initialize()

◆ newFromID()

◆ newFromName()

◆ newFromRow()

◆ newFromTitle()

◆ refreshCounts()

◆ refreshCountsIfEmpty()

◆ refreshCountsIfSmall()

Member Data Documentation

◆ $loadBalancer

◆ $mFiles

◆ $mID

◆ $mName

◆ $mPage

◆ $mPages

◆ $mSubcats

◆ $readOnlyMode

◆ LAZY_INIT_ROW

◆ LOAD_ONLY

◆ ROW_COUNT_SMALL