MediaWiki\User\UserNamePrefixSearch Class Reference

Handles searching prefixes of user names. More...

Public Member Functions
	__construct (IConnectionProvider $dbProvider, UserNameUtils $userNameUtils, HideUserUtils $hideUserUtils)
	search ( $audience, string $search, int $limit, int $offset=0)
	Do a prefix search of user names and return a list of matching user names.

Public Attributes
const	AUDIENCE_PUBLIC = 'public'

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 42 of file UserNamePrefixSearch.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\User\UserNamePrefixSearch::__construct	(	IConnectionProvider	$dbProvider,
		UserNameUtils	$userNameUtils,
		HideUserUtils	$hideUserUtils )

Parameters

IConnectionProvider	$dbProvider
UserNameUtils	$userNameUtils
HideUserUtils	$hideUserUtils

Definition at line 55 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	$audience	Either AUDIENCE_PUBLIC or a user to show the search for
string	$search
int	$limit
int	$offset	How many results to offset from the beginning

Returns

string[]

Exceptions

InvalidArgumentException

if $audience is invalid

Definition at line 76 of file UserNamePrefixSearch.php.

Member Data Documentation

AUDIENCE_PUBLIC

const MediaWiki\User\UserNamePrefixSearch::AUDIENCE_PUBLIC = 'public'

Definition at line 44 of file UserNamePrefixSearch.php.

Referenced by MediaWiki\SpecialPage\ContributionsSpecialPage\prefixSearchSubpages(), MediaWiki\Specials\SpecialEmailUser\prefixSearchSubpages(), MediaWiki\Specials\SpecialListFiles\prefixSearchSubpages(), MediaWiki\Specials\SpecialUnblock\prefixSearchSubpages(), and MediaWiki\Specials\SpecialUserRights\prefixSearchSubpages().

---

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

• includes/user/UserNamePrefixSearch.php