Merge "[FileBackend] Only show "copied file(s)" for files the script had to copy."
[lhc/web/wiklou.git] / includes / Category.php
index 9d9b5a6..7987069 100644 (file)
@@ -1,14 +1,33 @@
 <?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;
@@ -103,7 +122,7 @@ class Category {
         * Factory function.
         *
         * @param $title Title for the category page
-        * @return category|false on a totally invalid name
+        * @return Category|bool on a totally invalid name
         */
        public static function newFromTitle( $title ) {
                $cat = new self();
@@ -185,7 +204,7 @@ class Category {
        public function getFileCount() { return $this->getX( 'mFiles' ); }
 
        /**
-        * @return Title|false 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;
@@ -231,7 +250,10 @@ class Category {
                );
        }
 
-       /** Generic accessor */
+       /**
+        * Generic accessor
+        * @return bool
+        */
        private function getX( $key ) {
                if ( !$this->initialize() ) {
                        return false;
@@ -257,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
@@ -297,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;