Auth_NoAuth Class Reference

This class is just to fill in as Auth if exception if thrown in factory. More...

Inheritance diagram for Auth_NoAuth:
Auth

Public Member Functions

 __construct ($config=NULL)
 logged_in ($role=NULL)
 get_user ()
 Returns the currently logged in user, or NoAuth user.
 login ($username, $password, $auth_method=false)
 Attempt to log in a user by using an ORM object and plain-text password.
 verify_password ($user, $password)
 Verify password for a logged in user.
 authorized_for ($authorization_point)
 Returns true if current session has access for a given authorization point.

Detailed Description

This class is just to fill in as Auth if exception if thrown in factory.

When showing an error page (as from exception in factory method), the instance needs to be set, so not a new exception will be thrown when rendering the error page


Constructor & Destructor Documentation

Auth_NoAuth::__construct ( config = NULL  ) 
Parameters:
$config array Optional method config

Member Function Documentation

Auth_NoAuth::authorized_for ( authorization_point  ) 

Returns true if current session has access for a given authorization point.

Parameters:
$authorization_point string authorization point
Returns:
boolean true if access

Reimplemented from Auth.

Auth_NoAuth::get_user (  ) 

Returns the currently logged in user, or NoAuth user.

Returns:
mixed

Reimplemented from Auth.

Auth_NoAuth::logged_in ( role = NULL  ) 
Parameters:
$role mixed This is something, remove?
Auth_NoAuth::login ( username,
password,
auth_method = false 
)

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

Parameters:
$username string username to log in
$password string password to check against
$auth_method mixed Which auth method to use
Returns:
boolean True on success

Reimplemented from Auth.

Auth_NoAuth::verify_password ( user,
password 
)

Verify password for a logged in user.

Usable for form validation of critical user data, for example validate a password change.

This method doesn't use APC

Parameters:
$user User_Model User object to verify
$password string Password to test
Returns:
boolean true if password is ok

Reimplemented from Auth.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables

Generated on 19 Dec 2018 for ninja by  doxygen 1.6.1