wikimedia/mediawiki-core

<?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
 */

namespace MediaWiki\User;

use ArrayIterator;
use Iterator;
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 = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
        $res = User::newQueryBuilder( $dbr )
            ->where( [ 'user_id' => array_unique( $ids ) ] )
            ->caller( __METHOD__ )
            ->fetchResultSet();
        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 = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
        $res = User::newQueryBuilder( $dbr )
            ->where( [ 'user_name' => array_unique( $names ) ] )
            ->caller( __METHOD__ )
            ->fetchResultSet();
        return self::newFromResult( $res );
    }

    /**
     * @return User
     */
    abstract public function current(): User;

    /**
     * @return int
     */
    abstract public function key(): int;
}

/** @deprecated class alias since 1.41 */
class_alias( UserArray::class, 'UserArray' );