Merge "Follow-up I0b781c11 (2a55449): use User::getAutomaticGroups()."

[lhc/web/wiklou.git] / includes / Category.php

diff --git a/includes/Category.php b/includes/Category.php
index 614933f..b7b12e8 100644 (file)
--- a/includes/Category.php
+++ b/includes/Category.php
@@ -1,19 +1,41 @@
 <?php
+/**
+ * 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.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @author Simetrical
+ */
+
 /**
  * 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.
  *
  * TODO: Move some stuff from CategoryPage.php to here, and use that.
- *
- * @author Simetrical
  */
-
 class Category {
        /** Name of the category, normalized to DB-key form */
        private $mName = null;
        private $mID = null;
-       /** Category page title */
+       /**
+        * Category page title
+        * @var Title
+        */
        private $mTitle = null;
        /** Counts of membership (cat_pages, cat_subcats, cat_files) */
        private $mPages = null, $mSubcats = null, $mFiles = null;
@@ -100,7 +122,7 @@ class Category {
         * Factory function.
         *
         * @param $title Title for the category page
-        * @return Mixed: category, or false on a totally invalid name
+        * @return Category|bool on a totally invalid name
         */
        public static function newFromTitle( $title ) {
                $cat = new self();
@@ -129,7 +151,7 @@ class Category {
         * @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 optional title object for the category represented by the given row.
+        * @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
         */
@@ -182,7 +204,7 @@ class Category {
        public function getFileCount() { return $this->getX( 'mFiles' ); }
 
        /**
-        * @return mixed The Title for this category, or false on failure.
+        * @return Title|bool Title for this category, or false on failure.
         */
        public function getTitle() {
                if ( $this->mTitle ) return $this->mTitle;
@@ -228,7 +250,10 @@ class Category {
                );
        }
 
-       /** Generic accessor */
+       /**
+        * Generic accessor
+        * @return bool
+        */
        private function getX( $key ) {
                if ( !$this->initialize() ) {
                        return false;
@@ -254,7 +279,7 @@ class Category {
                }
 
                $dbw = wfGetDB( DB_MASTER );
-               $dbw->begin();
+               $dbw->begin( __METHOD__  );
 
                # Insert the row if it doesn't exist yet (e.g., this is being run via
                # update.php from a pre-1.16 schema).  TODO: This will cause lots and
@@ -272,13 +297,13 @@ class Category {
                        'IGNORE'
                );
 
-               $cond1 = $dbw->conditional( 'page_namespace=' . NS_CATEGORY, 1, 'NULL' );
-               $cond2 = $dbw->conditional( 'page_namespace=' . NS_FILE, 1, 'NULL' );
+               $cond1 = $dbw->conditional( array( 'page_namespace' => NS_CATEGORY ), 1, 'NULL' );
+               $cond2 = $dbw->conditional( array( 'page_namespace' => NS_FILE ), 1, 'NULL' );
                $result = $dbw->selectRow(
                        array( 'categorylinks', 'page' ),
-                       array( 'COUNT(*) AS pages',
-                                  "COUNT($cond1) AS subcats",
-                                  "COUNT($cond2) AS files"
+                       array( 'pages' => 'COUNT(*)',
+                                  'subcats' => "COUNT($cond1)",
+                                  'files' => "COUNT($cond2)"
                        ),
                        array( 'cl_to' => $this->mName, 'page_id = cl_from' ),
                        __METHOD__,
@@ -294,7 +319,7 @@ class Category {
                        array( 'cat_title' => $this->mName ),
                        __METHOD__
                );
-               $dbw->commit();
+               $dbw->commit( __METHOD__ );
 
                # Now we should update our local counts.
                $this->mPages   = $result->pages;