MediaWiki  master
MediaWiki\Auth\AbstractAuthenticationProvider Class Reference

A base class that implements some of the boilerplate for an AuthenticationProvider Stable to extend. More...

Inheritance diagram for MediaWiki\Auth\AbstractAuthenticationProvider:
Collaboration diagram for MediaWiki\Auth\AbstractAuthenticationProvider:

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.
Returns
string
More...
 
 setConfig (Config $config)
 Stable to override. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLogger (LoggerInterface $logger)
 
 setManager (AuthManager $manager)
 Set AuthManager. More...
 
- Public Member Functions inherited from MediaWiki\Auth\AuthenticationProvider
 getAuthenticationRequests ( $action, array $options)
 Return the applicable list of AuthenticationRequests. More...
 

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()

MediaWiki\Auth\AbstractAuthenticationProvider::getHookContainer ( )
protected

◆ getHookRunner()

◆ 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()

◆ setHookContainer()

MediaWiki\Auth\AbstractAuthenticationProvider::setHookContainer ( HookContainer  $hookContainer)

◆ setLogger()

MediaWiki\Auth\AbstractAuthenticationProvider::setLogger ( LoggerInterface  $logger)

◆ setManager()

MediaWiki\Auth\AbstractAuthenticationProvider::setManager ( AuthManager  $manager)

Member Data Documentation

◆ $config

◆ $hookContainer

HookContainer MediaWiki\Auth\AbstractAuthenticationProvider::$hookContainer
private

◆ $hookRunner

HookRunner MediaWiki\Auth\AbstractAuthenticationProvider::$hookRunner
private

◆ $logger

LoggerInterface MediaWiki\Auth\AbstractAuthenticationProvider::$logger
protected

◆ $manager

AuthManager MediaWiki\Auth\AbstractAuthenticationProvider::$manager
protected

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