wiki.techinc.nl/includes/user/UserArray.php

88 lines
2.3 KiB
PHP
Raw Normal View History

<?php
/**
* Class 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 ResultWrapper $res
* @return UserArrayFromResult
*/
static function newFromResult( $res ) {
$userArray = null;
if ( !Hooks::run( 'UserArrayFromResult', [ &$userArray, $res ] ) ) {
return null;
}
if ( $userArray === null ) {
$userArray = self::newFromResult_internal( $res );
}
return $userArray;
}
/**
* @param array $ids
* @return UserArrayFromResult
*/
static function newFromIDs( $ids ) {
$ids = array_map( 'intval', (array)$ids ); // paranoia
if ( !$ids ) {
// Database::select() doesn't like empty arrays
return new ArrayIterator( [] );
}
$dbr = wfGetDB( DB_REPLICA );
$res = $dbr->select(
'user',
User::selectFields(),
[ 'user_id' => array_unique( $ids ) ],
__METHOD__
);
return self::newFromResult( $res );
}
/**
* @since 1.25
* @param array $names
* @return UserArrayFromResult
*/
static function newFromNames( $names ) {
$names = array_map( 'strval', (array)$names ); // paranoia
if ( !$names ) {
// Database::select() doesn't like empty arrays
return new ArrayIterator( [] );
}
$dbr = wfGetDB( DB_REPLICA );
$res = $dbr->select(
'user',
User::selectFields(),
[ 'user_name' => array_unique( $names ) ],
__METHOD__
);
return self::newFromResult( $res );
}
2011-05-28 15:59:57 +00:00
/**
* @param ResultWrapper $res
2011-05-28 15:59:57 +00:00
* @return UserArrayFromResult
*/
protected static function newFromResult_internal( $res ) {
2011-05-28 15:59:57 +00:00
return new UserArrayFromResult( $res );
}
}