MediaWiki
master
|
An AuthenticationProvider is used by AuthManager when authenticating users. More...
Public Member Functions | |
getAuthenticationRequests ( $action, array $options) | |
Return the applicable list of AuthenticationRequests. More... | |
getUniqueId () | |
Return a unique identifier for this instance. More... | |
setConfig (Config $config) | |
Set configuration. More... | |
setHookContainer (HookContainer $hookContainer) | |
setManager (AuthManager $manager) | |
Set AuthManager. More... | |
An AuthenticationProvider is used by AuthManager when authenticating users.
This interface should not be implemented directly; use one of its children.
Authentication providers can be registered via $wgAuthManagerAutoConfig.
Definition at line 39 of file AuthenticationProvider.php.
MediaWiki\Auth\AuthenticationProvider::getAuthenticationRequests | ( | $action, | |
array | $options | ||
) |
Return the applicable list of AuthenticationRequests.
Possible values for $action depend on whether the implementing class is also a PreAuthenticationProvider, PrimaryAuthenticationProvider, or SecondaryAuthenticationProvider.
string | $action | |
array | $options | Options are:
|
Implemented in MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider, MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider, MediaWiki\Auth\PrimaryAuthenticationProvider, MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider, MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider, MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider, MediaWiki\Auth\AbstractPreAuthenticationProvider, and MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider.
Referenced by MediaWiki\Auth\AbstractSecondaryAuthenticationProvider\providerRevokeAccessForUser().
MediaWiki\Auth\AuthenticationProvider::getUniqueId | ( | ) |
Return a unique identifier for this instance.
This must be the same across requests. If multiple instances return the same ID, exceptions will be thrown from AuthManager.
Implemented in MediaWiki\Auth\AbstractAuthenticationProvider.
Referenced by MediaWiki\Auth\AuthManager\getAuthenticationRequestsInternal().
MediaWiki\Auth\AuthenticationProvider::setConfig | ( | Config | $config | ) |
Set configuration.
For extension-defined authentication providers that were using this method to trigger other work, please override AbstractAuthenticationProvider::postInitSetup instead. If your extension was using this to explicitly change the AuthManager (or Config, or HookContainer) of an existing AuthenticationProvider object, please file a report on phabricator - there is no non-deprecated way to do this anymore.
Config | $config |
Implemented in MediaWiki\Auth\AbstractAuthenticationProvider.
MediaWiki\Auth\AuthenticationProvider::setHookContainer | ( | HookContainer | $hookContainer | ) |
For extension-defined authentication providers that were using this method to trigger other work, please override AbstractAuthenticationProvider::postInitSetup instead. If your extension was using this to explicitly change the AuthManager (or Config, or HookContainer) of an existing AuthenticationProvider object, please file a report on phabricator - there is no non-deprecated way to do this anymore.
HookContainer | $hookContainer |
Implemented in MediaWiki\Auth\AbstractAuthenticationProvider.
MediaWiki\Auth\AuthenticationProvider::setManager | ( | AuthManager | $manager | ) |
Set AuthManager.
For extension-defined authentication providers that were using this method to trigger other work, please override AbstractAuthenticationProvider::postInitSetup instead. If your extension was using this to explicitly change the AuthManager (or Config, or HookContainer) of an existing AuthenticationProvider object, please file a report on phabricator - there is no non-deprecated way to do this anymore.
AuthManager | $manager |
Implemented in MediaWiki\Auth\AbstractAuthenticationProvider.