PGTStorage Class Reference

The PGTStorage class is a generic class for PGT storage. More...

Inheritance diagram for PGTStorage:

Collaboration diagram for PGTStorage:

Public Member Functions
	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...

Protected Member Functions
	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...

Private Attributes
	$_error_message
	string used to store an error message. More...
	$_initialized
	a boolean telling if the storage has already been initialized. More...

Detailed Description

The PGTStorage class is a generic class for PGT storage.

This class should not be instanciated itself but inherited by specific PGT storage classes.

Author

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

Definition at line 45 of file pgt-main.php.

Member Function Documentation

getErrorMessage()

PGTStorage::getErrorMessage

(

)

This method returns an error message set by PGTStorage::setErrorMessage().

Returns

an error message when set by PGTStorage::setErrorMessage(), FALSE otherwise.

Deprecated:

not used.

Definition at line 108 of file pgt-main.php.

References $_error_message, and $_initialized.

    {
      return $this->_error_message;
    }

getStorageInfo()

PGTStorage::getStorageInfo

(

)

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

(used for debugging purposes).

Definition at line 66 of file pgt-main.php.

References $_error_message, and phpCAS\error().

    {
      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
    }

Here is the call graph for this function:

getStorageType()

PGTStorage::getStorageType

(

)

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

Definition at line 55 of file pgt-main.php.

References phpCAS\error().

    {
      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
    }

Here is the call graph for this function:

init()

PGTStorage::init ( )

protected

This virtual method initializes the object.

Definition at line 143 of file pgt-main.php.

    {
      $this->_initialized = TRUE;
    }

isInitialized()

PGTStorage::isInitialized ( )

protected

This method tells if the storage has already been intialized.

Returns

a boolean

Definition at line 133 of file pgt-main.php.

References $_initialized.

    {
      return $this->_initialized;
    }

PGTStorage()

PGTStorage::PGTStorage (   $cas_parent )

protected

The constructor of the class, should be called only by inherited classes.

Parameters

$cas_parent

the CASclient instance that creates the current object.

Definition at line 36 of file pgt-main.php.

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

    {
      phpCAS::traceBegin();
      if ( !$cas_parent->isProxy() ) {
        phpCAS::error('defining PGT storage makes no sense when not using a CAS proxy'); 
      }
      phpCAS::traceEnd();
    }

Here is the call graph for this function:

read()

PGTStorage::read (   $pgt_iou )

protected

This virtual method reads a PGT corresponding to a PGT Iou and deletes the corresponding storage entry.

Note

Should never be called.

Parameters

$pgt_iou

the PGT iou

Definition at line 175 of file pgt-main.php.

References phpCAS\error().

    {
      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
    }

Here is the call graph for this function:

setErrorMessage()

PGTStorage::setErrorMessage (   $error_message )

protected

This method sets en error message, which can be read later by PGTStorage::getErrorMessage().

Parameters

$error_message

an error message

Deprecated:

not used.

Definition at line 94 of file pgt-main.php.

    {
      $this->_error_message = $error_message;
    }

write()

PGTStorage::write (   $pgt,   $pgt_iou  )

protected

This virtual method stores a PGT and its corresponding PGT Iuo.

Note

Should never be called.

Parameters

$pgt	the PGT
$pgt_iou	the PGT iou

Definition at line 161 of file pgt-main.php.

References phpCAS\error().

    {
      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
    }

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-main.php