MediaWiki
1.30.0
|
Category objects are immutable, strictly speaking. More...
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. More... | |
getName () | |
getPageCount () | |
getSubcatCount () | |
getTitle () | |
refreshCounts () | |
Refresh the counts for this category. More... | |
Static Public Member Functions | |
static | newFromID ( $id) |
Factory function. More... | |
static | newFromName ( $name) |
Factory function. More... | |
static | newFromRow ( $row, $title=null) |
Factory function, for constructing a Category object from a result set. More... | |
static | newFromTitle ( $title) |
Factory function. More... | |
Public Attributes | |
$mFiles = null | |
$mSubcats = null | |
const | LAZY_INIT_ROW = 1 |
const | LOAD_ONLY = 0 |
Protected Member Functions | |
initialize ( $mode=self::LOAD_ONLY) | |
Set up all member variables using a database query. More... | |
Private Member Functions | |
__construct () | |
getX ( $key) | |
Generic accessor. More... | |
Private Attributes | |
$mID = null | |
$mName = null | |
Name of the category, normalized to DB-key form. More... | |
$mPages = null | |
Counts of membership (cat_pages, cat_subcats, cat_files) More... | |
Title | $mTitle = null |
Category page title. More... | |
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 31 of file Category.php.
|
private |
Definition at line 46 of file Category.php.
Category::getFileCount | ( | ) |
Definition at line 244 of file Category.php.
References getX().
Category::getID | ( | ) |
Definition at line 223 of file Category.php.
References getX().
Category::getMembers | ( | $limit = false , |
|
$offset = '' |
|||
) |
Fetch a TitleArray of up to $limit category members, beginning after the category sort key $offset.
int | bool | $limit | |
string | $offset |
Definition at line 271 of file Category.php.
References $dbr, $options, DB_REPLICA, getName(), TitleArray\newFromResult(), and wfGetDB().
Category::getName | ( | ) |
Definition at line 216 of file Category.php.
References getX().
Referenced by getMembers().
Category::getPageCount | ( | ) |
Definition at line 230 of file Category.php.
References getX().
Category::getSubcatCount | ( | ) |
Definition at line 237 of file Category.php.
References getX().
Category::getTitle | ( | ) |
Definition at line 251 of file Category.php.
References $mTitle, initialize(), Title\makeTitleSafe(), and NS_CATEGORY.
Referenced by CategoryViewer\addSubcategoryObject(), and refreshCounts().
|
private |
Generic accessor.
string | $key |
Definition at line 304 of file Category.php.
References initialize().
Referenced by getFileCount(), getID(), getName(), getPageCount(), and getSubcatCount().
|
protected |
Set up all member variables using a database query.
int | $mode |
MWException |
Definition at line 55 of file Category.php.
References $dbr, $mID, $mName, DeferredUpdates\addCallableUpdate(), DB_REPLICA, and wfGetDB().
Referenced by getTitle(), getX(), and refreshCounts().
|
static |
Factory function.
int | $id | A category id |
Definition at line 161 of file Category.php.
|
static |
Factory function.
array | $name | A category name (no "Category:" prefix). It need not be normalized, with spaces replaced by underscores. |
Definition at line 126 of file Category.php.
References $name, $title, Title\makeTitleSafe(), and NS_CATEGORY.
Referenced by PopulateCategory\execute(), MediaWiki\Search\ParserOutputSearchDataExtractor\getCategories(), and WikiPage\updateCategoryCounts().
|
static |
Factory function, for constructing a Category object from a result set.
object | $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 title object was given. If the fields are null and no title was given, this method fails and returns false. |
Title | $title | Optional title object for the category represented by the given row. May be provided if it is already known, to avoid having to re-create a title object later. |
Definition at line 179 of file Category.php.
References $title.
Referenced by CategoryViewer\doCategoryQuery(), LinksDeletionUpdate\doUpdate(), and WikiPage\updateCategoryCounts().
|
static |
Factory function.
Definition at line 146 of file Category.php.
References $title.
Referenced by CategoryViewer\__construct(), MediaWiki\Widget\Search\FullSearchResultWidget\generateSizeHtml(), WikiCategoryPage\hasViewableContent(), WikiPage\onArticleCreate(), InfoAction\pageInfo(), and CoreParserFunctions\pagesincategory().
Category::refreshCounts | ( | ) |
Refresh the counts for this category.
Definition at line 316 of file Category.php.
References $name, DB_MASTER, getTitle(), initialize(), NS_CATEGORY, NS_FILE, wfGetDB(), and wfReadOnly().
Category::$mFiles = null |
Definition at line 41 of file Category.php.
|
private |
Definition at line 34 of file Category.php.
Referenced by initialize().
|
private |
Name of the category, normalized to DB-key form.
Definition at line 33 of file Category.php.
Referenced by initialize().
|
private |
Counts of membership (cat_pages, cat_subcats, cat_files)
Definition at line 41 of file Category.php.
Category::$mSubcats = null |
Definition at line 41 of file Category.php.
|
private |
const Category::LAZY_INIT_ROW = 1 |
Definition at line 44 of file Category.php.
const Category::LOAD_ONLY = 0 |
Definition at line 43 of file Category.php.