Class: Auth

public    class Auth

User authentication component. This is the basic authentication component; you can use this class if you only need toallow/disallow access to a page. If you need groups and roles support see the classGroupAuth and the class RoleAuth documentation.

Auth


Public Method Summary

void Auth([ string $options ])

Constructor.

void startSession()

Initialize the session.

void forceLogin()

Force the user to identify him self.

void logout()

Delete all session information and logout the user.

void refreshInfo()

Updates the user's information from the database.

Private Method Summary

void _callback(int $action, [ string $message ])

Just calls the callback function and dies.

void _connect()

Connect to the database only if necesary.

array _findByUsername(string $username, string $password)

Search the user in the database by his username and password.

array _findById(int $userId)

Search the user in the database by his user_id field.

bool _checkSession()

Validates the current session.

Public Field Summary

Private Field Summary

Public Constant Summary

Private Constant Summary

Public Method Details

Auth

public    void Auth( [ string $options ] );

Constructor.

startSession

public    void startSession(  );

Initialize the session. Use this method only if loggin in to the current page is optional but you willwant to have access to the user's information if he has already been identified.

forceLogin

public    void forceLogin(  );

Force the user to identify him self.

logout

public    void logout(  );

Delete all session information and logout the user.

refreshInfo

public    void refreshInfo(  );

Updates the user's information from the database. The user must be identified already. Usefull if you just updated the database andyou need to update your session variable.

Private Method Details

_callback

private    void _callback( int $action, [ string $message ] );

Just calls the callback function and dies.

_connect

private    void _connect(  );

Connect to the database only if necesary.

_findByUsername

private    array _findByUsername( string $username, string $password );

Search the user in the database by his username and password.

_findById

private    array _findById( int $userId );

Search the user in the database by his user_id field.

_checkSession

private    bool _checkSession(  );

Validates the current session.

Public Field Details

$user

public   array $user

Holds user information.

$isIdentified

public   boolean $isIdentified

If the user has been identified

$cacheLevel

public   string $cacheLevel

Wich cache level to use.

$dbdriver

public   string $dbdriver

Database driver. Example 'mysql', 'mssql', 'oci8'...

$hostname

public   string $hostname

Database hostname server.

$username

public   string $username

Database username

$password

public   string $password

Database password

$database

public   string $database

Database.

Private Field Details

$_conn

private   string $_conn

Holds an ADOConnection instance.

$_options

private   array $_options

This array hold database configuration and execution options.

Public Constant Details

const AUTH_INVALID_USER

define( AUTH_INVALID_USER, »-2« );

The username/password pair is invalid.

const AUTH_EXPIRED

define( AUTH_EXPIRED, »-3« );

The session has expired.

const AUTH_ACCESS_DENIED

define( AUTH_ACCESS_DENIED, »-4« );

You don't have access to this area.

const AUTH_CACHE

define( AUTH_CACHE, »2« );

Allow the browser to cache the page but proxys can't.

const AUTH_NO_CACHE

define( AUTH_NO_CACHE, »1« );

Do not allow anyone to cache the page.

Private Constant Details

const AUTH_NEED_LOGIN

define( AUTH_NEED_LOGIN, »-1« );

Need a valid username/password pair.