Auth_Controller Class Reference

Collaboration diagram for Auth_Controller:

Public Member Functions
	Auth_Controller (&$auth_obj, $login='login.php', $default='index.php', $accessList=array())
	Constructor. More...
	setAutoRedirectBack ($flag=true)
	Enables auto redirection when login is done. More...
	redirectBack ()
	Redirects Back to the calling page. More...
	redirectLogin ()
	Redirects to the login Page if not authorised. More...
	start ()
	Starts the Auth Procedure. More...
	isAuthorised ()
	Checks is the user is logged on. More...
	checkAuth ()
	Proxy call to auth. More...
	logout ()
	Proxy call to auth. More...
	getUsername ()
	Proxy call to auth. More...
	getStatus ()
	Proxy call to auth. More...

Data Fields
	$auth = null
	$login = null
	$default = null
	$autoRedirectBack = false

Detailed Description

Definition at line 61 of file Controller.php.

Member Function Documentation

Auth_Controller()

Auth_Controller::Auth_Controller	(	&	$auth_obj,
			$login = 'login.php',
			$default = 'index.php',
			$accessList = array()
	)

Constructor.

Parameters

Auth	An auth instance
string	The login page
string	The default page to go to if return page is not set
array	Some rules about which urls need to be sent to the login page

Returns

void

Todo:

Add a list of urls which need redirection

Definition at line 107 of file Controller.php.

References $_GET, $default, and $login.

    {
        $this->auth =& $auth_obj;
        $this->_loginPage = $login;
        $this->_defaultPage = $default;
        @session_start();
        if (!empty($_GET['return']) && $_GET['return'] && !strstr($_GET['return'], $this->_loginPage)) {
            $this->auth->setAuthData('returnUrl', $_GET['return']);
        }

        if(!empty($_GET['authstatus']) && $this->auth->status == '') {
            $this->auth->status = $_GET['authstatus'];
        }
    }

checkAuth()

Auth_Controller::checkAuth

(

)

Proxy call to auth.

See also

Auth::checkAuth()

Definition at line 257 of file Controller.php.

    {
        return($this->auth->checkAuth());
    }

getStatus()

Auth_Controller::getStatus

(

)

Proxy call to auth.

See also

Auth::getStatus()

Definition at line 293 of file Controller.php.

    {
        return($this->auth->getStatus());
    }

getUsername()

Auth_Controller::getUsername

(

)

Proxy call to auth.

See also

Auth::getUsername()

Definition at line 281 of file Controller.php.

    {
        return($this->auth->getUsername());
    }

isAuthorised()

Auth_Controller::isAuthorised

(

)

Checks is the user is logged on.

See also

Auth::checkAuth()

Definition at line 245 of file Controller.php.

    {
        return($this->auth->checkAuth());
    }

logout()

Auth_Controller::logout

(

)

Proxy call to auth.

See also

Auth::logout()

Definition at line 269 of file Controller.php.

    {
        return($this->auth->logout());
    }

redirectBack()

Auth_Controller::redirectBack

(

)

Redirects Back to the calling page.

Returns

void

Definition at line 145 of file Controller.php.

References $url.

Referenced by start().

    {
        // If redirectback go there
        // else go to the default page

        $returnUrl = $this->auth->getAuthData('returnUrl');
        if(!$returnUrl) {
            $returnUrl = $this->_defaultPage;
        }

        // Add some entropy to the return to make it unique
        // avoind problems with cached pages and proxies
        if(strpos($returnUrl, '?') === false) {
            $returnUrl .= '?';
        }
        $returnUrl .= uniqid('');

        // Track the auth status
        if($this->auth->status != '') {
            $url .= '&authstatus='.$this->auth->status;
        }
        header('Location:'.$returnUrl);
        print("You could not be redirected to <a href=\"$returnUrl\">$returnUrl</a>");
    }

Here is the caller graph for this function:

redirectLogin()

Auth_Controller::redirectLogin

(

)

Redirects to the login Page if not authorised.

put return page on the query or in auth

Returns

void

Definition at line 180 of file Controller.php.

References $_SERVER, and $url.

Referenced by start().

    {
        // Go to the login Page

        // For Auth, put some check to avoid infinite redirects, this should at least exclude
        // the login page

        $url = $this->_loginPage;
        if(strpos($url, '?') === false) {
            $url .= '?';
        }

        if(!strstr($_SERVER['PHP_SELF'], $this->_loginPage)) {
            $url .= 'return='.urlencode($_SERVER['PHP_SELF']);
        }

        // Track the auth status
        if($this->auth->status != '') {
            $url .= '&authstatus='.$this->auth->status;
        }

        header('Location:'.$url);
        print("You could not be redirected to <a href=\"$url\">$url</a>");
    }

Here is the caller graph for this function:

setAutoRedirectBack()

Auth_Controller::setAutoRedirectBack

(

$flag = true

)

Enables auto redirection when login is done.

Parameters

bool	Sets the autoRedirectBack flag to this

See also

Auth_Controller::autoRedirectBack

Returns

void

Definition at line 132 of file Controller.php.

    {
        $this->autoRedirectBack = $flag;
    }

start()

Auth_Controller::start

(

)

Starts the Auth Procedure.

If the page requires login the user is redirected to the login page otherwise the Auth::start is called to initialize Auth

Returns

void

Todo:

Implement an access list which specifies which urls/pages need login and which do not

Definition at line 217 of file Controller.php.

References $_SERVER, redirectBack(), and redirectLogin().

    {
        // Check the accessList here
        // ACL should be a list of urls with allow/deny
        // If allow set allowLogin to false
        // Some wild card matching should be implemented ?,*
        if(!strstr($_SERVER['PHP_SELF'], $this->_loginPage) && !$this->auth->checkAuth()) {
            $this->redirectLogin();
        } else {
            $this->auth->start();
            // Logged on and on login page
            if(strstr($_SERVER['PHP_SELF'], $this->_loginPage) && $this->auth->checkAuth()){
                $this->autoRedirectBack ?
                    $this->redirectBack() :
                    null ;
            }
        }


    }

Here is the call graph for this function:

Field Documentation

$auth

Auth_Controller::$auth = null

Definition at line 71 of file Controller.php.

$autoRedirectBack

Auth_Controller::$autoRedirectBack = false

Definition at line 92 of file Controller.php.

$default

Auth_Controller::$default = null

Definition at line 84 of file Controller.php.

Referenced by Auth_Controller().

$login

Auth_Controller::$login = null

Definition at line 77 of file Controller.php.

Referenced by Auth_Controller().

---

The documentation for this class was generated from the following file:

• Services/PEAR/lib/Auth/Controller.php