Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe Authentication
+ Graphe d'héritage de Authentication:

Fonctions membres publiques

 __construct ()
 
 getState ()
 
 attach ($observer)
 
 detach ($observer)
 
 authenticate ($credentials, $options=array())
 

Fonctions membres publiques statiques

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

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

 $observers = array()
 
 $state = null
 
 $methods = array()
 

Attributs protégés statiques

static $instance
 

Description détaillée

Authentication class, provides an interface for the Joomla authentication system

Depuis
11.1

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

Constructor

Depuis
11.1

Références PluginHelper\importPlugin().

Documentation des fonctions membres

◆ attach()

attach (   $observer)

Attach an observer object

Paramètres
object$observerAn observer object to attach
Renvoie
void
Depuis
11.1

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

◆ 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$credentialsArray holding the user credentials.
array$optionsArray holding user options.
Renvoie
AuthenticationResponse Response object with status variable filled in for last plugin or first successful plugin.
Voir également
AuthenticationResponse
Depuis
11.1

Références $className, $options, et PluginHelper\getPlugin().

◆ authorise()

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

Authorises that a particular user should be able to login

Paramètres
AuthenticationResponse$responseresponse including username of the user to authorise
array$optionslist of options
Renvoie
AuthenticationResponse[] Array of authentication response objects
Depuis
11.2

Références $dispatcher, $options, $results, JEventDispatcher\getInstance(), et PluginHelper\importPlugin().

◆ detach()

detach (   $observer)

Detach an observer object

Paramètres
object$observerAn observer object to detach.
Renvoie
boolean True if the observer object was detached.
Depuis
11.1

Références $key.

◆ getInstance()

static getInstance ( )
static

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

Renvoie
Authentication The global Authentication object
Depuis
11.1

◆ getState()

getState ( )

Get the state of the Authentication object

Renvoie
mixed The state of the object.
Depuis
11.1

Références $state.

Documentation des champs

◆ $instance

$instance
staticprotected

◆ $methods

$methods = array()
protected

◆ $observers

$observers = array()
protected

◆ $state

$state = null
protected

◆ STATUS_CANCEL

const STATUS_CANCEL = 2

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

Depuis
11.2

◆ STATUS_DENIED

const 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

◆ STATUS_EXPIRED

const 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

◆ STATUS_FAILURE

const 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

◆ STATUS_SUCCESS

const STATUS_SUCCESS = 1

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

Depuis
11.2

◆ STATUS_UNKNOWN

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