LocalIdLookup Class Reference

A CentralIdLookup provider that just uses local IDs. More...

Inheritance diagram for LocalIdLookup:

Collaboration diagram for LocalIdLookup:

Public Member Functions
	isAttached (User $user, $wikiId=null)
	Check that a User is attached on the specified wiki.
	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.
Public Member Functions inherited from CentralIdLookup
	centralIdFromLocalUser (User $user, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given a local User object, return the central ID.
	centralIdFromName ( $name, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given a (local) user name, return the central ID.
	getProviderId ()
	localUserFromCentralId ( $id, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given a central user ID, return a local User object.
	nameFromCentralId ( $id, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
	Given a central user ID, return the (local) user name.

Additional Inherited Members
Static Public Member Functions inherited from CentralIdLookup
static	factory ( $providerId=null)
	Fetch a CentralIdLookup.
static	resetCache ()
	Reset internal cache for unit testing.
Public Attributes inherited from CentralIdLookup
const	AUDIENCE_PUBLIC = 1
const	AUDIENCE_RAW = 2
Public Attributes inherited from IDBAccessObject
const	READ_LOCKING = 3
	Constants for object loading bitfield flags (higher => higher QoS)
const	READ_NONE = -1
Protected Member Functions inherited from CentralIdLookup
	checkAudience ( $audience)
	Check that the "audience" parameter is valid.

Detailed Description

A CentralIdLookup provider that just uses local IDs.

Useful if the wiki isn't part of a cluster or you're using shared user tables.

Note

Shared user table support expects that all wikis involved have $wgSharedDB and $wgSharedTables set, and that all wikis involved in the sharing are listed in $wgLocalDatabases, and that no wikis not involved in the sharing are listed in $wgLocalDatabases.

Since

1.27

Definition at line 33 of file LocalIdLookup.php.

Member Function Documentation

isAttached()

LocalIdLookup::isAttached	(	User	$user,
			$wikiId = null
	)

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

User	$user
string | null	$wikiId	Wiki to check attachment status. If null, check the current wiki.

Returns

bool

Reimplemented from CentralIdLookup.

Definition at line 35 of file LocalIdLookup.php.

References $user, $wgLocalDatabases, $wgSharedDB, $wgSharedTables, global, and wfWikiID().

lookupCentralIds()

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

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 | User	$audience	One of the audience constants, or a specific user
int	$flags	IDBAccessObject read flags

Returns

array 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 from CentralIdLookup.

Definition at line 55 of file LocalIdLookup.php.

References $flags, $options, $res, $tables, as, CentralIdLookup\checkAudience(), DBAccessObjectUtils\getDBOptions(), list, and wfGetDB().

lookupUserNames()

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

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 | User	$audience	One of the audience constants, or a specific user
int	$flags	IDBAccessObject read flags

Returns

array 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 from CentralIdLookup.

Definition at line 86 of file LocalIdLookup.php.

References $flags, $options, $res, $tables, as, CentralIdLookup\checkAudience(), DBAccessObjectUtils\getDBOptions(), list, and wfGetDB().

---

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

• includes/user/LocalIdLookup.php