MediaWiki  master
CentralIdLookup Class Reference

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

Inheritance diagram for CentralIdLookup:
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. More...
 
 centralIdFromName ( $name, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
 Given a (local) user name, return the central ID. More...
 
 centralIdsFromNames (array $names, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
 Given an array of (local) user names, return the central IDs. More...
 
 getProviderId ()
 Get the provider id. More...
 
 init (string $providerId, UserIdentityLookup $userIdentityLookup)
 Initialize the provider. More...
 
 isAttached (UserIdentity $user, $wikiId=UserIdentity::LOCAL)
 Check that a user is attached on the specified wiki. More...
 
 localUserFromCentralId ( $id, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
 Given a central user ID, return a local user object. More...
 
 lookupCentralIds (array $idToName, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
 Given central user IDs, return the (local) user names. More...
 
 lookupUserNames (array $nameToId, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
 Given (local) user names, return the central IDs. More...
 
 nameFromCentralId ( $id, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
 Given a central user ID, return the (local) user name. More...
 
 namesFromCentralIds (array $ids, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
 Given a an array of central user IDs, return the (local) user names. More...
 

Static Public Member Functions

static factory ( $providerId=null)
 Fetch a CentralIdLookup. More...
 
static factoryNonLocal ()
 Returns a CentralIdLookup that is guaranteed to be non-local. More...
 

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) More...
 

Protected Member Functions

 checkAudience ( $audience)
 Check that the "audience" parameter is valid. More...
 

Private Attributes

string $providerId
 
UserIdentityLookup $userIdentityLookup
 

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$userLocal user
int | Authority$audienceOne of the audience constants, or a specific authority
int$flagsIDBAccessObject 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.

References centralIdFromName(), MediaWiki\User\UserIdentity\getName(), and isAttached().

◆ 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$nameCanonicalized user name
int | Authority$audienceOne of the audience constants, or a specific authority
int$flagsIDBAccessObject 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.

References lookupUserNames().

Referenced by centralIdFromLocalUser().

◆ 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[]$namesCanonicalized user names
int | Authority$audienceOne of the audience constants, or a specific authority
int$flagsIDBAccessObject read flags
Returns
int[] user IDs
Since
1.30

Definition at line 238 of file CentralIdLookup.php.

References lookupUserNames().

◆ checkAudience()

CentralIdLookup::checkAudience (   $audience)
protected

Check that the "audience" parameter is valid.

Parameters
int | Authority$audienceOne 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.

Referenced by LocalIdLookup\lookupCentralIds(), and LocalIdLookup\lookupUserNames().

◆ factory()

static CentralIdLookup::factory (   $providerId = null)
static

Fetch a CentralIdLookup.

Deprecated:
since 1.37 Use MediaWikiServices to obtain an instance.
Parameters
string | null$providerIdProvider ID from $wgCentralIdLookupProviders
Returns
CentralIdLookup|null

Definition at line 52 of file CentralIdLookup.php.

References $providerId, and 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.

References wfDeprecated().

◆ getProviderId()

CentralIdLookup::getProviderId ( )

Get the provider id.

Returns
string

Definition at line 107 of file CentralIdLookup.php.

References $providerId.

◆ 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.

References $providerId, and $userIdentityLookup.

◆ 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$wikiIdWiki to check attachment status. If false, check the current wiki.
Returns
bool

Reimplemented in LocalIdLookup.

Referenced by centralIdFromLocalUser().

◆ 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$idCentral user ID
int | Authority$audienceOne of the audience constants, or a specific authority
int$flagsIDBAccessObject 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.

References MediaWiki\User\UserIdentity\isRegistered(), and nameFromCentralId().

◆ 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$idToNameArray with keys being central user IDs
int | Authority$audienceOne of the audience constants, or a specific authority
int$flagsIDBAccessObject 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.

Referenced by nameFromCentralId(), and namesFromCentralIds().

◆ 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$nameToIdArray with keys being canonicalized user names
int | Authority$audienceOne of the audience constants, or a specific authority
int$flagsIDBAccessObject 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.

Referenced by centralIdFromName(), and centralIdsFromNames().

◆ 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$idCentral user ID
int | Authority$audienceOne of the audience constants, or a specific authority
int$flagsIDBAccessObject 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.

References lookupCentralIds().

Referenced by localUserFromCentralId().

◆ 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[]$idsCentral user IDs
int | Authority$audienceOne of the audience constants, or a specific authority
int$flagsIDBAccessObject read flags
Returns
string[] user names
Since
1.30

Definition at line 200 of file CentralIdLookup.php.

References lookupCentralIds().

Member Data Documentation

◆ $providerId

string CentralIdLookup::$providerId
private

Definition at line 41 of file CentralIdLookup.php.

Referenced by factory(), getProviderId(), and init().

◆ $userIdentityLookup

UserIdentityLookup CentralIdLookup::$userIdentityLookup
private

Definition at line 44 of file CentralIdLookup.php.

Referenced by init().

◆ AUDIENCE_PUBLIC

const CentralIdLookup::AUDIENCE_PUBLIC = 1

Definition at line 37 of file CentralIdLookup.php.

◆ AUDIENCE_RAW


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