UserArray.php

Go to the documentation of this file.

<?php
use Wikimedia\Rdbms\IResultWrapper;
 
abstract class UserArray implements Iterator {
    public static function newFromResult( $res ) {
        $userArray = null;
        if ( !Hooks::runner()->onUserArrayFromResult( $userArray, $res ) ) {
            return null;
        }
        return $userArray ?? new UserArrayFromResult( $res );
    }
 
    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 );
    }
 
    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 );
    }
 
    abstract public function current(): User;
 
    abstract public function key(): int;
}