Merge "(bug 36761) "Mark pages as visited" should submit previously established filte...

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

diff --git a/includes/Categoryfinder.php b/includes/Categoryfinder.php
index 50fe1f0..e2b6a0c 100644 (file)
--- a/includes/Categoryfinder.php
+++ b/includes/Categoryfinder.php
@@ -1,4 +1,25 @@
 <?php
+/**
+ * Recent changes filtering by 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
+ */
+
 /**
  * The "Categoryfinder" class takes a list of articles, creates an internal
  * representation of all their parent categories (as well as parents of
@@ -29,6 +50,10 @@ class Categoryfinder {
        var $targets = array(); # Array of DBKEY category names
        var $name2id = array();
        var $mode; # "AND" or "OR"
+
+       /**
+        * @var DatabaseBase
+        */
        var $dbr; # Read-DB slave
 
        /**
@@ -42,6 +67,7 @@ class Categoryfinder {
         * @param $article_ids Array of article IDs
         * @param $categories FIXME
         * @param $mode String: FIXME, default 'AND'.
+        * @todo FIXME: $categories/$mode
         */
        function seed( $article_ids, $categories, $mode = 'AND' ) {
                $this->articles = $article_ids;
@@ -85,9 +111,9 @@ class Categoryfinder {
 
        /**
         * This functions recurses through the parent representation, trying to match the conditions
-        * @param $id The article/category to check
-        * @param $conds The array of categories to match
-        * @param $path used to check for recursion loops
+        * @param $id int The article/category to check
+        * @param $conds array The array of categories to match
+        * @param $path array used to check for recursion loops
         * @return bool Does this match the conditions?
         */
        function check( $id, &$conds, $path = array() ) {
@@ -154,7 +180,7 @@ class Categoryfinder {
                        /* WHERE  */ array( 'cl_from' => $this->next ),
                        __METHOD__ . '-1'
                );
-               while ( $o = $this->dbr->fetchObject( $res ) ) {
+               foreach ( $res as $o ) {
                        $k = $o->cl_to;
 
                        # Update parent tree
@@ -186,7 +212,7 @@ class Categoryfinder {
                                /* WHERE  */ array( 'page_namespace' => NS_CATEGORY , 'page_title' => $layer ),
                                __METHOD__ . '-2'
                        );
-                       while ( $o = $this->dbr->fetchObject( $res ) ) {
+                       foreach ( $res as $o ) {
                                $id = $o->page_id;
                                $name = $o->page_title;
                                $this->name2id[$name] = $id;