PGTStorageDB Class Reference

The PGTStorageDB class is a class for PGT database storage. More...

Inheritance diagram for PGTStorageDB:

Collaboration diagram for PGTStorageDB:

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...
	PGTStorageDB ($cas_parent, $user, $password, $database_type, $hostname, $port, $database, $table)
	The class constructor, called by CASClient::SetPGTStorageDB(). More...
	init ()
	This method is used to initialize the storage. 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...
	PGTStorageDB ($cas_parent, $user, $password, $database_type, $hostname, $port, $database, $table)
	The class constructor, called by CASClient::SetPGTStorageDB(). More...
	init ()
	This method is used to initialize the storage. 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
	getURL ()
	This method returns the PEAR DB URL to use to connect to the database. More...
	getLink ()
	This method returns the handle of the connection to the database where PGT's are stored. More...
	getTable ()
	This method returns the name of the table where PGT's are stored. More...
	getURL ()
	This method returns the PEAR DB URL to use to connect to the database. More...
	getLink ()
	This method returns the handle of the connection to the database where PGT's are stored. More...
	getTable ()
	This method returns the name of the table where PGT's are stored. More...

Private Attributes
	$_url
	a string representing a PEAR DB URL to connect to the database. More...
	$_link
	The handle of the connection to the database where PGT's are stored. More...
	$_table
	The name of the table where PGT's are stored. 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 PGTStorageDB class is a class for PGT database storage.

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

Author

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

Definition at line 46 of file pgt-db.php.

Member Function Documentation

getLink()

PGTStorageDB::getLink ( )

private

This method returns the handle of the connection to the database where PGT's are stored.

Returns

a handle of connection.

Definition at line 69 of file pgt-db.php.

References $_link, and $_table.

    {
      return $this->_link;
    }

getStorageInfo()

PGTStorageDB::getStorageInfo

(

)

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

(used for debugging purposes).

Definition at line 117 of file pgt-db.php.

    {
      return 'url=`'.$this->getURL().'\', table=`'.$this->getTable().'\'';
    }

getStorageType()

PGTStorageDB::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 106 of file pgt-db.php.

    {
      return "database";
    }

getTable()

PGTStorageDB::getTable ( )

private

This method returns the name of the table where PGT's are stored.

Returns

the name of a table.

Definition at line 90 of file pgt-db.php.

References $_table.

    {
      return $this->_table;
    }

getURL()

PGTStorageDB::getURL ( )

private

This method returns the PEAR DB URL to use to connect to the database.

Returns

a PEAR DB URL

Definition at line 47 of file pgt-db.php.

References $_link, and $_url.

    {
      return $this->_url;
    }

init()

PGTStorageDB::init

(

)

This method is used to initialize the storage.

Halts on error.

Definition at line 169 of file pgt-db.php.

References phpCAS\error(), getURL(), PGTStorage\isInitialized(), and phpCAS\traceBegin().

    {
      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();
      
      // try to connect to the database
      $this->_link = DB::connect($this->getURL());
      if ( DB::isError($this->_link) ) {
        phpCAS::error('could not connect to database ('.DB::errorMessage($this->_link).')');
      }
      var_dump($this->_link);
      phpCAS::traceBEnd();
    }

Here is the call graph for this function:

PGTStorageDB()

PGTStorageDB::PGTStorageDB	(		$cas_parent,
			$user,
			$password,
			$database_type,
			$hostname,
			$port,
			$database,
			$table
	)

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

Parameters

$cas_parent	the CASClient instance that creates the object.
$user	the user to access the data with
$password	the user's password
$database_type	the type of the database hosting the data
$hostname	the server hosting the database
$port	the port the server is listening on
$database	the name of the database
$table	the name of the table storing the data

Definition at line 140 of file pgt-db.php.

References $server, CAS_PGT_STORAGE_DB_DEFAULT_DATABASE, CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE, CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME, CAS_PGT_STORAGE_DB_DEFAULT_PORT, CAS_PGT_STORAGE_DB_DEFAULT_TABLE, PGTStorage\PGTStorage(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
      phpCAS::traceBegin();

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

      if ( empty($database_type) ) $database_type = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE;
      if ( empty($hostname) ) $hostname = CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME;
      if ( $port==0 ) $port = CAS_PGT_STORAGE_DB_DEFAULT_PORT;
      if ( empty($database) ) $database = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE;
      if ( empty($table) ) $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE;

      // build and store the PEAR DB URL
      $this->_url = $database_type.':'.'//'.$user.':'.$password.'@'.$server.':'.$port.'/'.$database;

      // XXX should use setURL and setTable
      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-db.php