Merge "Fix trailing whitespace (and mixed spaces) in XSD files"

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

diff --git a/includes/UserArray.php b/includes/UserArray.php
index a69df41..3b8f5c1 100644 (file)
--- a/includes/UserArray.php
+++ b/includes/UserArray.php
@@ -1,9 +1,28 @@
 <?php
+/**
+ * Classes to walk into a list of User objects.
+ *
+ * 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
+ */
 
 abstract class UserArray implements Iterator {
-
        /**
-        * @param $res
+        * @param $res ResultWrapper
         * @return UserArrayFromResult
         */
        static function newFromResult( $res ) {
@@ -33,22 +52,36 @@ abstract class UserArray implements Iterator {
                return self::newFromResult( $res );
        }
 
+       /**
+        * @param $res
+        * @return UserArrayFromResult
+        */
        protected static function newFromResult_internal( $res ) {
-               $userArray = new UserArrayFromResult( $res );
-               return $userArray;
+               return new UserArrayFromResult( $res );
        }
 }
 
 class UserArrayFromResult extends UserArray {
+
+       /**
+        * @var ResultWrapper
+        */
        var $res;
        var $key, $current;
 
+       /**
+        * @param $res ResultWrapper
+        */
        function __construct( $res ) {
                $this->res = $res;
                $this->key = 0;
                $this->setCurrent( $this->res->current() );
        }
 
+       /**
+        * @param  $row
+        * @return void
+        */
        protected function setCurrent( $row ) {
                if ( $row === false ) {
                        $this->current = false;
@@ -57,10 +90,16 @@ class UserArrayFromResult extends UserArray {
                }
        }
 
+       /**
+        * @return int
+        */
        public function count() {
                return $this->res->numRows();
        }
 
+       /**
+        * @return User
+        */
        function current() {
                return $this->current;
        }
@@ -81,6 +120,9 @@ class UserArrayFromResult extends UserArray {
                $this->setCurrent( $this->res->current() );
        }
 
+       /**
+        * @return bool
+        */
        function valid() {
                return $this->current !== false;
        }