PGT storage

Collaboration diagram for PGT storage:

Functions
static	phpCAS::setPGTStorage ($storage)
	This method can be used to set a custom PGT storage object. More...
static	phpCAS::setPGTStorageDb ($dsn_or_pdo, $username='', $password='', $table='', $driver_options=null)
	This method is used to tell phpCAS to store the response of the CAS server to PGT requests in a database. More...
static	phpCAS::setPGTStorageFile ($path='')
	This method is used to tell phpCAS to store the response of the CAS server to PGT requests onto the filesystem. More...

Variables
const	CAS_PGT_STORAGE_FILE_DEFAULT_PATH session_save_path()
	Default path used when storing PGT's to file. More...

Detailed Description

Function Documentation

setPGTStorage()

static phpCAS::setPGTStorage (   $storage )

static

This method can be used to set a custom PGT storage object.

Parameters

CAS_PGTStorage

$storage

a PGT storage object that inherits from the CAS_PGTStorage class

Returns

void

Definition at line 781 of file CAS.php.

References phpCAS\_validateProxyExists(), phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS :: traceBegin();
        phpCAS::_validateProxyExists();

        try {
            self::$_PHPCAS_CLIENT->setPGTStorage($storage);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
        phpCAS :: traceEnd();
    }

Here is the call graph for this function:

setPGTStorageDb()

static phpCAS::setPGTStorageDb (   $dsn_or_pdo,   $username = '',   $password = '',   $table = '',   $driver_options = null  )

static

This method is used to tell phpCAS to store the response of the CAS server to PGT requests in a database.

Parameters

string	$dsn_or_pdo	a dsn string to use for creating a PDO object or a PDO object
string	$username	the username to use when connecting to the database
string	$password	the password to use when connecting to the database
string	$table	the table to use for storing and retrieving PGT's
string	$driver_options	any driver options to use when connecting to the database

Returns

void

Definition at line 811 of file CAS.php.

References $password, $table, phpCAS\_validateProxyExists(), phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

      {
        phpCAS :: traceBegin();
        phpCAS::_validateProxyExists();

        try {
            self::$_PHPCAS_CLIENT->setPGTStorageDb($dsn_or_pdo, $username, $password, $table, $driver_options);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
        phpCAS :: traceEnd();
    }

Here is the call graph for this function:

setPGTStorageFile()

static phpCAS::setPGTStorageFile (   $path = '' )

static

This method is used to tell phpCAS to store the response of the CAS server to PGT requests onto the filesystem.

Parameters

string

$path

the path where the PGT's should be stored

Returns

void

Definition at line 833 of file CAS.php.

References $path, phpCAS\_validateProxyExists(), phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS :: traceBegin();
        phpCAS::_validateProxyExists();

        try {
            self::$_PHPCAS_CLIENT->setPGTStorageFile($path);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
        phpCAS :: traceEnd();
    }

Here is the call graph for this function:

Variable Documentation

CAS_PGT_STORAGE_FILE_DEFAULT_PATH

const CAS_PGT_STORAGE_FILE_DEFAULT_PATH session_save_path()

Default path used when storing PGT's to file.

Definition at line 155 of file CAS.php.

Referenced by CAS_PGTStorage_File\__construct().