Authentication service handles registration of PAM handlers and calling of those handlers. More...

Public Member Functions
	__construct (protected HandlersService $handlerService)
	Create new service. More...

	registerHandler ($handler, string $importance= 'sufficient', string $policy= 'user')
	Register an authentication handler. More...

	unregisterHandler ($handler, string $policy= 'user')
	Unregister an authentication handler. More...

	authenticate (string $policy, array $authentication_params=[])
	Authenticate. More...

Detailed Description

Authentication service handles registration of PAM handlers and calling of those handlers.

Definition at line 14 of file AuthenticationService.php.

Constructor & Destructor Documentation

Elgg\AuthenticationService::__construct ( protected HandlersService $handlerService )

Create new service.

Parameters

HandlersService $handlerService handler service

Definition at line 30 of file AuthenticationService.php.

Elgg\AuthenticationService::authenticate	(	string	$policy,
		array	$authentication_params = `[]`
	)

Authenticate.

Parameters

string	$policy	Authentication policy (eg. 'user' or 'api')
array	$authentication_params	(optional) Credentials to use

Exceptions

AuthenticationException

Definition at line 79 of file AuthenticationService.php.

Elgg\AuthenticationService::registerHandler	(		$handler,
		string	$importance = `'sufficient'`,
		string	$policy = `'user'`
	)

Register an authentication handler.

Parameters

callable	$handler	A callable authentication handler
string	$importance	The importance of the authentication handler ('sufficient' or 'required')
string	$policy	The policy for which the authentication handler can be used (eg. 'user' or 'api')

Definition at line 42 of file AuthenticationService.php.

Elgg\AuthenticationService::unregisterHandler	(		$handler,
		string	$policy = `'user'`
	)

Unregister an authentication handler.

Parameters

callable	$handler	The authentication handler to unregister
string	$policy	The authentication handler policy

Definition at line 64 of file AuthenticationService.php.

array Elgg\AuthenticationService::$handlers = []

protected

Definition at line 23 of file AuthenticationService.php.

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