MediaWiki master
|
Find central user IDs associated with local user IDs, e.g. More...
Inherited by MediaWiki\User\CentralId\LocalIdLookup.
Public Member Functions | |
centralIdFromLocalUser (UserIdentity $user, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL) | |
Given a local UserIdentity object, return the central ID. | |
centralIdFromName ( $name, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL) | |
Given a (local) user name, return the central ID. | |
centralIdsFromNames (array $names, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL) | |
Given an array of (local) user names, return the central IDs. | |
getProviderId () | |
init (string $providerId, UserIdentityLookup $userIdentityLookup, UserFactory $userFactory) | |
Initialize the provider. | |
isAttached (UserIdentity $user, $wikiId=UserIdentity::LOCAL) | |
Check that a user is attached on the specified wiki. | |
isOwned (UserIdentity $user, $wikiId=UserIdentity::LOCAL) | |
Check that a username is owned by the central user on the specified wiki. | |
localUserFromCentralId ( $id, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL) | |
Given a central user ID, return a local user object. | |
lookupAttachedUserNames (array $nameToId, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL, $wikiId=UserIdentity::LOCAL) | |
Given user names on the wiki specified by $wikiId, return the central IDs, but only include IDs for local users attached to the central user, i.e. | |
lookupCentralIds (array $idToName, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL) | |
Given central user IDs, return the (local) user names. | |
lookupOwnedUserNames (array $nameToId, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL, $wikiId=UserIdentity::LOCAL) | |
Given user names on the wiki specified by $wikiId, return the central IDs, but only include IDs for local users owned by the central user, i.e. | |
lookupUserNames (array $nameToId, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL) | |
Given (local) user names, return the central IDs. | |
nameFromCentralId ( $id, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL) | |
Given a central user ID, return the (local) user name. | |
namesFromCentralIds (array $ids, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::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. | |
Public Attributes | |
const | AUDIENCE_PUBLIC = 1 |
const | AUDIENCE_RAW = 2 |
const | FILTER_ATTACHED = 'attached' |
const | FILTER_NONE = 'none' |
const | FILTER_OWNED = 'owned' |
Protected Member Functions | |
checkAudience ( $audience) | |
Check that the "audience" parameter is valid. | |
lookupUserNamesWithFilter (array $nameToId, $filter, $audience=self::AUDIENCE_PUBLIC, $flags=IDBAccessObject::READ_NORMAL, $wikiId=UserIdentity::LOCAL) | |
Given user names on the wiki specified by $wikiId, return the central IDs. | |
Find central user IDs associated with local user IDs, e.g.
across a wiki farm.
Default implementation is MediaWiki\User\CentralId\LocalIdLookup.
Definition at line 42 of file CentralIdLookup.php.
MediaWiki\User\CentralId\CentralIdLookup::centralIdFromLocalUser | ( | UserIdentity | $user, |
$audience = self::AUDIENCE_PUBLIC, | |||
$flags = IDBAccessObject::READ_NORMAL ) |
Given a local UserIdentity object, return the central ID.
UserIdentity | $user | Local user |
int | Authority | $audience | One of the audience constants, or a specific authority |
int | $flags | IDBAccessObject read flags |
Definition at line 371 of file CentralIdLookup.php.
MediaWiki\User\CentralId\CentralIdLookup::centralIdFromName | ( | $name, | |
$audience = self::AUDIENCE_PUBLIC, | |||
$flags = IDBAccessObject::READ_NORMAL ) |
Given a (local) user name, return the central ID.
string | $name | Canonicalized user name |
int | Authority | $audience | One of the audience constants, or a specific authority |
int | $flags | IDBAccessObject read flags |
Definition at line 305 of file CentralIdLookup.php.
MediaWiki\User\CentralId\CentralIdLookup::centralIdsFromNames | ( | array | $names, |
$audience = self::AUDIENCE_PUBLIC, | |||
$flags = IDBAccessObject::READ_NORMAL ) |
Given an array of (local) user names, return the central IDs.
string[] | $names | Canonicalized user names |
int | Authority | $audience | One of the audience constants, or a specific authority |
int | $flags | IDBAccessObject read flags |
Definition at line 320 of file CentralIdLookup.php.
|
protected |
Check that the "audience" parameter is valid.
int | Authority | $audience | One of the audience constants, or a specific authority |
InvalidArgumentException |
Definition at line 102 of file CentralIdLookup.php.
|
static |
Fetch a CentralIdLookup.
string | null | $providerId | Provider ID from $wgCentralIdLookupProviders |
Definition at line 63 of file CentralIdLookup.php.
References MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().
MediaWiki\User\CentralId\CentralIdLookup::getProviderId | ( | ) |
Definition at line 92 of file CentralIdLookup.php.
MediaWiki\User\CentralId\CentralIdLookup::init | ( | string | $providerId, |
UserIdentityLookup | $userIdentityLookup, | ||
UserFactory | $userFactory ) |
|
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.
UserIdentity | $user | |
string | false | $wikiId | Wiki to check attachment status. If false, check the current wiki. |
Reimplemented in MediaWiki\User\CentralId\LocalIdLookup.
MediaWiki\User\CentralId\CentralIdLookup::isOwned | ( | UserIdentity | $user, |
$wikiId = UserIdentity::LOCAL ) |
Check that a username is owned by the central user on the specified wiki.
This should return true if the local account exists and is attached (see isAttached()), or if it does not exist but is reserved for the central user (it's guaranteed that if it's ever created, then it will be attached to the central user).
UserIdentity | $user | |
string | false | $wikiId | Wiki to check attachment status. If false, check the current wiki. |
Definition at line 143 of file CentralIdLookup.php.
MediaWiki\User\CentralId\CentralIdLookup::localUserFromCentralId | ( | $id, | |
$audience = self::AUDIENCE_PUBLIC, | |||
$flags = IDBAccessObject::READ_NORMAL ) |
Given a central user ID, return a local user object.
int | $id | Central user ID |
int | Authority | $audience | One of the audience constants, or a specific authority |
int | $flags | IDBAccessObject read flags |
Definition at line 345 of file CentralIdLookup.php.
MediaWiki\User\CentralId\CentralIdLookup::lookupAttachedUserNames | ( | array | $nameToId, |
$audience = self::AUDIENCE_PUBLIC, | |||
$flags = IDBAccessObject::READ_NORMAL, | |||
$wikiId = UserIdentity::LOCAL ) |
Given user names on the wiki specified by $wikiId, return the central IDs, but only include IDs for local users attached to the central user, i.e.
isAttached() would be true.
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 |
string | false | $wikiId | Wiki to check attachment status. If false, check the current wiki. |
Definition at line 220 of file CentralIdLookup.php.
|
abstract |
Given central user IDs, return the (local) user names.
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 |
Reimplemented in MediaWiki\User\CentralId\LocalIdLookup.
MediaWiki\User\CentralId\CentralIdLookup::lookupOwnedUserNames | ( | array | $nameToId, |
$audience = self::AUDIENCE_PUBLIC, | |||
$flags = IDBAccessObject::READ_NORMAL, | |||
$wikiId = UserIdentity::LOCAL ) |
Given user names on the wiki specified by $wikiId, return the central IDs, but only include IDs for local users owned by the central user, i.e.
isOwned() would be true.
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 |
string | false | $wikiId | Wiki to check attachment status. If false, check the current wiki. |
Definition at line 195 of file CentralIdLookup.php.
MediaWiki\User\CentralId\CentralIdLookup::lookupUserNames | ( | array | $nameToId, |
$audience = self::AUDIENCE_PUBLIC, | |||
$flags = IDBAccessObject::READ_NORMAL ) |
Given (local) user names, return the central IDs.
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 |
Definition at line 173 of file CentralIdLookup.php.
|
abstractprotected |
Given user names on the wiki specified by $wikiId, return the central IDs.
If $filter is not FILTER_NONE, filter the users by owned or attached status.
array | $nameToId | Array with keys being canonicalized user names |
string | $filter | One of:
|
int | Authority | $audience | One of the audience constants, or a specific authority |
int | $flags | IDBAccessObject read flags |
string | false | $wikiId | Wiki to check attachment status. If false, check the current wiki. |
Reimplemented in MediaWiki\User\CentralId\LocalIdLookup.
MediaWiki\User\CentralId\CentralIdLookup::nameFromCentralId | ( | $id, | |
$audience = self::AUDIENCE_PUBLIC, | |||
$flags = IDBAccessObject::READ_NORMAL ) |
Given a central user ID, return the (local) user name.
int | $id | Central user ID |
int | Authority | $audience | One of the audience constants, or a specific authority |
int | $flags | IDBAccessObject read flags |
Definition at line 267 of file CentralIdLookup.php.
MediaWiki\User\CentralId\CentralIdLookup::namesFromCentralIds | ( | array | $ids, |
$audience = self::AUDIENCE_PUBLIC, | |||
$flags = IDBAccessObject::READ_NORMAL ) |
Given a an array of central user IDs, return the (local) user names.
int[] | $ids | Central user IDs |
int | Authority | $audience | One of the audience constants, or a specific authority |
int | $flags | IDBAccessObject read flags |
Definition at line 282 of file CentralIdLookup.php.
const MediaWiki\User\CentralId\CentralIdLookup::AUDIENCE_PUBLIC = 1 |
Definition at line 44 of file CentralIdLookup.php.
const MediaWiki\User\CentralId\CentralIdLookup::AUDIENCE_RAW = 2 |
Definition at line 45 of file CentralIdLookup.php.
const MediaWiki\User\CentralId\CentralIdLookup::FILTER_ATTACHED = 'attached' |
Definition at line 48 of file CentralIdLookup.php.
const MediaWiki\User\CentralId\CentralIdLookup::FILTER_NONE = 'none' |
Definition at line 47 of file CentralIdLookup.php.
const MediaWiki\User\CentralId\CentralIdLookup::FILTER_OWNED = 'owned' |
Definition at line 49 of file CentralIdLookup.php.