UserArray.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User;
 
use Countable;
use Iterator;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\FakeResultWrapper;
use Wikimedia\Rdbms\IResultWrapper;
 
abstract class UserArray implements Iterator, Countable {
    public static function newFromResult( $res ): self {
        $userArray = null;
        $hookRunner = new HookRunner( MediaWikiServices::getInstance()->getHookContainer() );
        if ( !$hookRunner->onUserArrayFromResult( $userArray, $res ) ) {
            return new UserArrayFromResult( new FakeResultWrapper( [] ) );
        }
        return $userArray ?? new UserArrayFromResult( $res );
    }
 
    public static function newFromIDs( array $ids ): self {
        $ids = array_map( 'intval', $ids ); // paranoia
        if ( !$ids ) {
            // Database::select() doesn't like empty arrays
            return new UserArrayFromResult( new FakeResultWrapper( [] ) );
        }
        $dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
        $res = User::newQueryBuilder( $dbr )
            ->where( [ 'user_id' => array_unique( $ids ) ] )
            ->caller( __METHOD__ )
            ->fetchResultSet();
        return self::newFromResult( $res );
    }
 
    public static function newFromNames( array $names ): self {
        $names = array_map( 'strval', $names ); // paranoia
        if ( !$names ) {
            // Database::select() doesn't like empty arrays
            return new UserArrayFromResult( new FakeResultWrapper( [] ) );
        }
        $dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
        $res = User::newQueryBuilder( $dbr )
            ->where( [ 'user_name' => array_unique( $names ) ] )
            ->caller( __METHOD__ )
            ->fetchResultSet();
        return self::newFromResult( $res );
    }
 
    abstract public function count(): int;
 
    abstract public function current(): User;
 
    abstract public function key(): int;
}
 
class_alias( UserArray::class, 'UserArray' );