A base class that implements some of the boilerplate for an AuthenticationProvider Stable to extend. 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) | |
| Stable to override. | |
| setHookContainer (HookContainer $hookContainer) | |
| Set the HookContainer. | |
| 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 Member Functions | |
| getHookContainer () | |
| getHookRunner () | |
Protected Attributes | |
| Config | $config |
| LoggerInterface | $logger |
| AuthManager | $manager |
Private Attributes | |
| HookContainer | $hookContainer |
| HookRunner | $hookRunner |
Detailed Description
A base class that implements some of the boilerplate for an AuthenticationProvider Stable to extend.
- Since
- 1.27
Definition at line 35 of file AbstractAuthenticationProvider.php.
Member Function Documentation
◆ getHookContainer()
|
protected |
◆ getHookRunner()
|
protected |
Definition at line 90 of file AbstractAuthenticationProvider.php.
Referenced by MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getNewPasswordExpiry(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendNewAccountEmail(), and MediaWiki\Auth\ThrottlePreAuthenticationProvider\testForAccountCreation().
◆ 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.
Definition at line 72 of file AbstractAuthenticationProvider.php.
◆ setConfig()
| MediaWiki\Auth\AbstractAuthenticationProvider::setConfig | ( | Config | $config | ) |
Stable to override.
- Parameters
-
Config $config
Implements MediaWiki\Auth\AuthenticationProvider.
Reimplemented in MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider, MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider, and MediaWiki\Auth\ThrottlePreAuthenticationProvider.
Definition at line 59 of file AbstractAuthenticationProvider.php.
References MediaWiki\Auth\AbstractAuthenticationProvider\$config.
◆ setHookContainer()
| MediaWiki\Auth\AbstractAuthenticationProvider::setHookContainer | ( | HookContainer | $hookContainer | ) |
Set the HookContainer.
- Parameters
-
HookContainer $hookContainer
Implements MediaWiki\Auth\AuthenticationProvider.
Definition at line 63 of file AbstractAuthenticationProvider.php.
References MediaWiki\Auth\AbstractAuthenticationProvider\$hookContainer.
◆ setLogger()
| MediaWiki\Auth\AbstractAuthenticationProvider::setLogger | ( | LoggerInterface | $logger | ) |
Definition at line 47 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 51 of file AbstractAuthenticationProvider.php.
References MediaWiki\Auth\AbstractAuthenticationProvider\$manager.
Member Data Documentation
◆ $config
|
protected |
Definition at line 41 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().
◆ $hookContainer
|
private |
Definition at line 43 of file AbstractAuthenticationProvider.php.
Referenced by MediaWiki\Auth\AbstractAuthenticationProvider\setHookContainer().
◆ $hookRunner
|
private |
Definition at line 45 of file AbstractAuthenticationProvider.php.
◆ $logger
|
protected |
Definition at line 37 of file AbstractAuthenticationProvider.php.
Referenced by MediaWiki\Auth\AbstractAuthenticationProvider\setLogger().
◆ $manager
|
protected |
Definition at line 39 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
