e04d3a28f6
The Hooks class contains deprecated functions and the whole class is going to get removed, so remove the convenience function and inline the code. Bug: T335536 Change-Id: I8ef3468a64a0199996f26ef293543fcacdf2797f
112 lines
3.4 KiB
PHP
112 lines
3.4 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 MediaWiki\HookContainer\HookRunner;
|
|
use MediaWiki\MediaWikiServices;
|
|
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|ArrayIterator
|
|
*/
|
|
public static function newFromResult( $res ) {
|
|
$userArray = null;
|
|
$hookRunner = new HookRunner( MediaWikiServices::getInstance()->getHookContainer() );
|
|
if ( !$hookRunner->onUserArrayFromResult( $userArray, $res ) ) {
|
|
return new ArrayIterator( [] );
|
|
}
|
|
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 );
|
|
}
|
|
|
|
/**
|
|
* @return User
|
|
*/
|
|
abstract public function current(): User;
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
abstract public function key(): int;
|
|
}
|