<?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 ResultWrapper
+ * @return UserArrayFromResult
+ */
static function newFromResult( $res ) {
$userArray = null;
if ( !wfRunHooks( 'UserArrayFromResult', array( &$userArray, $res ) ) ) {
return $userArray;
}
+ /**
+ * @param $ids array
+ * @return UserArrayFromResult
+ */
static function newFromIDs( $ids ) {
$ids = array_map( 'intval', (array)$ids ); // paranoia
- if ( !$ids )
+ if ( !$ids ) {
// Database::select() doesn't like empty arrays
return new ArrayIterator(array());
+ }
$dbr = wfGetDB( DB_SLAVE );
$res = $dbr->select( 'user', '*', array( 'user_id' => $ids ),
__METHOD__ );
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;
}
}
+ /**
+ * @return int
+ */
public function count() {
return $this->res->numRows();
}
+ /**
+ * @return User
+ */
function current() {
return $this->current;
}
$this->setCurrent( $this->res->current() );
}
+ /**
+ * @return bool
+ */
function valid() {
return $this->current !== false;
}