Référence de la classe JAuthentication

Graphe d'héritage de JAuthentication:

Graphe de collaboration de JAuthentication:

Liste de tous les membres

Fonctions membres publiques
	__construct ()
	getState ()
	attach ($observer)
	detach ($observer)
	authenticate ($credentials, $options=array())
Fonctions membres publiques inherited from JObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Fonctions membres publiques statiques
static	getInstance ()
static	authorise ($response, $options=array())

Attributs publics
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
	$_observers = array()
	$_state = null
	$_methods = array()
Attributs protégés inherited from JObject
	$_errors = array()

Attributs protégés statiques
static	$instance

---

Documentation des constructeurs et destructeur

JAuthentication::__construct

(

)

Constructor

Depuis:

11.1

Références JText\_(), JPluginHelper\importPlugin(), et JError\raiseWarning().

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

JAuthentication::attach

(

$observer

)

Attach an observer object

Paramètres:

object

$observer

An observer object to attach

Renvoie:

void

Depuis:

11.1

Références $check, $class, et $key.

JAuthentication::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:

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

Voir également:

JAuthenticationResponse

Depuis:

11.1

Références $options, JPluginHelper\getPlugin(), JError\raiseWarning(), JText\sprintf(), et STATUS_SUCCESS.

Voici le graphe d'appel pour cette fonction :

static JAuthentication::authorise (   $response,   $options = array()  )

static

Authorises that a particular user should be able to login

Paramètres:

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

Renvoie:

array[JAuthenticationResponse] results of authorisation

Depuis:

11.2

Références $dispatcher, $options, JDispatcher\getInstance(), et JPluginHelper\getPlugin().

Voici le graphe d'appel pour cette fonction :

JAuthentication::detach

(

$observer

)

Detach an observer object

Paramètres:

object

$observer

An observer object to detach.

Renvoie:

boolean True if the observer object was detached.

Depuis:

11.1

Références $key.

static JAuthentication::getInstance ( )

static

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

Renvoie:

JAuthentication The global JAuthentication object

Depuis:

11.1

JAuthentication::getState

(

)

Get the state of the JAuthentication object

Renvoie:

mixed The state of the object.

Depuis:

11.1

---

Documentation des données membres

JAuthentication::$_methods = array()

protected

JAuthentication::$_observers = array()

protected

JAuthentication::$_state = null

protected

JAuthentication::$instance

staticprotected

const JAuthentication::STATUS_CANCEL = 2

Status to indicate cancellation of authentication (unused) STATUS_CANCEL cancelled request (unused)

Depuis:

11.2

const JAuthentication::STATUS_DENIED = 16

This is the status code returned when the account has been denied (prevent login) STATUS_DENIED denied request (will prevent login)

Depuis:

11.2

const JAuthentication::STATUS_EXPIRED = 8

This is the status code returned when the account has expired (prevent login) STATUS_EXPIRED an expired account (will prevent login)

Depuis:

11.2

const JAuthentication::STATUS_FAILURE = 4

This is the status code returned when the authentication failed (prevent login if no success) STATUS_FAILURE failed request

Depuis:

11.2

Référencé par plgAuthenticationJoomla\onUserAuthenticate(), plgAuthenticationLdap\onUserAuthenticate(), PlgAuthenticationGMail\onUserAuthenticate(), et plgSystemLog\onUserLoginFailure().

const JAuthentication::STATUS_SUCCESS = 1

This is the status code returned when the authentication is success (permit login) STATUS_SUCCESS successful response

Depuis:

11.2

Référencé par authenticate(), plgAuthenticationJoomla\onUserAuthenticate(), plgAuthenticationLdap\onUserAuthenticate(), PlgAuthenticationGMail\onUserAuthenticate(), et plgSystemLog\onUserLoginFailure().

const JAuthentication::STATUS_UNKNOWN = 32

This is the status code returned when the account doesn't exist (not an error) STATUS_UNKNOWN unknown account (won't permit or prevent login)

Depuis:

11.2

---

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

• authentication.php