Callback from the CAS server

Collaboration diagram for Callback from the CAS server:

Functions
	CAS_Client::_setCallbackMode ($callback_mode)
	This method sets/unsets callback mode. More...
	CAS_Client::_isCallbackMode ()
	This method returns true when the CAs client is running i callback mode, false otherwise. More...
	CAS_Client::_getCallbackURL ()
	This method returns the URL that should be used for the PGT callback (in fact the URL of the current request without any CGI parameter, except if phpCAS::setFixedCallbackURL() was used). More...
	CAS_Client::setCallbackURL ($url)
	This method sets the callback url. More...
	CAS_Client::_callback ()
	This method is called by CAS_Client::CAS_Client() when running in callback mode. More...

Variables
	CAS_Client::$_callback_mode
	each PHP script using phpCAS in proxy mode is its own callback to get the PGT back from the CAS server. More...
	CAS_Client::$_callback_url
	the URL that should be used for the PGT callback (in fact the URL of the current request without any CGI parameter). More...

Detailed Description

Function Documentation

_callback()

CAS_Client::_callback ( )

private

This method is called by CAS_Client::CAS_Client() when running in callback mode.

It stores the PGT and its PGT Iou, prints its output and halts.

Returns

void

Definition at line 2461 of file Client.php.

References $_GET, CAS_Client\_storePGT(), phpCAS\error(), CAS_Client\printHTMLFooter(), CAS_Client\printHTMLHeader(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceExit().

Referenced by CAS_Client\_wasPreviouslyAuthenticated().

    {
        phpCAS::traceBegin();
        if (preg_match('/PGTIOU-[\.\-\w]/', $_GET['pgtIou'])) {
            if (preg_match('/[PT]GT-[\.\-\w]/', $_GET['pgtId'])) {
                $this->printHTMLHeader('phpCAS callback');
                $pgt_iou = $_GET['pgtIou'];
                $pgt = $_GET['pgtId'];
                phpCAS::trace('Storing PGT `' . $pgt . '\' (id=`' . $pgt_iou . '\')');
                echo '<p>Storing PGT `' . $pgt . '\' (id=`' . $pgt_iou . '\').</p>';
                $this->_storePGT($pgt, $pgt_iou);
                $this->printHTMLFooter();
                phpCAS::traceExit("Successfull Callback");
            } else {
                phpCAS::error('PGT format invalid' . $_GET['pgtId']);
                phpCAS::traceExit('PGT format invalid' . $_GET['pgtId']);
            }
        } else {
            phpCAS::error('PGTiou format invalid' . $_GET['pgtIou']);
            phpCAS::traceExit('PGTiou format invalid' . $_GET['pgtIou']);
        }

        // Flush the buffer to prevent from sending anything other then a 200
        // Success Status back to the CAS Server. The Exception would normally
        // report as a 500 error.
        flush();
        throw new CAS_GracefullTerminationException();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getCallbackURL()

CAS_Client::_getCallbackURL ( )

private

This method returns the URL that should be used for the PGT callback (in fact the URL of the current request without any CGI parameter, except if phpCAS::setFixedCallbackURL() was used).

Returns

The callback URL

Definition at line 2420 of file Client.php.

References CAS_Client\$_callback_url, $_SERVER, and CAS_Client\_getClientUrl().

Referenced by CAS_Client\validateCAS20().

    {
        // the URL is built when needed only
        if (empty($this->_callback_url)) {
            $final_uri = '';
            // remove the ticket if present in the URL
            $final_uri = 'https://';
            $final_uri .= $this->_getClientUrl();
            $request_uri = $_SERVER['REQUEST_URI'];
            $request_uri = preg_replace('/\?.*$/', '', $request_uri);
            $final_uri .= $request_uri;
            $this->_callback_url = $final_uri;
        }
        return $this->_callback_url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_isCallbackMode()

CAS_Client::_isCallbackMode ( )

private

This method returns true when the CAs client is running i callback mode, false otherwise.

Returns

A boolean.

Definition at line 2399 of file Client.php.

References CAS_Client\$_callback_mode.

Referenced by CAS_Client\__construct(), and CAS_Client\_wasPreviouslyAuthenticated().

    {
        return $this->_callback_mode;
    }

Here is the caller graph for this function:

_setCallbackMode()

CAS_Client::_setCallbackMode (   $callback_mode )

private

This method sets/unsets callback mode.

Parameters

bool

$callback_mode

true to set callback mode, false otherwise.

Returns

void

Definition at line 2388 of file Client.php.

Referenced by CAS_Client\__construct().

    {
        $this->_callback_mode = $callback_mode;
    }

Here is the caller graph for this function:

setCallbackURL()

CAS_Client::setCallbackURL

(

$url

)

This method sets the callback url.

Parameters

string

$url

url to set callback

Returns

void

Definition at line 2443 of file Client.php.

References $url, and CAS_Client\ensureIsProxy().

    {
        // Sequence validation
        $this->ensureIsProxy();
        // Argument Validation
        if (gettype($url) != 'string') {
            throw new CAS_TypeMismatchException($url, '$url', 'string');
        }

        return $this->_callback_url = $url;
    }

Here is the call graph for this function:

Variable Documentation

$_callback_mode

CAS_Client::$_callback_mode

private

each PHP script using phpCAS in proxy mode is its own callback to get the PGT back from the CAS server.

callback_mode is detected by the constructor thanks to the GET parameters. a boolean to know if the CAS client is running in callback mode. Written by CAS_Client::setCallBackMode(), read by CAS_Client::_isCallbackMode().

Definition at line 2379 of file Client.php.

Referenced by CAS_Client\_isCallbackMode().

$_callback_url

CAS_Client::$_callback_url

private

the URL that should be used for the PGT callback (in fact the URL of the current request without any CGI parameter).

Written and read by CAS_Client::_getCallbackURL().

Definition at line 2411 of file Client.php.

Referenced by CAS_Client\_getCallbackURL().