ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
PGTStorageFile Class Reference

The PGTStorageFile class is a class for PGT file storage. More...

+ Inheritance diagram for PGTStorageFile:
+ Collaboration diagram for PGTStorageFile:

Public Member Functions

 getStorageType ()
 This method returns an informational string giving the type of storage used by the object (used for debugging purposes).
 getStorageInfo ()
 This method returns an informational string giving informations on the parameters of the storage.
 PGTStorageFile ($cas_parent, $format, $path)
 The class constructor, called by CASClient::SetPGTStorageFile().
 init ()
 This method is used to initialize the storage.
 write ($pgt, $pgt_iou)
 This method stores a PGT and its corresponding PGT Iou into a file.
 read ($pgt_iou)
 This method reads a PGT corresponding to a PGT Iou and deletes the corresponding file.
- Public Member Functions inherited from PGTStorage
 getErrorMessage ()
 This method returns an error message set by PGTStorage::setErrorMessage().

Private Member Functions

 getPath ()
 This method returns the name of the directory where PGT's should be stored on the filesystem.
 getFormat ()
 This method returns the format to use when storing PGT's on the filesystem.
 getPGTIouFilename ($pgt_iou)
 This method returns the filename corresponding to a PGT Iou.

Private Attributes

 $_path
 a string telling where PGT's should be stored on the filesystem.
 $_format
 a string telling the format to use to store PGT's (plain or xml).

Additional Inherited Members

- Protected Member Functions inherited from PGTStorage
 PGTStorage ($cas_parent)
 The constructor of the class, should be called only by inherited classes.
 setErrorMessage ($error_message)
 This method sets en error message, which can be read later by PGTStorage::getErrorMessage().
 isInitialized ()
 This method tells if the storage has already been intialized.

Detailed Description

The PGTStorageFile class is a class for PGT file storage.

An instance of this class is returned by CASClient::SetPGTStorageFile().

Author
Pascal Aubry <pascal.aubry at univ-rennes1.fr>

Definition at line 18 of file pgt-file.php.


The documentation for this class was generated from the following file: