Class ElggPAM

ElggPAM Pluggable Authentication Module

Package: Elgg\Core\Authentication
Located at ElggPAM.php

Methods summary
`public`	# `__construct( string $policy )` ElggPAM constructor ElggPAM constructor Parameters `$policy` `string` $policy PAM policy type: user, api, or plugin-defined policies
`public boolean`	# `authenticate( array $credentials = array() )` Authenticate a set of credentials against a policy This function will process all registered PAM handlers or stop when the first handler fails. A handler fails by either returning false or throwing an exception. The advantage of throwing an exception is that it returns a message that can be passed to the user. The processing order of the handlers is determined by the order that they were registered. Authenticate a set of credentials against a policy This function will process all registered PAM handlers or stop when the first handler fails. A handler fails by either returning false or throwing an exception. The advantage of throwing an exception is that it returns a message that can be passed to the user. The processing order of the handlers is determined by the order that they were registered. If $credentials are provided, the PAM handler should authenticate using the provided credentials. If not, then credentials should be prompted for or otherwise retrieved (eg from the HTTP header or $_SESSION). Parameters `$credentials` `array` $credentials Credentials array dependant on policy type Returns `boolean`
`public string`	# `getFailureMessage( )` Get a failure message to display to user Get a failure message to display to user Returns `string`

Properties summary
`protected string`	`$policy`		# PAM policy type: user, api or plugin-defined policies PAM policy type: user, api or plugin-defined policies
`protected array`	`$messages`		# Failure mesages Failure mesages