MediaWiki\User\UserIdentityLookup Interface Reference

Service for looking up UserIdentity. More...

Inherited by MediaWiki\User\ActorStore.

Public Member Functions
	getUserIdentityByName (string $name, int $queryFlags=IDBAccessObject::READ_NORMAL)
	Find an identity of a user by $name.
	getUserIdentityByUserId (int $userId, int $queryFlags=IDBAccessObject::READ_NORMAL)
	Find an identity of a user by $userId.
	newSelectQueryBuilder ( $dbOrQueryFlags=IDBAccessObject::READ_NORMAL)
	Returns a specialized SelectQueryBuilder for querying the UserIdentity objects.

Detailed Description

Service for looking up UserIdentity.

Default implementation is MediaWiki\User\ActorStore.

Since

1.36

Definition at line 34 of file UserIdentityLookup.php.

Member Function Documentation

getUserIdentityByName()

MediaWiki\User\UserIdentityLookup::getUserIdentityByName	(	string	$name,
		int	$queryFlags = IDBAccessObject::READ_NORMAL )

Find an identity of a user by $name.

This method can't be used to check whether a name is valid, as it returns null both for invalid user names, and for valid user names (or IP addresses) that haven't been used on this wiki yet. Use UserNameUtils for that purpose.

Parameters

string	$name
int	$queryFlags	one of IDBAccessObject constants

Returns

UserIdentity|null

Implemented in MediaWiki\User\ActorStore.

getUserIdentityByUserId()

MediaWiki\User\UserIdentityLookup::getUserIdentityByUserId	(	int	$userId,
		int	$queryFlags = IDBAccessObject::READ_NORMAL )

Find an identity of a user by $userId.

Parameters

int	$userId
int	$queryFlags	one of IDBAccessObject constants

Returns

UserIdentity|null

Implemented in MediaWiki\User\ActorStore.

newSelectQueryBuilder()

MediaWiki\User\UserIdentityLookup::newSelectQueryBuilder

(

$dbOrQueryFlags = IDBAccessObject::READ_NORMAL

)

Returns a specialized SelectQueryBuilder for querying the UserIdentity objects.

Parameters

IReadableDatabase | int

$dbOrQueryFlags

The database connection to perform the query on, or one of the IDBAccessObject::READ_* constants.

Returns

UserSelectQueryBuilder

Implemented in MediaWiki\User\ActorStore.

---

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

• includes/user/UserIdentityLookup.php