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). More...
	getStorageInfo ()
	This method returns an informational string giving informations on the parameters of the storage. More...
	PGTStorageFile ($cas_parent, $format, $path)
	The class constructor, called by CASClient::SetPGTStorageFile(). More...
	init ()
	This method is used to initialize the storage. 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...
	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...
	PGTStorageFile ($cas_parent, $format, $path)
	The class constructor, called by CASClient::SetPGTStorageFile(). More...
	init ()
	This method is used to initialize the storage. 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 PGTStorage
	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...
	getErrorMessage ()
	This method returns an error message set by PGTStorage::setErrorMessage(). 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...
	getErrorMessage ()
	This method returns an error message set by PGTStorage::setErrorMessage(). More...

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

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

Additional Inherited Members
Protected Member Functions inherited from PGTStorage
	PGTStorage ($cas_parent)
	The constructor of the class, should be called only by inherited classes. More...
	setErrorMessage ($error_message)
	This method sets en error message, which can be read later by PGTStorage::getErrorMessage(). 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...
	PGTStorage ($cas_parent)
	The constructor of the class, should be called only by inherited classes. More...
	setErrorMessage ($error_message)
	This method sets en error message, which can be read later by PGTStorage::getErrorMessage(). 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...

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

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

References $_format.

    {
      return $this->_format;
    }

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

References $_format, and $_path.

    {
      return $this->_path;
    }

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

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

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

Here is the call 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 89 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 77 of file pgt-file.php.

    {
      return "file";
    }

init()

PGTStorageFile::init

(

)

This method is used to initialize the storage.

Halts on error.

Definition at line 147 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 107 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 ( $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 211 of file pgt-file.php.

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

References phpCAS\error(), 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:

---

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

• Services/CAS/lib/CAS/PGTStorage/pgt-file.php