A base class that implements some of the boilerplate for an AuthenticationProvider. More...
Public Member Functions | |
| 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.
| |
| setConfig (Config $config) | |
| Set configuration. | |
| setLogger (LoggerInterface $logger) | |
| setManager (AuthManager $manager) | |
| Set AuthManager. | |
 Public Member Functions inherited from MediaWiki\Auth\AuthenticationProvider | |
| getAuthenticationRequests ( $action, array $options) | |
| Return the applicable list of AuthenticationRequests. | |
Protected Attributes | |
| Config | $config |
| LoggerInterface | $logger |
| AuthManager | $manager |
Detailed Description
A base class that implements some of the boilerplate for an AuthenticationProvider.
- Since
- 1.27
Definition at line 32 of file AbstractAuthenticationProvider.php.
Member Function Documentation
◆ getUniqueId()
| MediaWiki\Auth\AbstractAuthenticationProvider::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.
- Returns
- string
- Note
- Override this if it makes sense to support more than one instance
Implements MediaWiki\Auth\AuthenticationProvider.
Reimplemented in MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider.
Definition at line 56 of file AbstractAuthenticationProvider.php.
◆ setConfig()
| MediaWiki\Auth\AbstractAuthenticationProvider::setConfig | ( | Config | $config | ) |
Set configuration.
- Parameters
-
Config $config
Implements MediaWiki\Auth\AuthenticationProvider.
Reimplemented in MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider, MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider, and MediaWiki\Auth\ThrottlePreAuthenticationProvider.
Definition at line 48 of file AbstractAuthenticationProvider.php.
References MediaWiki\Auth\AbstractAuthenticationProvider\$config.
◆ setLogger()
| MediaWiki\Auth\AbstractAuthenticationProvider::setLogger | ( | LoggerInterface | $logger | ) |
Definition at line 40 of file AbstractAuthenticationProvider.php.
References MediaWiki\Auth\AbstractAuthenticationProvider\$logger.
◆ setManager()
| MediaWiki\Auth\AbstractAuthenticationProvider::setManager | ( | AuthManager | $manager | ) |
Set AuthManager.
- Parameters
-
AuthManager $manager
Implements MediaWiki\Auth\AuthenticationProvider.
Definition at line 44 of file AbstractAuthenticationProvider.php.
References MediaWiki\Auth\AbstractAuthenticationProvider\$manager.
Member Data Documentation
◆ $config
|
protected |
Definition at line 38 of file AbstractAuthenticationProvider.php.
Referenced by MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\setConfig(), MediaWiki\Auth\AbstractAuthenticationProvider\setConfig(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\setConfig(), MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider\setConfig(), and MediaWiki\Auth\ThrottlePreAuthenticationProvider\setConfig().
◆ $logger
|
protected |
Definition at line 34 of file AbstractAuthenticationProvider.php.
Referenced by MediaWiki\Auth\AbstractAuthenticationProvider\setLogger().
◆ $manager
|
protected |
Definition at line 36 of file AbstractAuthenticationProvider.php.
Referenced by MediaWiki\Auth\AbstractAuthenticationProvider\setManager().
The documentation for this class was generated from the following file:
- includes/auth/AbstractAuthenticationProvider.php
