Initialization

Collaboration diagram for Initialization:

Functions
static	phpCAS::client ( $server_version, $server_hostname, $server_port, $server_uri, $changeSessionID=true)
	phpCAS client initializer. More...
static	phpCAS::proxy ( $server_version, $server_hostname, $server_port, $server_uri, $changeSessionID=true)
	phpCAS proxy initializer. More...
static	phpCAS::isInitialized ()
	Answer whether or not the client or proxy has been initialized. More...

Detailed Description

Function Documentation

client()

static phpCAS::client (   $server_version,   $server_hostname,   $server_port,   $server_uri,   $changeSessionID = true  )

static

phpCAS client initializer.

Parameters

string	$server_version	the version of the CAS server
string	$server_hostname	the hostname of the CAS server
string	$server_port	the port the CAS server is running on
string	$server_uri	the URI the CAS server is responding on
bool	$changeSessionID	Allow phpCAS to change the session_id (Single Sign Out/handleLogoutRequests is based on that change)

Returns

a newly created CAS_Client object

Note

Only one of the phpCAS::client() and phpCAS::proxy functions should be called, only once, and before all other methods (except phpCAS::getVersion() and phpCAS::setDebug()).

Definition at line 345 of file CAS.php.

References Vendor\Package\$e, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by ilAuthProviderCAS\doAuthentication().

      {
        phpCAS :: traceBegin();
        if (is_object(self::$_PHPCAS_CLIENT)) {
            phpCAS :: error(self::$_PHPCAS_INIT_CALL['method'] . '() has already been called (at ' . self::$_PHPCAS_INIT_CALL['file'] . ':' . self::$_PHPCAS_INIT_CALL['line'] . ')');
        }

        // store where the initializer is called from
        $dbg = debug_backtrace();
        self::$_PHPCAS_INIT_CALL = array(
            'done' => true,
            'file' => $dbg[0]['file'],
            'line' => $dbg[0]['line'],
            'method' => __CLASS__ . '::' . __FUNCTION__
        );

        // initialize the object $_PHPCAS_CLIENT
        try {
            self::$_PHPCAS_CLIENT = new CAS_Client(
                $server_version,
                false,
                $server_hostname,
                $server_port,
                $server_uri,
                $changeSessionID
            );
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
        phpCAS :: traceEnd();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isInitialized()

static phpCAS::isInitialized ( )

static

Answer whether or not the client or proxy has been initialized.

Returns

bool

Definition at line 439 of file CAS.php.

    {
        return (is_object(self::$_PHPCAS_CLIENT));
    }

proxy()

static phpCAS::proxy (   $server_version,   $server_hostname,   $server_port,   $server_uri,   $changeSessionID = true  )

static

phpCAS proxy initializer.

Parameters

string	$server_version	the version of the CAS server
string	$server_hostname	the hostname of the CAS server
string	$server_port	the port the CAS server is running on
string	$server_uri	the URI the CAS server is responding on
bool	$changeSessionID	Allow phpCAS to change the session_id (Single Sign Out/handleLogoutRequests is based on that change)

Returns

a newly created CAS_Client object

Note

Only one of the phpCAS::client() and phpCAS::proxy functions should be called, only once, and before all other methods (except phpCAS::getVersion() and phpCAS::setDebug()).

Definition at line 397 of file CAS.php.

References Vendor\Package\$e, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

      {
        phpCAS :: traceBegin();
        if (is_object(self::$_PHPCAS_CLIENT)) {
            phpCAS :: error(self::$_PHPCAS_INIT_CALL['method'] . '() has already been called (at ' . self::$_PHPCAS_INIT_CALL['file'] . ':' . self::$_PHPCAS_INIT_CALL['line'] . ')');
        }

        // store where the initialzer is called from
        $dbg = debug_backtrace();
        self::$_PHPCAS_INIT_CALL = array(
            'done' => true,
            'file' => $dbg[0]['file'],
            'line' => $dbg[0]['line'],
            'method' => __CLASS__ . '::' . __FUNCTION__
        );

        // initialize the object $_PHPCAS_CLIENT
        try {
            self::$_PHPCAS_CLIENT = new CAS_Client(
                $server_version,
                true,
                $server_hostname,
                $server_port,
                $server_uri,
                $changeSessionID
            );
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
        phpCAS :: traceEnd();
    }

Here is the call graph for this function: