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)

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

---

Description détaillée

Définition à la ligne 19 du fichier authentication.php.

---

Documentation des constructeurs et destructeur

JAuthentication::__construct

(

)

Constructor

Depuis:

11.1

Définition à la ligne 101 du fichier authentication.php.

Références JText\_(), JLog\add(), et JLog\WARNING.

        {
                $isLoaded = JPluginHelper::importPlugin('authentication');

                if (!$isLoaded)
                {
                        JLog::add(JText::_('JLIB_USER_ERROR_AUTHENTICATION_LIBRARIES'), JLog::WARNING, 'jerror');
                }
        }

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

Définition à la ligne 150 du fichier authentication.php.

        {
                if (is_array($observer))
                {
                        if (!isset($observer['handler']) || !isset($observer['event']) || !is_callable($observer['handler']))
                        {
                                return;
                        }

                        // Make sure we haven't already attached this array as an observer
                        foreach ($this->observers as $check)
                        {
                                if (is_array($check) && $check['event'] == $observer['event'] && $check['handler'] == $observer['handler'])
                                {
                                        return;
                                }
                        }

                        $this->observers[] = $observer;
                        end($this->observers);
                        $methods = array($observer['event']);
                }
                else
                {
                        if (!($observer instanceof JAuthentication))
                        {
                                return;
                        }

                        // Make sure we haven't already attached this object as an observer
                        $class = get_class($observer);

                        foreach ($this->observers as $check)
                        {
                                if ($check instanceof $class)
                                {
                                        return;
                                }
                        }

                        $this->observers[] = $observer;
                        $methods = array_diff(get_class_methods($observer), get_class_methods('JPlugin'));
                }

                $key = key($this->observers);

                foreach ($methods as $method)
                {
                        $method = strtolower($method);

                        if (!isset($this->methods[$method]))
                        {
                                $this->methods[$method] = array();
                        }

                        $this->methods[$method][] = $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

Définition à la ligne 255 du fichier authentication.php.

Références JLog\add(), JText\sprintf(), et JLog\WARNING.

        {
                // Get plugins
                $plugins = JPluginHelper::getPlugin('authentication');

                // Create authentication response
                $response = new JAuthenticationResponse;

                /*
                 * Loop through the plugins and check if the credentials can be used to authenticate
                 * the user
                 *
                 * Any errors raised in the plugin should be returned via the JAuthenticationResponse
                 * and handled appropriately.
                 */
                foreach ($plugins as $plugin)
                {
                        $className = 'plg' . $plugin->type . $plugin->name;

                        if (class_exists($className))
                        {
                                $plugin = new $className($this, (array) $plugin);
                        }
                        else
                        {
                                // Bail here if the plugin can't be created
                                JLog::add(JText::sprintf('JLIB_USER_ERROR_AUTHENTICATION_FAILED_LOAD_PLUGIN', $className), JLog::WARNING, 'jerror');
                                continue;
                        }

                        // Try to authenticate
                        $plugin->onUserAuthenticate($credentials, $options, $response);

                        // If authentication is successful break out of the loop
                        if ($response->status === self::STATUS_SUCCESS)
                        {
                                if (empty($response->type))
                                {
                                        $response->type = isset($plugin->_name) ? $plugin->_name : $plugin->name;
                                }
                                break;
                        }
                }

                if (empty($response->username))
                {
                        $response->username = $credentials['username'];
                }

                if (empty($response->fullname))
                {
                        $response->fullname = $credentials['username'];
                }

                if (empty($response->password) && isset($credentials['password']))
                {
                        $response->password = $credentials['password'];
                }

                return $response;
        }

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

Définition à la ligne 327 du fichier authentication.php.

Références JEventDispatcher\getInstance().

        {
                // Get plugins in case they haven't been imported already
                JPluginHelper::importPlugin('user');

                JPluginHelper::importPlugin('authentication');
                $dispatcher = JEventDispatcher::getInstance();
                $results = $dispatcher->trigger('onUserAuthorisation', array($response, $options));

                return $results;
        }

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

Définition à la ligne 218 du fichier authentication.php.

        {
                $retval = false;

                $key = array_search($observer, $this->observers);

                if ($key !== false)
                {
                        unset($this->observers[$key]);
                        $retval = true;

                        foreach ($this->methods as &$method)
                        {
                                $k = array_search($key, $method);

                                if ($k !== false)
                                {
                                        unset($method[$k]);
                                }
                        }
                }

                return $retval;
        }

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

Définition à la ligne 119 du fichier authentication.php.

        {
                if (empty(self::$instance))
                {
                        self::$instance = new JAuthentication;
                }

                return self::$instance;
        }

JAuthentication::getState

(

)

Get the state of the JAuthentication object

Renvoie:

mixed The state of the object.

Depuis:

11.1

Définition à la ligne 136 du fichier authentication.php.

        {
                return $this->state;
        }

---

Documentation des données membres

JAuthentication::$instance

staticprotected

Définition à la ligne 94 du fichier authentication.php.

JAuthentication::$methods = array()

protected

Définition à la ligne 88 du fichier authentication.php.

JAuthentication::$observers = array()

protected

Définition à la ligne 72 du fichier authentication.php.

JAuthentication::$state = null

protected

Définition à la ligne 80 du fichier authentication.php.

const JAuthentication::STATUS_CANCEL = 2

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

Depuis:

11.2

Définition à la ligne 35 du fichier authentication.php.

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

Définition à la ligne 57 du fichier authentication.php.

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

Définition à la ligne 50 du fichier authentication.php.

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

Définition à la ligne 42 du fichier authentication.php.

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

Définition à la ligne 27 du fichier authentication.php.

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

Définition à la ligne 64 du fichier authentication.php.

---

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

• jplatform-13.1/joomla/user/authentication.php