| [ Index ] |
PHP Cross Reference of MediaWiki-1.24.0 |
[Source view] [Print] [Project Stats]
Representation for a category. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
| Author: | Simetrical |
| File Size: | 375 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 1 time |
| Includes or requires: | 0 files |
Category:: (15 methods):
__construct()
initialize()
newFromName()
newFromTitle()
newFromID()
newFromRow()
getName()
getID()
getPageCount()
getSubcatCount()
getFileCount()
getTitle()
getMembers()
getX()
refreshCounts()
| __construct() X-Ref |
| No description |
| initialize() X-Ref |
| Set up all member variables using a database query. return: bool True on success, false on failure. |
| newFromName( $name ) X-Ref |
| Factory function. param: array $name A category name (no "Category:" prefix). It need return: mixed Category, or false on a totally invalid name |
| newFromTitle( $title ) X-Ref |
| Factory function. param: Title $title Title for the category page return: Category|bool On a totally invalid name |
| newFromID( $id ) X-Ref |
| Factory function. param: int $id A category id return: Category |
| newFromRow( $row, $title = null ) X-Ref |
| Factory function, for constructing a Category object from a result set param: object $row Result set row, must contain the cat_xxx fields. If the param: Title $title Optional title object for the category represented by return: Category |
| getName() X-Ref |
return: mixed DB key name, or false on failure |
| getID() X-Ref |
return: mixed Category ID, or false on failure |
| getPageCount() X-Ref |
return: mixed Total number of member pages, or false on failure |
| getSubcatCount() X-Ref |
return: mixed Number of subcategories, or false on failure |
| getFileCount() X-Ref |
return: mixed Number of member files, or false on failure |
| getTitle() X-Ref |
return: Title|bool Title for this category, or false on failure. |
| getMembers( $limit = false, $offset = '' ) X-Ref |
| Fetch a TitleArray of up to $limit category members, beginning after the category sort key $offset. param: int $limit param: string $offset return: TitleArray TitleArray object for category members. |
| getX( $key ) X-Ref |
| Generic accessor param: string $key return: bool |
| refreshCounts() X-Ref |
| Refresh the counts for this category. return: bool True on success, false on failure |
| Generated: Fri Nov 28 14:03:12 2014 | Cross-referenced by PHPXref 0.7.1 |