Public Member Functions |
Protected Member Functions |
Private Member Functions |
Private Attributes
CAS_PGTStorage_Db Class Reference
Basic class for PGT database storage The CAS_PGTStorage_Db class is a class for PGT database storage. More...
Inheritance diagram for CAS_PGTStorage_Db:
Collaboration diagram for CAS_PGTStorage_Db:
Public Member Functions | |
| 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, $dsn_or_pdo, $username='', $password='', $table='', $driver_options=null) | |
| The class constructor. More... | |
| init () | |
| This method is used to initialize the storage. More... | |
| createTable () | |
| This method creates the database table used to store pgt's and pgtiou's. More... | |
| write ($pgt, $pgt_iou) | |
| This method stores a PGT and its corresponding PGT Iou in the database. More... | |
| read ($pgt_iou) | |
| This method reads a PGT corresponding to a PGT Iou and deletes the corresponding db entry. 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... | |
Protected Member Functions | |
| createTableSql () | |
| This method returns the query used to create a pgt storage table. More... | |
| storePgtSql () | |
| This method returns the query used to store a pgt. More... | |
| retrievePgtSql () | |
| This method returns the query used to retrieve a pgt. More... | |
| deletePgtSql () | |
| This method returns the query used to delete a pgt. More... | |
Private Member Functions | |
| _getPdo () | |
| This method returns the PDO object to use for database interactions. More... | |
| _getTable () | |
| This method returns the table to use when storing/retrieving PGT's. More... | |
| _setErrorMode () | |
| This method will enable the Exception error mode on the PDO object. More... | |
| _resetErrorMode () | |
| this method will reset the error mode on the PDO object More... | |
Private Attributes | |
| $_pdo | |
| the PDO object to use for database interactions More... | |
| $_dsn | |
| database connection options to use when creating a new PDO object More... | |
| $_username | |
| $_password | |
| $_table_options | |
| $_table | |
| the table to use for storing/retrieving pgt's More... | |
| $_errMode | |
| attribute that stores the previous error mode for the PDO handle while processing a transaction More... | |
Additional Inherited Members | |
| 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
Basic class for PGT database storage The CAS_PGTStorage_Db class is a class for PGT database storage.
The documentation for this class was generated from the following file:
- Services/CAS/lib/CAS/PGTStorage/Db.php
