MediaWiki REL1_39
MediaWiki\User\UserNamePrefixSearch Class Reference

Handles searching prefixes of user names. More...

Public Member Functions

 __construct (ILoadBalancer $loadBalancer, UserNameUtils $userNameUtils)
 
 search ( $audience, string $search, int $limit, int $offset=0)
 Do a prefix search of user names and return a list of matching user names.
 

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,
UserNameUtils  $userNameUtils 
)
Parameters
ILoadBalancer$loadBalancer
UserNameUtils$userNameUtils

Definition at line 54 of file UserNamePrefixSearch.php.

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 | Authority$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 73 of file UserNamePrefixSearch.php.


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