Joomla! Documentation™

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description

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

<! removed transcluded page call, red link never existed >

Syntax

authenticate($credentials, $options)

Parameter Name	Default Value	Description
$credentials		Array holding the user credentials
$options

Returns

mixed Integer userid for valid user if credentials are valid or boolean false if they are not

Defined in

libraries/joomla/user/authentication.php

Importing

jimport( 'joomla.user.authentication' );

Source Body

public function authenticate($credentials, $options)
{
        // Initialise variables.
        $auth = false;

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

        // Create authencication response
        $response = new JAuthenticationResponse();

        /*
         * Loop through the plugins and check of the creditials 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
                        JError::raiseWarning(50,'JAuthentication::authenticate: '. JText::_('Failed to load plugin') .': '. $className);
                        continue;
                }

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

                // If authentication is successfull break out of the loop
                if ($response->status === JAUTHENTICATE_STATUS_SUCCESS)
                {
                        if (empty($response->type)) {
                                $response->type = isset($plugin->_name) ? $plugin->_name : $plugin->name;
                        }
                        if (empty($response->username)) {
                                $response->username = $credentials['username'];
                        }

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

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

                        break;
                }
        }
        return $response;
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />