Classes | Functions | Variables

PGT storage on the filesystem
[PGT storage]

Classes

class  CAS_PGTStorage_File

Functions

 CAS_PGTStorage_File::getPath ()
 CAS_PGTStorage_File::getStorageType ()
 CAS_PGTStorage_File::getStorageInfo ()
 CAS_PGTStorage_File::__construct ($cas_parent, $path)
 CAS_PGTStorage_File::init ()
 CAS_PGTStorage_File::getPGTIouFilename ($pgt_iou)
 CAS_PGTStorage_File::write ($pgt, $pgt_iou)
 CAS_PGTStorage_File::read ($pgt_iou)

Variables

 CAS_PGTStorage_File::$_path

Function Documentation

CAS_PGTStorage_File::__construct ( cas_parent,
path 
) [inherited]

The class constructor, called by CAS_Client::SetPGTStorageFile().

Parameters:
$cas_parent the CAS_Client instance that creates the object.
$path the path where the PGT's should be stored

Definition at line 113 of file File.php.

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

CAS_PGTStorage_File::getPath (  )  [private, inherited]

This method returns the name of the directory where PGT's should be stored on the filesystem.

Returns:
the name of a directory (with leading and trailing '/')

Definition at line 68 of file File.php.

Referenced by CAS_PGTStorage_File::getPGTIouFilename().

CAS_PGTStorage_File::getPGTIouFilename ( pgt_iou  )  [private, inherited]

This method returns the filename corresponding to a PGT Iou.

Parameters:
$pgt_iou the PGT iou.
Returns:
a filename

Definition at line 176 of file File.php.

References CAS_PGTStorage_File::getPath(), phpCAS::traceBegin(), and phpCAS::traceEnd().

Referenced by CAS_PGTStorage_File::read(), and CAS_PGTStorage_File::write().

CAS_PGTStorage_File::getStorageInfo (  )  [inherited]

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

Returns:
an informational string.

Reimplemented from CAS_PGTStorage_AbstractStorage.

Definition at line 96 of file File.php.

CAS_PGTStorage_File::getStorageType (  )  [inherited]

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

Returns:
an informational string.

Reimplemented from CAS_PGTStorage_AbstractStorage.

Definition at line 84 of file File.php.

CAS_PGTStorage_File::init (  )  [inherited]

This method is used to initialize the storage. Halts on error.

Reimplemented from CAS_PGTStorage_AbstractStorage.

Definition at line 153 of file File.php.

References CAS_PGTStorage_AbstractStorage::isInitialized(), phpCAS::traceBegin(), and phpCAS::traceEnd().

CAS_PGTStorage_File::read ( pgt_iou  )  [inherited]

This method reads a PGT corresponding to a PGT Iou and deletes the corresponding file.

Parameters:
$pgt_iou the PGT iou
Returns:
the corresponding PGT, or FALSE on error

Reimplemented from CAS_PGTStorage_AbstractStorage.

Definition at line 222 of file File.php.

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

CAS_PGTStorage_File::write ( pgt,
pgt_iou 
) [inherited]

This method stores a PGT and its corresponding PGT Iou into a file. Echoes a warning on error.

Parameters:
$pgt the PGT
$pgt_iou the PGT iou

Reimplemented from CAS_PGTStorage_AbstractStorage.

Definition at line 193 of file File.php.

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


Variable Documentation

CAS_PGTStorage_File::$_path [private, inherited]

a string telling where PGT's should be stored on the filesystem. Written by PGTStorageFile::PGTStorageFile(), read by getPath().

Definition at line 58 of file File.php.