PGT storage on the filesystem

Collaboration diagram for PGT storage on the filesystem:

Data Structures
class	PGTStorageFile
Functions
	getStorageType ()
	getStorageInfo ()
	PGTStorageFile ($cas_parent, $format, $path)
	init ()
	write ($pgt, $pgt_iou)
	read ($pgt_iou)

---

Function Documentation

getStorageInfo

(

)

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

Returns:

an informational string.

Reimplemented from PGTStorage.

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

getStorageType

(

)

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 PGTStorage.

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

init

(

)

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

Reimplemented from PGTStorage.

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

Here is the call graph for this function:

PGTStorageFile	(	$	cas_parent,
		$	format,
		$	path
	)

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

Parameters:

$cas_parent	the CASClient instance that creates the object.
$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 134 of file pgt-file.php.

Here is the call graph for this function:

read

(

$

pgt_iou

)

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 PGTStorage.

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

Here is the call graph for this function:

write	(	$	pgt,
		$	pgt_iou
	)

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 PGTStorage.

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

Here is the call graph for this function: