X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FCategory.php;h=e326ce23cdfab5ba92259011d1bb539ad9ef0415;hb=f07ffa11f40b7263310b081132ab92f358a4b5b3;hp=868d6c4628d199e030a1a4d32dc0bf9a93f7b4fe;hpb=dc348e4df2e79a24e79b21ce265c8b0b481876bf;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Category.php b/includes/Category.php index 868d6c4628..e326ce23cd 100644 --- a/includes/Category.php +++ b/includes/Category.php @@ -26,7 +26,7 @@ * like to refresh link counts, the objects will be appropriately reinitialized. * Member variables are lazy-initialized. * - * TODO: Move some stuff from CategoryPage.php to here, and use that. + * @todo Move some stuff from CategoryPage.php to here, and use that. */ class Category { /** Name of the category, normalized to DB-key form */ @@ -40,7 +40,8 @@ class Category { /** Counts of membership (cat_pages, cat_subcats, cat_files) */ private $mPages = null, $mSubcats = null, $mFiles = null; - private function __construct() { } + private function __construct() { + } /** * Set up all member variables using a database query. @@ -74,7 +75,8 @@ class Category { if ( !$row ) { # Okay, there were no contents. Nothing to initialize. if ( $this->mTitle ) { - # If there is a title object but no record in the category table, treat this as an empty category + # If there is a title object but no record in the category table, + # treat this as an empty category. $this->mID = false; $this->mName = $this->mTitle->getDBkey(); $this->mPages = 0; @@ -154,11 +156,13 @@ class Category { /** * Factory function, for constructing a Category object from a result set * - * @param $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. - * @param 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. + * @param $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. + * @param 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. * @return Category */ public static function newFromRow( $row, $title = null ) { @@ -176,7 +180,8 @@ class Category { # but we can't know that here... return false; } else { - $cat->mName = $title->getDBkey(); # if we have a title object, fetch the category name from there + # if we have a title object, fetch the category name from there + $cat->mName = $title->getDBkey(); } $cat->mID = false; @@ -194,27 +199,37 @@ class Category { return $cat; } - /** @return mixed DB key name, or false on failure */ + /** + * @return mixed DB key name, or false on failure + */ public function getName() { return $this->getX( 'mName' ); } - /** @return mixed Category ID, or false on failure */ + /** + * @return mixed Category ID, or false on failure + */ public function getID() { return $this->getX( 'mID' ); } - /** @return mixed Total number of member pages, or false on failure */ + /** + * @return mixed Total number of member pages, or false on failure + */ public function getPageCount() { return $this->getX( 'mPages' ); } - /** @return mixed Number of subcategories, or false on failure */ + /** + * @return mixed Number of subcategories, or false on failure + */ public function getSubcatCount() { return $this->getX( 'mSubcats' ); } - /** @return mixed Number of member files, or false on failure */ + /** + * @return mixed Number of member files, or false on failure + */ public function getFileCount() { return $this->getX( 'mFiles' ); }