MediaWiki  master
MediaWiki\User\UserNamePrefixSearch Class Reference

Handles searching prefixes of user names. More...

Collaboration diagram for MediaWiki\User\UserNamePrefixSearch:

Public Member Functions

 __construct (ILoadBalancer $loadBalancer, PermissionManager $permissionManager, UserFactory $userFactory)
 
 search ( $audience, string $search, int $limit, int $offset=0)
 Do a prefix search of user names and return a list of matching user names. More...
 

Private Attributes

ILoadBalancer $loadBalancer
 
PermissionManager $permissionManager
 
UserFactory $userFactory
 

Detailed Description

Handles searching prefixes of user names.

Note
There are two classes called UserNamePrefixSearch. You should use this first one, in namespace MediaWiki\User, which is a service. \UserNamePrefixSearch is a deprecated static wrapper that forwards to the global service.
Since
1.36 as a service in the current namespace
Author
DannyS712

Definition at line 39 of file UserNamePrefixSearch.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\UserNamePrefixSearch::__construct ( ILoadBalancer  $loadBalancer,
PermissionManager  $permissionManager,
UserFactory  $userFactory 
)
Parameters
ILoadBalancer$loadBalancer
PermissionManager$permissionManager
UserFactory$userFactory

Definition at line 58 of file UserNamePrefixSearch.php.

References MediaWiki\User\UserNamePrefixSearch\$loadBalancer, MediaWiki\User\UserNamePrefixSearch\$permissionManager, and MediaWiki\User\UserNamePrefixSearch\$userFactory.

Member Function Documentation

◆ search()

MediaWiki\User\UserNamePrefixSearch::search (   $audience,
string  $search,
int  $limit,
int  $offset = 0 
)

Do a prefix search of user names and return a list of matching user names.

Parameters
string | UserIdentity$audienceEither AUDIENCE_PUBLIC or a user to show the search for
string$search
int$limit
int$offsetHow many results to offset from the beginning
Returns
string[]
Exceptions
InvalidArgumentExceptionif $audience is invalid

Definition at line 78 of file UserNamePrefixSearch.php.

References $dbr, $res, and DB_REPLICA.

Member Data Documentation

◆ $loadBalancer

ILoadBalancer MediaWiki\User\UserNamePrefixSearch::$loadBalancer
private
Initial value:
=
public const AUDIENCE_PUBLIC 'public'

Definition at line 45 of file UserNamePrefixSearch.php.

Referenced by MediaWiki\User\UserNamePrefixSearch\__construct().

◆ $permissionManager

PermissionManager MediaWiki\User\UserNamePrefixSearch::$permissionManager
private

◆ $userFactory

UserFactory MediaWiki\User\UserNamePrefixSearch::$userFactory
private

The documentation for this class was generated from the following file: