The CentralIdLookup service allows for connecting local users with cluster-wide IDs. More...

Collaboration diagram for CentralIdLookup:

Public Member Functions
	centralIdFromLocalUser (UserIdentity $user, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given a local UserIdentity object, return the central ID.

	centralIdFromName ( $name, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given a (local) user name, return the central ID.

	centralIdsFromNames (array $names, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given an array of (local) user names, return the central IDs.

	getProviderId ()
	Get the provider id.

	init (string $providerId, UserIdentityLookup $userIdentityLookup)
	Initialize the provider.

	isAttached (UserIdentity $user, $wikiId=UserIdentity::LOCAL)
	Check that a user is attached on the specified wiki.

	localUserFromCentralId ( $id, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given a central user ID, return a local user object.

	lookupCentralIds (array $idToName, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given central user IDs, return the (local) user names.

	lookupUserNames (array $nameToId, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given (local) user names, return the central IDs.

	nameFromCentralId ( $id, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given a central user ID, return the (local) user name.

	namesFromCentralIds (array $ids, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given a an array of central user IDs, return the (local) user names.

Static Public Member Functions
static	factory ( $providerId=null)
	Fetch a CentralIdLookup.

static	factoryNonLocal ()
	Returns a CentralIdLookup that is guaranteed to be non-local.

Public Attributes
const	AUDIENCE_PUBLIC = 1

const	AUDIENCE_RAW = 2

Public Attributes inherited from IDBAccessObject
const	READ_NONE = -1
	Constants for object loading bitfield flags (higher => higher QoS)

Protected Member Functions
	checkAudience ( $audience)
	Check that the "audience" parameter is valid.

Detailed Description

The CentralIdLookup service allows for connecting local users with cluster-wide IDs.

Since: 1.27

Stability: stable: to extend

Definition at line 35 of file CentralIdLookup.php.

Member Function Documentation

◆ centralIdFromLocalUser()

CentralIdLookup::centralIdFromLocalUser	(	UserIdentity	$user,
			$audience = self::AUDIENCE_PUBLIC,
			$flags = self::READ_NORMAL )

Given a local UserIdentity object, return the central ID.

Stability: stable: to override

Note: Unlike centralIdFromName(), this does guarantee that the local user is attached to the central account.

Parameters

UserIdentity	$user	Local user
int \| Authority	$audience	One of the audience constants, or a specific authority
int	$flags	IDBAccessObject read flags

Returns: int user ID; 0 if the local user does not correspond to a central user, $audience lacks the rights needed to see it, or the central user isn't locally attached.

Definition at line 289 of file CentralIdLookup.php.

◆ centralIdFromName()

CentralIdLookup::centralIdFromName	(	$name,
		$audience = self::AUDIENCE_PUBLIC,
		$flags = self::READ_NORMAL )

Given a (local) user name, return the central ID.

Note: There's no requirement that the user name actually exists locally, or if it does that it's actually attached to the central account.

Parameters

string	$name	Canonicalized user name
int \| Authority	$audience	One of the audience constants, or a specific authority
int	$flags	IDBAccessObject read flags

Returns: int user ID; 0 if the name does not correspond to a user or $audience lacks the rights needed to see it.

Definition at line 223 of file CentralIdLookup.php.

◆ centralIdsFromNames()

CentralIdLookup::centralIdsFromNames	(	array	$names,
			$audience = self::AUDIENCE_PUBLIC,
			$flags = self::READ_NORMAL )

Given an array of (local) user names, return the central IDs.

Parameters

string[]	$names	Canonicalized user names
int \| Authority	$audience	One of the audience constants, or a specific authority
int	$flags	IDBAccessObject read flags

Returns: int[] user IDs

Since: 1.30

Definition at line 238 of file CentralIdLookup.php.

◆ checkAudience()

CentralIdLookup::checkAudience ( $audience )

protected

Check that the "audience" parameter is valid.

Parameters

int | Authority $audience One of the audience constants, or a specific authority

Returns: Authority|null authority to check against, or null if no checks are needed

Exceptions

InvalidArgumentException

Definition at line 117 of file CentralIdLookup.php.

◆ factory()

static CentralIdLookup::factory ( $providerId = null )

static

Fetch a CentralIdLookup.

Deprecated: since 1.37 Use MediaWikiServices to obtain an instance.

Parameters

string | null $providerId Provider ID from $wgCentralIdLookupProviders

Returns: CentralIdLookup|null

Definition at line 52 of file CentralIdLookup.php.

References wfDeprecated().

◆ factoryNonLocal()

static CentralIdLookup::factoryNonLocal ( )

static

Returns a CentralIdLookup that is guaranteed to be non-local.

If no such guarantee can be made, returns null.

If this function returns a non-null CentralIdLookup, that lookup is expected to provide IDs that are shared with some set of other wikis. However, you should still be cautious when using those IDs, as they will not necessarily work with all other wikis, and it can be hard to tell if another wiki is in the same set as this one or not.

Since: 1.35

Deprecated: since 1.37. Use CentralIdLookupFactory::getNonLocalLookup instead.

Returns: CentralIdLookup|null

Definition at line 77 of file CentralIdLookup.php.

◆ getProviderId()

CentralIdLookup::getProviderId ( )

Get the provider id.

Returns: string

Definition at line 107 of file CentralIdLookup.php.

◆ init()

CentralIdLookup::init	(	string	$providerId,
		UserIdentityLookup	$userIdentityLookup )

Initialize the provider.

Parameters

string	$providerId
UserIdentityLookup	$userIdentityLookup

Access: internal

Definition at line 91 of file CentralIdLookup.php.

◆ isAttached()

CentralIdLookup::isAttached	(	UserIdentity	$user,
			$wikiId = UserIdentity::LOCAL )

abstract

Check that a user is attached on the specified wiki.

If unattached local accounts don't exist in your extension, this comes down to a check whether the central account exists at all and that $wikiId is using the same central database.

Parameters

UserIdentity	$user
string \| false	$wikiId	Wiki to check attachment status. If false, check the current wiki.

Returns: bool

Reimplemented in LocalIdLookup.

◆ localUserFromCentralId()

CentralIdLookup::localUserFromCentralId	(	$id,
		$audience = self::AUDIENCE_PUBLIC,
		$flags = self::READ_NORMAL )

Given a central user ID, return a local user object.

Note: Unlike nameFromCentralId(), this does guarantee that the local user exists and is attached to the central account.

Stability: stable: to override

Parameters

int	$id	Central user ID
int \| Authority	$audience	One of the audience constants, or a specific authority
int	$flags	IDBAccessObject read flags

Returns: UserIdentity|null Local user, or null if: $id doesn't correspond to a user, $audience lacks the rights needed to see the user, the user doesn't exist locally, or the user isn't locally attached.

Definition at line 263 of file CentralIdLookup.php.

◆ lookupCentralIds()

CentralIdLookup::lookupCentralIds	(	array	$idToName,
			$audience = self::AUDIENCE_PUBLIC,
			$flags = self::READ_NORMAL )

abstract

Given central user IDs, return the (local) user names.

Note: There's no requirement that the user names actually exist locally, or if they do that they're actually attached to the central account.

Parameters

array	$idToName	Array with keys being central user IDs
int \| Authority	$audience	One of the audience constants, or a specific authority
int	$flags	IDBAccessObject read flags

Returns: string[] Copy of $idToName with values set to user names (or empty-string if the user exists but $audience lacks the rights needed to see it). IDs not corresponding to a user are unchanged.

Reimplemented in LocalIdLookup.

◆ lookupUserNames()

CentralIdLookup::lookupUserNames	(	array	$nameToId,
			$audience = self::AUDIENCE_PUBLIC,
			$flags = self::READ_NORMAL )

abstract

Given (local) user names, return the central IDs.

Note: There's no requirement that the user names actually exist locally, or if they do that they're actually attached to the central account.

Parameters

array	$nameToId	Array with keys being canonicalized user names
int \| Authority	$audience	One of the audience constants, or a specific authority
int	$flags	IDBAccessObject read flags

Returns: int[] Copy of $nameToId with values set to central IDs. Names not corresponding to a user (or $audience lacks the rights needed to see it) are unchanged.

Reimplemented in LocalIdLookup.

◆ nameFromCentralId()

CentralIdLookup::nameFromCentralId	(	$id,
		$audience = self::AUDIENCE_PUBLIC,
		$flags = self::READ_NORMAL )

Given a central user ID, return the (local) user name.

Note: There's no requirement that the user name actually exists locally, or if it does that it's actually attached to the central account.

Parameters

int	$id	Central user ID
int \| Authority	$audience	One of the audience constants, or a specific authority
int	$flags	IDBAccessObject read flags

Returns: string|null user name, or empty string if $audience lacks the rights needed to see it, or null if $id doesn't correspond to a user

Definition at line 185 of file CentralIdLookup.php.

◆ namesFromCentralIds()

CentralIdLookup::namesFromCentralIds	(	array	$ids,
			$audience = self::AUDIENCE_PUBLIC,
			$flags = self::READ_NORMAL )

Given a an array of central user IDs, return the (local) user names.

Parameters

int[]	$ids	Central user IDs
int \| Authority	$audience	One of the audience constants, or a specific authority
int	$flags	IDBAccessObject read flags

Returns: string[] user names

Since: 1.30

Definition at line 200 of file CentralIdLookup.php.

Member Data Documentation

◆ AUDIENCE_PUBLIC

const CentralIdLookup::AUDIENCE_PUBLIC = 1

Definition at line 37 of file CentralIdLookup.php.

◆ AUDIENCE_RAW

const CentralIdLookup::AUDIENCE_RAW = 2

Definition at line 38 of file CentralIdLookup.php.

Referenced by MediaWiki\Permissions\RateLimiter\limit().

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

includes/user/CentralId/CentralIdLookup.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ centralIdFromLocalUser()

◆ centralIdFromName()

◆ centralIdsFromNames()

◆ checkAudience()

◆ factory()

◆ factoryNonLocal()

◆ getProviderId()

◆ init()

◆ isAttached()

◆ localUserFromCentralId()

◆ lookupCentralIds()

◆ lookupUserNames()

◆ nameFromCentralId()

◆ namesFromCentralIds()

Member Data Documentation

◆ AUDIENCE_PUBLIC

◆ AUDIENCE_RAW