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

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.

References class.

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.

MediaWiki\Auth\AbstractAuthenticationProvider::setLogger

(

LoggerInterface

$logger

)

Definition at line 40 of file AbstractAuthenticationProvider.php.

References MediaWiki\Auth\AbstractAuthenticationProvider\$logger.

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 MediaWiki\Auth\AbstractAuthenticationProvider::$config

protected

Definition at line 38 of file AbstractAuthenticationProvider.php.

Referenced by MediaWiki\Auth\AbstractAuthenticationProvider\setConfig().

LoggerInterface MediaWiki\Auth\AbstractAuthenticationProvider::$logger

protected

Definition at line 34 of file AbstractAuthenticationProvider.php.

Referenced by MediaWiki\Auth\AbstractAuthenticationProvider\setLogger().

AuthManager MediaWiki\Auth\AbstractAuthenticationProvider::$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