Modules

abstract Kohana_Auth

This class is a transparent base class for Auth and should not be accessed directly.

User authorization library. Handles user login and logout, as well as secure password hashing.

package
Kohana/Auth
author
Kohana Team
copyright
© 2007-2012 Kohana Team
license
https://kohana.top/license

Class declared in MODPATH/auth/classes/Kohana/Auth.php on line 12.

Properties

protected $_config

Default value:
NULL

protected static $_instance

NULL

protected $_session

Default value:
NULL

Methods

public __construct( [ array $config = array(0) ] ) (defined in Kohana_Auth)

Loads Session and configuration options.

Parameters

  • array $config = array(0) - Config Options

Return Values

  • void

Source Code

public function __construct($config = [])
{
    // Save the config in the object
    $this->_config = $config;

    $this->_session = Session::instance($this->_config['session_type']);
}

abstract public check_password( ) (defined in Kohana_Auth)

Source Code

abstract public function check_password($password);

public get_user( [ mixed $default = NULL ] ) (defined in Kohana_Auth)

Gets the currently logged in user from the session. Returns null if no user is currently logged in.

Parameters

  • mixed $default = NULL - Default value to return if the user is currently not logged in.

Return Values

  • mixed

Source Code

public function get_user($default = null)
{
    return $this->_session->get($this->_config['session_key'], $default);
}

public hash( string $str ) (defined in Kohana_Auth)

Perform a hmac hash, using the configured method.

Parameters

  • string $str required - String to hash

Return Values

  • string

Source Code

public function hash($str)
{
    if (!$this->_config['hash_key'])
        throw new Kohana_Exception('A valid hash key must be set in your auth config.');

    return hash_hmac($this->_config['hash_method'], $str, $this->_config['hash_key']);
}

public static instance( ) (defined in Kohana_Auth)

Singleton pattern

Return Values

  • Auth

Source Code

public static function instance()
{
    if (!isset(Auth::$_instance)) {
        // Load the configuration for this type
        $config = Kohana::$config->load('auth');

        if (!$type = $config->get('driver')) {
            $type = 'file';
        }

        // Set the session class name
        $class = 'Auth_' . ucfirst($type);

        // Create a new session instance
        Auth::$_instance = new $class($config);
    }

    return Auth::$_instance;
}

public logged_in( [ string $role = NULL ] ) (defined in Kohana_Auth)

Check if there is an active session. Optionally allows checking for a specific role.

Parameters

  • string $role = NULL - Role name

Return Values

  • mixed

Source Code

public function logged_in($role = null)
{
    return ($this->get_user() !== null);
}

public login( string $username , string $password [, boolean $remember = bool FALSE ] ) (defined in Kohana_Auth)

Attempt to log in a user by using an ORM object and plain-text password.

Parameters

  • string $username required - Username to log in
  • string $password required - Password to check against
  • boolean $remember = bool FALSE - Enable autologin

Return Values

  • boolean

Source Code

public function login($username, $password, $remember = false)
{
    if (empty($password))
        return false;

    return $this->_login($username, $password, $remember);
}

public logout( [ boolean $destroy = bool FALSE , boolean $logout_all = bool FALSE ] ) (defined in Kohana_Auth)

Log out a user by removing the related session variables.

Parameters

  • boolean $destroy = bool FALSE - Completely destroy the session
  • boolean $logout_all = bool FALSE - Remove all tokens for user

Return Values

  • boolean

Source Code

public function logout($destroy = false, $logout_all = false)
{
    if ($destroy === true) {
        // Destroy the session completely
        $this->_session->destroy();
    } else {
        // Remove the user from the session
        $this->_session->delete($this->_config['session_key']);

        // Regenerate session_id
        $this->_session->regenerate();
    }

    // Double check
    return !$this->logged_in();
}

abstract public password( ) (defined in Kohana_Auth)

Source Code

abstract public function password($username);

abstract protected _login( ) (defined in Kohana_Auth)

Source Code

abstract protected function _login($username, $password, $remember);

protected complete_login( ) (defined in Kohana_Auth)

Source Code

protected function complete_login($user)
{
    // Regenerate session_id
    $this->_session->regenerate();

    // Store username in session
    $this->_session->set($this->_config['session_key'], $user);

    return true;
}