includes/UserArray.php

   1 <?php
   2 /**
   3  * Classes 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 abstract class UserArray implements Iterator {
  24         /**
  25          * @param $res ResultWrapper
  26          * @return UserArrayFromResult
  27          */
  28         static function newFromResult( $res ) {
  29                 $userArray = null;
  30                 if ( !wfRunHooks( 'UserArrayFromResult', array( &$userArray, $res ) ) ) {
  31                         return null;
  32                 }
  33                 if ( $userArray === null ) {
  34                         $userArray = self::newFromResult_internal( $res );
  35                 }
  36                 return $userArray;
  37         }
  38
  39         /**
  40          * @param $ids array
  41          * @return UserArrayFromResult
  42          */
  43         static function newFromIDs( $ids ) {
  44                 $ids = array_map( 'intval', (array)$ids ); // paranoia
  45                 if ( !$ids ) {
  46                         // Database::select() doesn't like empty arrays
  47                         return new ArrayIterator( array() );
  48                 }
  49                 $dbr = wfGetDB( DB_SLAVE );
  50                 $res = $dbr->select( 'user', '*', array( 'user_id' => $ids ),
  51                         __METHOD__ );
  52                 return self::newFromResult( $res );
  53         }
  54
  55         /**
  56          * @param $res
  57          * @return UserArrayFromResult
  58          */
  59         protected static function newFromResult_internal( $res ) {
  60                 return new UserArrayFromResult( $res );
  61         }
  62 }
  63
  64 class UserArrayFromResult extends UserArray implements Countable {
  65
  66         /**
  67          * @var ResultWrapper
  68          */
  69         var $res;
  70         var $key, $current;
  71
  72         /**
  73          * @param $res ResultWrapper
  74          */
  75         function __construct( $res ) {
  76                 $this->res = $res;
  77                 $this->key = 0;
  78                 $this->setCurrent( $this->res->current() );
  79         }
  80
  81         /**
  82          * @param  $row
  83          * @return void
  84          */
  85         protected function setCurrent( $row ) {
  86                 if ( $row === false ) {
  87                         $this->current = false;
  88                 } else {
  89                         $this->current = User::newFromRow( $row );
  90                 }
  91         }
  92
  93         /**
  94          * @return int
  95          */
  96         public function count() {
  97                 return $this->res->numRows();
  98         }
  99
 100         /**
 101          * @return User
 102          */
 103         function current() {
 104                 return $this->current;
 105         }
 106
 107         function key() {
 108                 return $this->key;
 109         }
 110
 111         function next() {
 112                 $row = $this->res->next();
 113                 $this->setCurrent( $row );
 114                 $this->key++;
 115         }
 116
 117         function rewind() {
 118                 $this->res->rewind();
 119                 $this->key = 0;
 120                 $this->setCurrent( $this->res->current() );
 121         }
 122
 123         /**
 124          * @return bool
 125          */
 126         function valid() {
 127                 return $this->current !== false;
 128         }
 129 }