UserNamePrefixSearch.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User;
 
use InvalidArgumentException;
use MediaWiki\Block\HideUserUtils;
use MediaWiki\Permissions\Authority;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\LikeValue;
 
class UserNamePrefixSearch {
 
    public const AUDIENCE_PUBLIC = 'public';
 
    private IConnectionProvider $dbProvider;
    private UserNameUtils $userNameUtils;
    private HideUserUtils $hideUserUtils;
 
    public function __construct(
        IConnectionProvider $dbProvider,
        UserNameUtils $userNameUtils,
        HideUserUtils $hideUserUtils
    ) {
        $this->dbProvider = $dbProvider;
        $this->userNameUtils = $userNameUtils;
        $this->hideUserUtils = $hideUserUtils;
    }
 
    public function search( $audience, string $search, int $limit, int $offset = 0 ): array {
        if ( $audience !== self::AUDIENCE_PUBLIC &&
            !( $audience instanceof Authority )
        ) {
            throw new InvalidArgumentException(
                '$audience must be AUDIENCE_PUBLIC or an Authority object'
            );
        }
 
        // Invalid user names are treated as empty strings
        $prefix = $this->userNameUtils->getCanonical( $search ) ?: '';
 
        $dbr = $this->dbProvider->getReplicaDatabase();
        $queryBuilder = $dbr->newSelectQueryBuilder()
            ->select( 'user_name' )
            ->from( 'user' )
            ->where( $dbr->expr( 'user_name', IExpression::LIKE, new LikeValue( $prefix, $dbr->anyString() ) ) )
            ->orderBy( 'user_name' )
            ->limit( $limit )
            ->offset( $offset );
 
        // Filter out hidden user names
        if ( $audience === self::AUDIENCE_PUBLIC || !$audience->isAllowed( 'hideuser' ) ) {
            $queryBuilder->andWhere( $this->hideUserUtils->getExpression( $dbr ) );
        }
 
        return $queryBuilder->caller( __METHOD__ )->fetchFieldValues();
    }
}