Classes | Modules | Functions | Variables

PGT storage
[CAS Proxy features (CAS 2.0, Proxy Granting Tickets)]

Classes

class  CAS_PGTStorage_AbstractStorage

Modules

 PGT storage in a database
 PGT storage on the filesystem

Functions

 CAS_Client::initPGTStorage ()
 CAS_Client::storePGT ($pgt, $pgt_iou)
 CAS_Client::loadPGT ($pgt_iou)
 CAS_Client::setPGTStorage ($storage)
 CAS_Client::setPGTStorageDb ($dsn_or_pdo, $username='', $password='', $table='', $driver_options=null)
 CAS_Client::setPGTStorageFile ($path='')
 CAS_Client::validatePGT (&$validate_url, $text_response, $tree_response)
 CAS_Client::retrievePT ($target_service, &$err_code, &$err_msg)
 CAS_PGTStorage_AbstractStorage::__construct ($cas_parent)
 CAS_PGTStorage_AbstractStorage::getStorageType ()
 CAS_PGTStorage_AbstractStorage::getStorageInfo ()
 CAS_PGTStorage_AbstractStorage::setErrorMessage ($error_message)
 CAS_PGTStorage_AbstractStorage::getErrorMessage ()
 CAS_PGTStorage_AbstractStorage::isInitialized ()
 CAS_PGTStorage_AbstractStorage::init ()
 CAS_PGTStorage_AbstractStorage::write ($pgt, $pgt_iou)
 CAS_PGTStorage_AbstractStorage::read ($pgt_iou)

Variables

 CAS_Client::$_pgt_storage
 CAS_PGTStorage_AbstractStorage::$_error_message
 CAS_PGTStorage_AbstractStorage::$_initialized

Function Documentation

CAS_PGTStorage_AbstractStorage::__construct ( cas_parent  )  [protected, inherited]

The constructor of the class, should be called only by inherited classes.

Parameters:
$cas_parent the CASclient instance that creates the current object.

Definition at line 63 of file AbstractStorage.php.

References phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().

CAS_PGTStorage_AbstractStorage::getErrorMessage (  )  [inherited]

This method returns an error message set by PGTStorage::setErrorMessage().

Returns:
an error message when set by PGTStorage::setErrorMessage(), FALSE otherwise.
Deprecated:
not used.

Definition at line 135 of file AbstractStorage.php.

CAS_PGTStorage_AbstractStorage::getStorageInfo (  )  [inherited]

This virtual method returns an informational string giving informations on the parameters of the storage.(used for debugging purposes).

Reimplemented in CAS_PGTStorage_Db, and CAS_PGTStorage_File.

Definition at line 93 of file AbstractStorage.php.

References phpCAS::error().

CAS_PGTStorage_AbstractStorage::getStorageType (  )  [inherited]

This virtual method returns an informational string giving the type of storage used by the object (used for debugging purposes).

Reimplemented in CAS_PGTStorage_Db, and CAS_PGTStorage_File.

Definition at line 82 of file AbstractStorage.php.

References phpCAS::error().

CAS_PGTStorage_AbstractStorage::init (  )  [protected, inherited]

This virtual method initializes the object.

Reimplemented in CAS_PGTStorage_Db, and CAS_PGTStorage_File.

Definition at line 170 of file AbstractStorage.php.

CAS_Client::initPGTStorage (  )  [private, inherited]

This method is used to initialize the storage of PGT's. Halts on error.

Definition at line 1987 of file Client.php.

CAS_PGTStorage_AbstractStorage::isInitialized (  )  [protected, inherited]

This method tells if the storage has already been intialized.

Returns:
a boolean

Definition at line 160 of file AbstractStorage.php.

Referenced by CAS_PGTStorage_File::init(), and CAS_PGTStorage_Db::init().

CAS_Client::loadPGT ( pgt_iou  )  [private, inherited]

This method reads a PGT from its Iou and deletes the corresponding storage entry.

Parameters:
$pgt_iou the PGT Iou
Returns:
The PGT corresponding to the Iou, FALSE when not found.

Definition at line 2019 of file Client.php.

