includes/UserArrayFromResult.php

   1 <?php
   2 /**
   3  * Class to walk into a list of User objects.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 class UserArrayFromResult extends UserArray implements Countable {
  24
  25         /**
  26          * @var ResultWrapper
  27          */
  28         var $res;
  29         var $key, $current;
  30
  31         /**
  32          * @param ResultWrapper $res
  33          */
  34         function __construct( $res ) {
  35                 $this->res = $res;
  36                 $this->key = 0;
  37                 $this->setCurrent( $this->res->current() );
  38         }
  39
  40         /**
  41          * @param bool|stdClass $row
  42          * @return void
  43          */
  44         protected function setCurrent( $row ) {
  45                 if ( $row === false ) {
  46                         $this->current = false;
  47                 } else {
  48                         $this->current = User::newFromRow( $row );
  49                 }
  50         }
  51
  52         /**
  53          * @return int
  54          */
  55         public function count() {
  56                 return $this->res->numRows();
  57         }
  58
  59         /**
  60          * @return User
  61          */
  62         function current() {
  63                 return $this->current;
  64         }
  65
  66         function key() {
  67                 return $this->key;
  68         }
  69
  70         function next() {
  71                 $row = $this->res->next();
  72                 $this->setCurrent( $row );
  73                 $this->key++;
  74         }
  75
  76         function rewind() {
  77                 $this->res->rewind();
  78                 $this->key = 0;
  79                 $this->setCurrent( $this->res->current() );
  80         }
  81
  82         /**
  83          * @return bool
  84          */
  85         function valid() {
  86                 return $this->current !== false;
  87         }
  88 }