87a5cb4673
This introduces a specialized SelectQueryBuilder for queries related to actor table. So far it's fairly basic, but in future it is intended to grow. This patch only introduces the new abstraction, using it will be separated into separate patches. Bug: T274223 Change-Id: Ibb1c58016e3956a46bfaf1a9f51f265114bb9ace
99 lines
3.1 KiB
PHP
99 lines
3.1 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\IResultWrapper;
|
|
|
|
abstract class UserArray implements Iterator {
|
|
/**
|
|
* @note Try to avoid in new code, in case getting UserIdentity batch is enough,
|
|
* use {@link \MediaWiki\User\UserIdentityLookup::newSelectQueryBuilder()}.
|
|
* In case you need full User objects, you can keep using this method, but it's
|
|
* moving towards deprecation.
|
|
*
|
|
* @param IResultWrapper $res
|
|
* @return UserArrayFromResult
|
|
*/
|
|
public static function newFromResult( $res ) {
|
|
$userArray = null;
|
|
if ( !Hooks::runner()->onUserArrayFromResult( $userArray, $res ) ) {
|
|
return null;
|
|
}
|
|
return $userArray ?? new UserArrayFromResult( $res );
|
|
}
|
|
|
|
/**
|
|
* @note Try to avoid in new code, in case getting UserIdentity batch is enough,
|
|
* use {@link \MediaWiki\User\UserIdentityLookup::newSelectQueryBuilder()}.
|
|
* In case you need full User objects, you can keep using this method, but it's
|
|
* moving towards deprecation.
|
|
*
|
|
* @param array $ids
|
|
* @return UserArrayFromResult|ArrayIterator
|
|
*/
|
|
public 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 );
|
|
}
|
|
|
|
/**
|
|
* @note Try to avoid in new code, in case getting UserIdentity batch is enough,
|
|
* use {@link \MediaWiki\User\UserIdentityLookup::newSelectQueryBuilder()}.
|
|
* In case you need full User objects, you can keep using this method, but it's
|
|
* moving towards deprecation.
|
|
*
|
|
* @since 1.25
|
|
* @param array $names
|
|
* @return UserArrayFromResult|ArrayIterator
|
|
*/
|
|
public 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 );
|
|
}
|
|
}
|