Authentication

Joomla Framework Authentication Class

since

1.0

Methods

addStrategy

Register a new strategy

addStrategy(string $strategyName, \Joomla\Authentication\AuthenticationStrategyInterface $strategy) : void
since

1.0

Arguments

$strategyName

stringThe name to use for the strategy.

$strategy

\Joomla\Authentication\AuthenticationStrategyInterfaceThe authentication strategy object to add.

authenticate

Perform authentication

authenticate(array<mixed,\Joomla\Authentication\AuthenticationStrategyInterface> $strategies = array()) : string|boolean
since

1.0

throws

\RuntimeException

Arguments

$strategies

array<mixed,\Joomla\Authentication\AuthenticationStrategyInterface>Array of strategies to try - empty to try all strategies.

Response

string|booleanA string containing a username if authentication is successful, false otherwise.

getResults

Get authentication results.

getResults() : array<mixed,integer>

Use this if you want to get more detailed information about the results of an authentication attempts.

since

1.0

Response

array<mixed,integer>An array containing authentication results.

Constants

SUCCESS

Authentication was successful.

since

1.0

INVALID_CREDENTIALS

Credentials were provided but they were invalid.

since

1.0

NO_SUCH_USER

Credentials were provided but the user did not exist in the credential store.

since

1.0

NO_CREDENTIALS

There were no credentials found.

since

1.0

INCOMPLETE_CREDENTIALS

There were partial credentials found but they were not complete.

since

1.0

Properties

strategies

The array of strategies.

results

The array of results.

since

1.0

Type(s)

array<mixed,integer>