3488f49532
Several classes have a "selectFields()" static method to tell callers which fields to select from the database. With the recent comment table change and the upcoming actor table change, this pattern has become too simplistic as a SELECT will need to join several tables to be able to retrieve all the needed fields. Thus, we deprecate the selectFields() methods in favor of getQueryInfo() methods that return tables and join conditions in addition to the fields. Change-Id: Idcfd15568489d9f03a7ba4460e96610d33bc4089
95 lines
2.5 KiB
PHP
95 lines
2.5 KiB
PHP
<?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
|
|
*/
|
|
|
|
use Wikimedia\Rdbms\ResultWrapper;
|
|
|
|
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|ArrayIterator
|
|
*/
|
|
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 );
|
|
$userQuery = User::getQueryInfo();
|
|
$res = $dbr->select(
|
|
$userQuery['tables'],
|
|
$userQuery['fields'],
|
|
[ 'user_id' => array_unique( $ids ) ],
|
|
__METHOD__,
|
|
[],
|
|
$userQuery['joins']
|
|
);
|
|
return self::newFromResult( $res );
|
|
}
|
|
|
|
/**
|
|
* @since 1.25
|
|
* @param array $names
|
|
* @return UserArrayFromResult|ArrayIterator
|
|
*/
|
|
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 );
|
|
$userQuery = User::getQueryInfo();
|
|
$res = $dbr->select(
|
|
$userQuery['tables'],
|
|
$userQuery['fields'],
|
|
[ 'user_name' => array_unique( $names ) ],
|
|
__METHOD__,
|
|
[],
|
|
$userQuery['joins']
|
|
);
|
|
return self::newFromResult( $res );
|
|
}
|
|
|
|
/**
|
|
* @param ResultWrapper $res
|
|
* @return UserArrayFromResult
|
|
*/
|
|
protected static function newFromResult_internal( $res ) {
|
|
return new UserArrayFromResult( $res );
|
|
}
|
|
}
|