File Auth driver. [!!] this Auth driver does not support roles nor autologin.
Class declared in MODPATH/auth/classes/auth/file.php on line 3.
NULL
Constructor loads the user list into the class.
publicfunction__construct($config=array()){parent::__construct($config);// Load user list$this->_users = Arr::get($config,'users',array());}
Compare password with original (plain text). Works for current (logged in) user
string
$password
required - Passwordboolean
publicfunctioncheck_password($password){$username=$this->get_user();if($username=== FALSE){returnFALSE;}return($password===$this->password($username));}
Forces a user to be logged in, without specifying a password.
mixed
$username
required - Usernameboolean
publicfunctionforce_login($username){// Complete the loginreturn$this->complete_login($username);}
Get the stored password for a username.
mixed
$username
required - Usernamestring
publicfunctionpassword($username){returnArr::get($this->_users,$username, FALSE);}
Gets the currently logged in user from the session. Returns NULL if no user is currently logged in.
mixed
$default
= NULL - Default value to return if the user is currently not logged in.mixed
publicfunctionget_user($default= NULL){return$this->_session->get($this->_config['session_key'],$default);}
Perform a hmac hash, using the configured method.
string
$str
required - String to hashstring
publicfunctionhash($str){if( !$this->_config['hash_key'])thrownewKohana_Exception('A valid hash key must be set in your auth config.');returnhash_hmac($this->_config['hash_method'],$str,$this->_config['hash_key']);}
Creates a hashed hmac password from a plaintext password. This method is deprecated, Auth::hash should be used instead.
string
$password
required - Plaintext password
publicfunctionhash_password($password){return$this->hash($password);}
Singleton pattern
Auth
publicstaticfunctioninstance(){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 instanceAuth::$_instance=new$class($config);}returnAuth::$_instance;}
Check if there is an active session. Optionally allows checking for a specific role.
string
$role
= NULL - Role namemixed
publicfunctionlogged_in($role= NULL){return($this->get_user() !== NULL);}
Attempt to log in a user by using an ORM object and plain-text password.
string
$username
required - Username to log instring
$password
required - Password to check againstboolean
$remember
= bool FALSE - Enable autologinboolean
publicfunctionlogin($username,$password,$remember= FALSE){if(empty($password))returnFALSE;return$this->_login($username,$password,$remember);}
Log out a user by removing the related session variables.
boolean
$destroy
= bool FALSE - Completely destroy the sessionboolean
$logout_all
= bool FALSE - Remove all tokens for userboolean
publicfunctionlogout($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 checkreturn!$this->logged_in();}
Logs a user in.
string
$username
required - Usernamestring
$password
required - Passwordboolean
$remember
required - Enable autologin (not supported)boolean
protectedfunction_login($username,$password,$remember){if(is_string($password)){// Create a hashed password$password=$this->hash($password);}if(isset($this->_users[$username]) AND$this->_users[$username] ===$password){// Complete the loginreturn$this->complete_login($username);}// Login failedreturnFALSE;}
protectedfunctioncomplete_login($user){// Regenerate session_id$this->_session->regenerate();// Store username in session$this->_session->set($this->_config['session_key'],$user);returnTRUE;}