PGT storage on the filesystem

Collaboration diagram for PGT storage on the filesystem:

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

Functions
	PGTStorageFile::getPath ()
	This method returns the name of the directory where PGT's should be stored on the filesystem. More...
	PGTStorageFile::getFormat ()
	This method returns the format to use when storing PGT's on the filesystem. More...
	PGTStorageFile::getStorageType ()
	This method returns an informational string giving the type of storage used by the object (used for debugging purposes). More...
	PGTStorageFile::getStorageInfo ()
	This method returns an informational string giving informations on the parameters of the storage. More...
	PGTStorageFile::PGTStorageFile ($cas_parent, $format, $path)
	The class constructor, called by CASClient::SetPGTStorageFile(). More...
	PGTStorageFile::init ()
	This method is used to initialize the storage. More...
	PGTStorageFile::getPGTIouFilename ($pgt_iou)
	This method returns the filename corresponding to a PGT Iou. More...
	PGTStorageFile::write ($pgt, $pgt_iou)
	This method stores a PGT and its corresponding PGT Iou into a file. More...
	PGTStorageFile::read ($pgt_iou)
	This method reads a PGT corresponding to a PGT Iou and deletes the corresponding file. More...

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

Detailed Description

Function Documentation

getFormat()

PGTStorageFile::getFormat ( )

private

This method returns the format to use when storing PGT's on the filesystem.

Returns

a string corresponding to the format used (plain or xml).

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

References PGTStorageFile\$_format.

Referenced by PGTStorageFile\getPGTIouFilename().

    {
      return $this->_format;
    }

Here is the caller graph for this function:

getPath()

PGTStorageFile::getPath ( )

private

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 pgt-file.php.

References PGTStorageFile\$_path.

Referenced by PGTStorageFile\getPGTIouFilename().

    {
      return $this->_path;
    }

Here is the caller graph for this function:

getPGTIouFilename()

PGTStorageFile::getPGTIouFilename (   $pgt_iou )

private

This method returns the filename corresponding to a PGT Iou.

Parameters

$pgt_iou

the PGT iou.

Returns

a filename

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

References $filename, PGTStorageFile\getFormat(), PGTStorageFile\getPath(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by PGTStorageFile\read(), and PGTStorageFile\write().

    {
      phpCAS::traceBegin();
      $filename = $this->getPath().$pgt_iou.'.'.$this->getFormat();
      phpCAS::traceEnd($filename);
      return $filename;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStorageInfo()

PGTStorageFile::getStorageInfo

(

)

This method returns an informational string giving informations on the parameters of the storage.

(used for debugging purposes).

Returns

an informational string.

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

    {
      return 'path=`'.$this->getPath().'\', format=`'.$this->getFormat().'\'';
    }

getStorageType()

PGTStorageFile::getStorageType

(

)

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

Returns

an informational string.

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

    {
      return "file";
    }

init()

PGTStorageFile::init

(

)

This method is used to initialize the storage.

Halts on error.

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

References PGTStorage\isInitialized(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
      phpCAS::traceBegin();
      // if the storage has already been initialized, return immediatly
      if ( $this->isInitialized() )
        return;
      // call the ancestor's method (mark as initialized)
      parent::init();
      phpCAS::traceEnd();      
    }

Here is the call graph for this function:

PGTStorageFile()

PGTStorageFile::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.

References $path, CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT, CAS_PGT_STORAGE_FILE_DEFAULT_PATH, CAS_PGT_STORAGE_FILE_FORMAT_PLAIN, CAS_PGT_STORAGE_FILE_FORMAT_XML, phpCAS\error(), PGTStorage\PGTStorage(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
      phpCAS::traceBegin();
      // call the ancestor's constructor
      $this->PGTStorage($cas_parent);

      if (empty($format) ) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;
      if (empty($path) ) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;

      // check that the path is an absolute path
      if (getenv("OS")=="Windows_NT"){
        
         if (!preg_match('`^[a-zA-Z]:`', $path)) {
                phpCAS::error('an absolute path is needed for PGT storage to file');
        }
        
      }
      else
      {
      
        if ( $path[0] != '/' ) {
                        phpCAS::error('an absolute path is needed for PGT storage to file');
        }

        // store the path (with a leading and trailing '/')      
        $path = preg_replace('|[/]*$|','/',$path);
        $path = preg_replace('|^[/]*|','/',$path);
      }
      
      $this->_path = $path;
      // check the format and store it
      switch ($format) {
      case CAS_PGT_STORAGE_FILE_FORMAT_PLAIN:
      case CAS_PGT_STORAGE_FILE_FORMAT_XML:
        $this->_format = $format;
        break;
      default:
        phpCAS::error('unknown PGT file storage format (`'.CAS_PGT_STORAGE_FILE_FORMAT_PLAIN.'\' and `'.CAS_PGT_STORAGE_FILE_FORMAT_XML.'\' allowed)');
      }
      phpCAS::traceEnd();      
    }

Here is the call graph for this function:

read()

PGTStorageFile::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

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

References PGTStorageFile\getPGTIouFilename(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
      phpCAS::traceBegin();
      $pgt = FALSE;
      $fname = $this->getPGTIouFilename($pgt_iou);
      if ( !($f=fopen($fname,"r")) ) {
        phpCAS::trace('could not open `'.$fname.'\'');
      } else {
        if ( ($pgt=fgets($f)) === FALSE ) {
          phpCAS::trace('could not read PGT from `'.$fname.'\'');
        } 
        fclose($f);
      }

      // delete the PGT file
      @unlink($fname);

      phpCAS::traceEnd($pgt);
      return $pgt;
    }

Here is the call graph for this function:

write()

PGTStorageFile::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

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

References phpCAS\error(), PGTStorageFile\getPGTIouFilename(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
      phpCAS::traceBegin();
      $fname = $this->getPGTIouFilename($pgt_iou);
      if ( $f=fopen($fname,"w") ) {
        if ( fputs($f,$pgt) === FALSE ) {
          phpCAS::error('could not write PGT to `'.$fname.'\'');
        }
        fclose($f);
      } else {
        phpCAS::error('could not open `'.$fname.'\'');
      }
      phpCAS::traceEnd();      
    }

Here is the call graph for this function:

Variable Documentation

$_format

PGTStorageFile::$_format

private

a string telling the format to use to store PGT's (plain or xml).

Written by PGTStorageFile::PGTStorageFile(), read by getFormat().

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

Referenced by PGTStorageFile\getFormat(), and PGTStorageFile\getPath().

$_path

PGTStorageFile::$_path

private

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 pgt-file.php.

Referenced by PGTStorageFile\getPath().