MediaWiki  master
MediaWiki\Auth\AbstractAuthenticationProvider Class Reference

A base class that implements some of the boilerplate for an AuthenticationProvider. 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)
 Set configuration. More...
 
 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 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.

Definition at line 56 of file AbstractAuthenticationProvider.php.

◆ setConfig()

MediaWiki\Auth\AbstractAuthenticationProvider::setConfig ( Config  $config)

Set configuration.

Parameters
Config$config

Implements MediaWiki\Auth\AuthenticationProvider.

Definition at line 48 of file AbstractAuthenticationProvider.php.

References MediaWiki\Auth\AbstractAuthenticationProvider\$config.

◆ setLogger()

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

◆ setManager()

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

Member Data Documentation

◆ $config

Config MediaWiki\Auth\AbstractAuthenticationProvider::$config
protected

◆ $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: