CAS_PGTStorage_File Class Reference
The CAS_PGTStorage_File class is a class for PGT file storage. More...
Inheritance diagram for CAS_PGTStorage_File:
Collaboration diagram for CAS_PGTStorage_File:
Public Member Functions | |
| getPath () | |
| This method returns the name of the directory where PGT's should be stored on the filesystem. More... | |
| getStorageType () | |
| This method returns an informational string giving the type of storage used by the object (used for debugging purposes). More... | |
| getStorageInfo () | |
| This method returns an informational string giving informations on the parameters of the storage. More... | |
| __construct ($cas_parent, $path) | |
| The class constructor, called by CAS_Client::SetPGTStorageFile(). More... | |
| init () | |
| This method is used to initialize the storage. More... | |
| getPGTIouFilename ($pgt_iou) | |
| This method returns the filename corresponding to a PGT Iou. More... | |
| write ($pgt, $pgt_iou) | |
| This method stores a PGT and its corresponding PGT Iou into a file. More... | |
| read ($pgt_iou) | |
| This method reads a PGT corresponding to a PGT Iou and deletes the corresponding file. More... | |
| Public Member Functions inherited from CAS_PGTStorage_AbstractStorage | |
| __construct ($cas_parent) | |
| The constructor of the class, should be called only by inherited classes. More... | |
| getStorageType () | |
| This virtual method returns an informational string giving the type of storage used by the object (used for debugging purposes). More... | |
| getStorageInfo () | |
| This virtual method returns an informational string giving informations on the parameters of the storage. More... | |
| setErrorMessage ($error_message) | |
| This method sets en error message, which can be read later by PGTStorage::getErrorMessage(). More... | |
| getErrorMessage () | |
| This method returns an error message set by PGTStorage::setErrorMessage(). More... | |
| isInitialized () | |
| This method tells if the storage has already been intialized. More... | |
| init () | |
| This virtual method initializes the object. More... | |
| write ($pgt, $pgt_iou) | |
| This virtual method stores a PGT and its corresponding PGT Iuo. More... | |
| read ($pgt_iou) | |
| This virtual method reads a PGT corresponding to a PGT Iou and deletes the corresponding storage entry. More... | |
Data Fields | |
| $_path | |
| a string telling where PGT's should be stored on the filesystem. More... | |
| Data Fields inherited from CAS_PGTStorage_AbstractStorage | |
| $_error_message | |
| string used to store an error message. More... | |
| $_initialized | |
| a boolean telling if the storage has already been initialized. More... | |
Detailed Description
The CAS_PGTStorage_File class is a class for PGT file storage.
An instance of this class is returned by CAS_Client::SetPGTStorageFile().
The documentation for this class was generated from the following file:
- Services/CAS/lib/CAS/PGTStorage/File.php
