MediaWiki\User\CentralId\CentralIdLookupFactory Class Reference

Public Member Functions
	__construct (ServiceOptions $options, ObjectFactory $objectFactory, UserIdentityLookup $userIdentityLookup, UserFactory $userFactory)
	getDefaultProviderId ()
	Get the ID of the default central ID provider.
	getLookup (?string $providerId=null)
	Get an instance of a CentralIdLookup.
	getNonLocalLookup (?string $providerID=null)
	Returns a CentralIdLookup that is guaranteed to be non-local.
	getProviderIds ()
	Get the IDs of the registered central ID lookup providers.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Detailed Description

Definition at line 34 of file CentralIdLookupFactory.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\User\CentralId\CentralIdLookupFactory::__construct	(	ServiceOptions	$options,
		ObjectFactory	$objectFactory,
		UserIdentityLookup	$userIdentityLookup,
		UserFactory	$userFactory )

Parameters

ServiceOptions	$options
ObjectFactory	$objectFactory
UserIdentityLookup	$userIdentityLookup

Definition at line 65 of file CentralIdLookupFactory.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), MediaWiki\MainConfigNames\CentralIdLookupProvider, MediaWiki\MainConfigNames\CentralIdLookupProviders, and MediaWiki\Config\ServiceOptions\get().

Member Function Documentation

getDefaultProviderId()

MediaWiki\User\CentralId\CentralIdLookupFactory::getDefaultProviderId

(

)

Get the ID of the default central ID provider.

Returns

string

Definition at line 93 of file CentralIdLookupFactory.php.

getLookup()

MediaWiki\User\CentralId\CentralIdLookupFactory::getLookup

(

?string

$providerId = null

)

Get an instance of a CentralIdLookup.

Parameters

string | null

$providerId

Provider ID from $wgCentralIdLookupProviders or null to use the provider configured in $wgCentralIdLookupProvider

Returns

CentralIdLookup

Exceptions

InvalidArgumentException

if $providerId is not properly configured

Definition at line 105 of file CentralIdLookupFactory.php.

getNonLocalLookup()

MediaWiki\User\CentralId\CentralIdLookupFactory::getNonLocalLookup

(

?string

$providerID = null

)

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.

Parameters

string | null

$providerID

Provider ID from $wgCentralIdLookupProviders or null to use the provider configured in $wgCentralIdLookupProvider

Returns

?CentralIdLookup

Exceptions

InvalidArgumentException

if $providerId is not properly configured

Definition at line 137 of file CentralIdLookupFactory.php.

getProviderIds()

MediaWiki\User\CentralId\CentralIdLookupFactory::getProviderIds

(

)

Get the IDs of the registered central ID lookup providers.

Returns

string[]

Definition at line 84 of file CentralIdLookupFactory.php.

Member Data Documentation

CONSTRUCTOR_OPTIONS

const MediaWiki\User\CentralId\CentralIdLookupFactory::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::CentralIdLookupProviders,
        MainConfigNames::CentralIdLookupProvider,
    ]

Access: internal

Definition at line 39 of file CentralIdLookupFactory.php.

---

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

• includes/user/CentralId/CentralIdLookupFactory.php