CAS_PGTStorage_AbstractStorage::read ( pgt_iou  )  [protected, inherited]

This virtual method reads a PGT corresponding to a PGT Iou and deletes the corresponding storage entry.

Note:
Should never be called.
Parameters:
$pgt_iou the PGT iou

Reimplemented in CAS_PGTStorage_Db, and CAS_PGTStorage_File.

Definition at line 202 of file AbstractStorage.php.

References phpCAS::error().

CAS_Client::retrievePT ( target_service,
&$  err_code,
&$  err_msg 
) [inherited]

This method is used to retrieve PT's from the CAS server thanks to a PGT.

Parameters:
$target_service the service to ask for with the PT.
$err_code an error code (PHPCAS_SERVICE_OK on success).
$err_msg an error message (empty on success).
Returns:
a Proxy Ticket, or FALSE on error.

Definition at line 2143 of file Client.php.

References $cas_url, phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().

CAS_PGTStorage_AbstractStorage::setErrorMessage ( error_message  )  [protected, inherited]

This method sets en error message, which can be read later by PGTStorage::getErrorMessage().

Parameters:
$error_message an error message
Deprecated:
not used.

Definition at line 121 of file AbstractStorage.php.

CAS_Client::setPGTStorage ( storage  )  [inherited]

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

Parameters:
$storage a PGT storage object that inherits from the CAS_PGTStorage class

Definition at line 2032 of file Client.php.

References phpCAS::error().

CAS_Client::setPGTStorageDb ( dsn_or_pdo,
username = '',
password = '',
table = '',
driver_options = null 
) [inherited]

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

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

Definition at line 2058 of file Client.php.

CAS_Client::setPGTStorageFile ( path = ''  )  [inherited]

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

Parameters:
$format the format used to store the PGT's (`plain' and `xml' allowed)
$path the path where the PGT's should be stored

Definition at line 2071 of file Client.php.

CAS_Client::storePGT ( pgt,
pgt_iou 
) [private, inherited]

This method stores a PGT. Halts on error.

Parameters:
$pgt the PGT to store
$pgt_iou its corresponding Iou

Definition at line 2004 of file Client.php.

CAS_Client::validatePGT ( &$  validate_url,
text_response,
tree_response 
) [private, inherited]

This method is used to validate a PGT; halt on failure.

Parameters:
$validate_url the URL of the request to the CAS server.
$text_response the response of the CAS server, as is (XML text); result of CAS_Client::validateST() or CAS_Client::validatePT().
$tree_response the response of the CAS server, as a DOM XML tree; result of CAS_Client::validateST() or CAS_Client::validatePT().
Returns:
bool TRUE when successfull, halt otherwise by calling CAS_Client::authError().

Definition at line 2092 of file Client.php.

References phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().

Referenced by CAS_Client::isAuthenticated().

CAS_PGTStorage_AbstractStorage::write ( pgt,
pgt_iou 
) [protected, inherited]

This virtual method stores a PGT and its corresponding PGT Iuo.

Note:
Should never be called.
Parameters:
$pgt the PGT
$pgt_iou the PGT iou

Reimplemented in CAS_PGTStorage_Db, and CAS_PGTStorage_File.

Definition at line 188 of file AbstractStorage.php.

References phpCAS::error().


Variable Documentation

CAS_PGTStorage_AbstractStorage::$_error_message [private, inherited]

string used to store an error message. Written by PGTStorage::setErrorMessage(), read by PGTStorage::getErrorMessage().

Deprecated:
not used.

Definition at line 110 of file AbstractStorage.php.

CAS_PGTStorage_AbstractStorage::$_initialized [private, inherited]

a boolean telling if the storage has already been initialized. Written by PGTStorage::init(), read by PGTStorage::isInitialized().

Definition at line 151 of file AbstractStorage.php.

CAS_Client::$_pgt_storage [private, inherited]

an instance of a class inheriting of PGTStorage, used to deal with PGT storage. Created by CAS_Client::setPGTStorageFile(), used by CAS_Client::setPGTStorageFile() and CAS_Client::initPGTStorage().

Definition at line 1981 of file Client.php.