Référence de la classe Authentication

Fonctions membres publiques
	__construct (string $pluginType='authentication', DispatcherInterface $dispatcher=null)
	authenticate ($credentials, $options=array())
	authorise ($response, $options=array())

Fonctions membres publiques statiques
static	getInstance (string $pluginType='authentication')

Champs de données
const	STATUS_SUCCESS = 1
const	STATUS_CANCEL = 2
const	STATUS_FAILURE = 4
const	STATUS_EXPIRED = 8
const	STATUS_DENIED = 16
const	STATUS_UNKNOWN = 32

Attributs protégés
	$pluginType

Attributs protégés statiques
static	$instance = []

Description détaillée

Authentication class, provides an interface for the Joomla authentication system

Depuis

1.7.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	string	$pluginType = 'authentication',
		DispatcherInterface	$dispatcher = null
	)

Constructor

Paramètres

string	$pluginType	The plugin type to run authorisation and authentication on
DispatcherInterface	$dispatcher	The event dispatcher we're going to use

Depuis

1.7.0

Références Text\_(), Log\add(), Factory\getContainer(), PluginHelper\importPlugin(), Joomla\Event\setDispatcher(), et Log\WARNING.

Documentation des fonctions membres

authenticate()

authenticate	(		$credentials,
			$options = array()
	)

Finds out if a set of login credentials are valid by asking all observing objects to run their respective authentication routines.

Paramètres

array	$credentials	Array holding the user credentials.
array	$options	Array holding user options.

Renvoie

AuthenticationResponse Response object with status variable filled in for last plugin or first successful plugin.

Voir également

AuthenticationResponse

Depuis

1.7.0

Perform authentication

Paramètres

string[]

$strategies Array of strategies to try - empty to try all strategies.

Renvoie

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

Depuis

1.0

Exceptions

Références $options, Log\add(), Factory\getApplication(), PluginHelper\getPlugin(), Text\sprintf(), et Log\WARNING.

authorise()

authorise	(		$response,
			$options = array()
	)

Authorises that a particular user should be able to login

Paramètres

AuthenticationResponse	$response	response including username of the user to authorise
array	$options	list of options

Renvoie

AuthenticationResponse[] Array of authentication response objects

Depuis

1.7.0

Exceptions

Références $options, $results, Factory\getApplication(), et PluginHelper\importPlugin().

getInstance()

static getInstance ( string  $pluginType = 'authentication' )

static

Returns the global authentication object, only creating it if it doesn't already exist.

Paramètres

string

$pluginType

The plugin type to run authorisation and authentication on

Renvoie

Authentication The global Authentication object

Depuis

1.7.0

Référencé par UpdateModel\captiveLogin(), et CMSApplication\login().

Documentation des champs

$instance

$instance = []

staticprotected

$pluginType

$pluginType

protected

STATUS_CANCEL

const STATUS_CANCEL = 2

STATUS_DENIED

const STATUS_DENIED = 16

Référencé par CMSApplication\login(), et Token\onUserAuthenticate().

STATUS_EXPIRED

const STATUS_EXPIRED = 8

Référencé par CMSApplication\login().

STATUS_FAILURE

const STATUS_FAILURE = 4

Référencé par Basic\onUserAuthenticate(), et Token\onUserAuthenticate().

STATUS_SUCCESS

const STATUS_SUCCESS = 1

Référencé par UpdateModel\captiveLogin(), CMSApplication\login(), Basic\onUserAuthenticate(), et Token\onUserAuthenticate().

STATUS_UNKNOWN

const STATUS_UNKNOWN = 32

---

La documentation de cette classe a été générée à partir du fichier suivant :

• libraries/src/Authentication/Authentication.php