InternalCAS_PGTStorageDb

Functions
	CAS_PGTStorage_Db::_getPdo ()
	This method returns the PDO object to use for database interactions. More...
	CAS_PGTStorage_Db::_getTable ()
	This method returns the table to use when storing/retrieving PGT's. More...
	CAS_PGTStorage_Db::getStorageType ()
	This method returns an informational string giving the type of storage used by the object (used for debugging purposes). More...
	CAS_PGTStorage_Db::getStorageInfo ()
	This method returns an informational string giving informations on the parameters of the storage. More...
	CAS_PGTStorage_Db::__construct ( $cas_parent, $dsn_or_pdo, $username='', $password='', $table='', $driver_options=null)
	The class constructor. More...
	CAS_PGTStorage_Db::init ()
	This method is used to initialize the storage. More...
	CAS_PGTStorage_Db::_setErrorMode ()
	This method will enable the Exception error mode on the PDO object. More...
	CAS_PGTStorage_Db::_resetErrorMode ()
	this method will reset the error mode on the PDO object More...
	CAS_PGTStorage_Db::createTableSql ()
	This method returns the query used to create a pgt storage table. More...
	CAS_PGTStorage_Db::storePgtSql ()
	This method returns the query used to store a pgt. More...
	CAS_PGTStorage_Db::retrievePgtSql ()
	This method returns the query used to retrieve a pgt. More...
	CAS_PGTStorage_Db::deletePgtSql ()
	This method returns the query used to delete a pgt. More...
	CAS_PGTStorage_Db::createTable ()
	This method creates the database table used to store pgt's and pgtiou's. More...
	CAS_PGTStorage_Db::write ($pgt, $pgt_iou)
	This method stores a PGT and its corresponding PGT Iou in the database. More...
	CAS_PGTStorage_Db::read ($pgt_iou)
	This method reads a PGT corresponding to a PGT Iou and deletes the corresponding db entry. More...

Variables
	CAS_PGTStorage_Db::$_pdo
	the PDO object to use for database interactions More...
	CAS_PGTStorage_Db::$_dsn
	database connection options to use when creating a new PDO object More...
	CAS_PGTStorage_Db::$_username
	CAS_PGTStorage_Db::$_password
	CAS_PGTStorage_Db::$_table_options
	CAS_PGTStorage_Db::$_table
	the table to use for storing/retrieving pgt's More...
	CAS_PGTStorage_Db::$_errMode
	attribute that stores the previous error mode for the PDO handle while processing a transaction More...

Detailed Description

Function Documentation

__construct()

CAS_PGTStorage_Db::__construct	(		$cas_parent,
			$dsn_or_pdo,
			$username = '',
			$password = '',
			$table = '',
			$driver_options = null
	)

The class constructor.

Parameters

CAS_Client	$cas_parent	the CAS_Client instance that creates the object.
string	$dsn_or_pdo	a dsn string to use for creating a PDO object or a PDO object
string	$username	the username to use when connecting to the database
string	$password	the password to use when connecting to the database
string	$table	the table to use for storing and retrieving PGT's
string	$driver_options	any driver options to use when connecting to the database

Definition at line 138 of file Db.php.

References $password, $table, CAS_PGT_STORAGE_DB_DEFAULT_TABLE, phpCAS\traceBegin(), and phpCAS\traceEnd().

      {
        phpCAS::traceBegin();
        // call the ancestor's constructor
        parent::__construct($cas_parent);

        // set default values
        if (empty($table)) {
            $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE;
        }
        if (!is_array($driver_options)) {
            $driver_options = array(PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION);
        }

        // store the specified parameters
        if ($dsn_or_pdo instanceof PDO) {
            $this->_pdo = $dsn_or_pdo;
        } else {
            $this->_dsn = $dsn_or_pdo;
            $this->_username = $username;
            $this->_password = $password;
            $this->_driver_options = $driver_options;
        }

        // store the table name
        $this->_table = $table;

        phpCAS::traceEnd();
    }

Here is the call graph for this function:

_getPdo()

CAS_PGTStorage_Db::_getPdo ( )

private

This method returns the PDO object to use for database interactions.

Returns

the PDO object

Definition at line 63 of file Db.php.

References CAS_PGTStorage_Db\$_pdo.

Referenced by CAS_PGTStorage_Db\_resetErrorMode(), CAS_PGTStorage_Db\_setErrorMode(), CAS_PGTStorage_Db\createTable(), CAS_PGTStorage_Db\read(), and CAS_PGTStorage_Db\write().

    {
        return $this->_pdo;
    }

Here is the caller graph for this function:

_getTable()

CAS_PGTStorage_Db::_getTable ( )

private

This method returns the table to use when storing/retrieving PGT's.

Returns

the name of the pgt storage table.

Definition at line 86 of file Db.php.

References CAS_PGTStorage_Db\$_table.

Referenced by CAS_PGTStorage_Db\createTableSql(), CAS_PGTStorage_Db\deletePgtSql(), CAS_PGTStorage_Db\getStorageInfo(), CAS_PGTStorage_Db\retrievePgtSql(), and CAS_PGTStorage_Db\storePgtSql().

    {
        return $this->_table;
    }

Here is the caller graph for this function:

_resetErrorMode()

CAS_PGTStorage_Db::_resetErrorMode ( )

private

this method will reset the error mode on the PDO object

Returns

void

Definition at line 239 of file Db.php.

References $pdo, and CAS_PGTStorage_Db\_getPdo().

Referenced by CAS_PGTStorage_Db\createTable(), CAS_PGTStorage_Db\read(), and CAS_PGTStorage_Db\write().

    {
        // get PDO object and reset the error mode to what it was originally
        $pdo = $this->_getPdo();
        $pdo->setAttribute(PDO::ATTR_ERRMODE, $this->_errMode);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_setErrorMode()

CAS_PGTStorage_Db::_setErrorMode ( )

private

This method will enable the Exception error mode on the PDO object.

Returns

void

Definition at line 226 of file Db.php.

References $pdo, and CAS_PGTStorage_Db\_getPdo().

Referenced by CAS_PGTStorage_Db\createTable(), CAS_PGTStorage_Db\read(), and CAS_PGTStorage_Db\write().

    {
        // get PDO object and enable exception error mode
        $pdo = $this->_getPdo();
        $this->_errMode = $pdo->getAttribute(PDO::ATTR_ERRMODE);
        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createTable()

CAS_PGTStorage_Db::createTable

(

)

This method creates the database table used to store pgt's and pgtiou's.

Returns

void

Definition at line 308 of file Db.php.

References $pdo, $query, CAS_PGTStorage_Db\_getPdo(), CAS_PGTStorage_Db\_resetErrorMode(), CAS_PGTStorage_Db\_setErrorMode(), phpCAS\error(), CAS_PGTStorage_Db\init(), CAS_PGTStorage_AbstractStorage\isInitialized(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();

        // initialize this PGTStorage object if it hasn't been initialized yet
        if (!$this->isInitialized()) {
            $this->init();
        }

        // initialize the PDO object for this method
        $pdo = $this->_getPdo();
        $this->_setErrorMode();

        try {
            $pdo->beginTransaction();

            $query = $pdo->query($this->createTableSQL());
            $query->closeCursor();

            $pdo->commit();
        } catch (PDOException $e) {
            // attempt rolling back the transaction before throwing a phpCAS error
            try {
                $pdo->rollBack();
            } catch (PDOException $e) {
            }
            phpCAS::error('error creating PGT storage table: ' . $e->getMessage());
        }

        // reset the PDO object
        $this->_resetErrorMode();

        phpCAS::traceEnd();
    }

Here is the call graph for this function:

createTableSql()

CAS_PGTStorage_Db::createTableSql ( )

protected

This method returns the query used to create a pgt storage table.

Returns

the create table SQL, no bind params in query

Definition at line 258 of file Db.php.

References CAS_PGTStorage_Db\_getTable().

    {
        return 'CREATE TABLE ' . $this->_getTable()
            . ' (pgt_iou VARCHAR(255) NOT NULL PRIMARY KEY, pgt VARCHAR(255) NOT NULL)';
    }

Here is the call graph for this function:

deletePgtSql()

CAS_PGTStorage_Db::deletePgtSql ( )

protected

This method returns the query used to delete a pgt.

Returns

the delete PGT SQL, :pgt_iou is the only bind param contained in the query

Definition at line 294 of file Db.php.

References CAS_PGTStorage_Db\_getTable().

Referenced by CAS_PGTStorage_Db\read().

    {
        return 'DELETE FROM ' . $this->_getTable() . ' WHERE pgt_iou = :pgt_iou';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStorageInfo()

CAS_PGTStorage_Db::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 113 of file Db.php.

References CAS_PGTStorage_Db\_getTable().

    {
        return 'table=`' . $this->_getTable() . '\'';
    }

Here is the call graph for this function:

getStorageType()

CAS_PGTStorage_Db::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 101 of file Db.php.

    {
        return "db";
    }

init()

CAS_PGTStorage_Db::init

(

)

This method is used to initialize the storage.

Halts on error.

Returns

void

Definition at line 183 of file Db.php.

References phpCAS\error(), init(), CAS_PGTStorage_AbstractStorage\isInitialized(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_PGTStorage_Db\createTable().

    {
        phpCAS::traceBegin();
        // if the storage has already been initialized, return immediatly
        if ($this->isInitialized()) {
            return;
        }

        // initialize the base object
        parent::init();

        // create the PDO object if it doesn't exist already
        if (!($this->_pdo instanceof PDO)) {
            try {
                $this->_pdo = new PDO(
                    $this->_dsn,
                    $this->_username,
                    $this->_password,
                    $this->_driver_options
                );
            } catch (PDOException $e) {
                phpCAS::error('Database connection error: ' . $e->getMessage());
            }
        }

        phpCAS::traceEnd();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

CAS_PGTStorage_Db::read

(

$pgt_iou

)

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

Parameters

string

$pgt_iou

the PGT iou

Returns

the corresponding PGT, or FALSE on error

Definition at line 393 of file Db.php.

References $pdo, $query, CAS_PGTStorage_Db\_getPdo(), CAS_PGTStorage_Db\_resetErrorMode(), CAS_PGTStorage_Db\_setErrorMode(), CAS_PGTStorage_Db\deletePgtSql(), CAS_PGTStorage_Db\retrievePgtSql(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();
        $pgt = false;

        // initialize the PDO object for this method
        $pdo = $this->_getPdo();
        $this->_setErrorMode();

        try {
            $pdo->beginTransaction();

            // fetch the pgt for the specified pgt_iou
            $query = $pdo->prepare($this->retrievePgtSql());
            $query->bindValue(':pgt_iou', $pgt_iou, PDO::PARAM_STR);
            $query->execute();
            $pgt = $query->fetchColumn(0);
            $query->closeCursor();

            // delete the specified pgt_iou from the database
            $query = $pdo->prepare($this->deletePgtSql());
            $query->bindValue(':pgt_iou', $pgt_iou, PDO::PARAM_STR);
            $query->execute();
            $query->closeCursor();

            $pdo->commit();
        } catch (PDOException $e) {
            // attempt rolling back the transaction before throwing a phpCAS error
            try {
                $pdo->rollBack();
            } catch (PDOException $e) {
            }
            phpCAS::trace('error reading PGT from database: ' . $e->getMessage());
        }

        // reset the PDO object
        $this->_resetErrorMode();

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

Here is the call graph for this function:

retrievePgtSql()

CAS_PGTStorage_Db::retrievePgtSql ( )

protected

This method returns the query used to retrieve a pgt.

the first column of the first row should contain the pgt

Returns

the retrieve PGT SQL, :pgt_iou is the only bind param contained in the query

Definition at line 283 of file Db.php.

References CAS_PGTStorage_Db\_getTable().

Referenced by CAS_PGTStorage_Db\read().

    {
        return 'SELECT pgt FROM ' . $this->_getTable() . ' WHERE pgt_iou = :pgt_iou';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

storePgtSql()

CAS_PGTStorage_Db::storePgtSql ( )

protected

This method returns the query used to store a pgt.

Returns

the store PGT SQL, :pgt and :pgt_iou are the bind params contained in the query

Definition at line 270 of file Db.php.

References CAS_PGTStorage_Db\_getTable().

Referenced by CAS_PGTStorage_Db\write().

    {
        return 'INSERT INTO ' . $this->_getTable()
            . ' (pgt_iou, pgt) VALUES (:pgt_iou, :pgt)';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

write()

CAS_PGTStorage_Db::write	(		$pgt,
			$pgt_iou
	)

This method stores a PGT and its corresponding PGT Iou in the database.

Echoes a warning on error.

Parameters

string	$pgt	the PGT
string	$pgt_iou	the PGT iou

Returns

void

Definition at line 352 of file Db.php.

References $pdo, $query, CAS_PGTStorage_Db\_getPdo(), CAS_PGTStorage_Db\_resetErrorMode(), CAS_PGTStorage_Db\_setErrorMode(), phpCAS\error(), CAS_PGTStorage_Db\storePgtSql(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();

        // initialize the PDO object for this method
        $pdo = $this->_getPdo();
        $this->_setErrorMode();

        try {
            $pdo->beginTransaction();

            $query = $pdo->prepare($this->storePgtSql());
            $query->bindValue(':pgt', $pgt, PDO::PARAM_STR);
            $query->bindValue(':pgt_iou', $pgt_iou, PDO::PARAM_STR);
            $query->execute();
            $query->closeCursor();

            $pdo->commit();
        } catch (PDOException $e) {
            // attempt rolling back the transaction before throwing a phpCAS error
            try {
                $pdo->rollBack();
            } catch (PDOException $e) {
            }
            phpCAS::error('error writing PGT to database: ' . $e->getMessage());
        }

        // reset the PDO object
        $this->_resetErrorMode();

        phpCAS::traceEnd();
    }

Here is the call graph for this function:

Variable Documentation

$_dsn

CAS_PGTStorage_Db::$_dsn

private

database connection options to use when creating a new PDO object

Definition at line 71 of file Db.php.

$_errMode

CAS_PGTStorage_Db::$_errMode

private

attribute that stores the previous error mode for the PDO handle while processing a transaction

Definition at line 219 of file Db.php.

$_password

CAS_PGTStorage_Db::$_password

private

Definition at line 73 of file Db.php.

$_pdo

CAS_PGTStorage_Db::$_pdo

private

the PDO object to use for database interactions

Definition at line 56 of file Db.php.

Referenced by CAS_PGTStorage_Db\_getPdo().

$_table

CAS_PGTStorage_Db::$_table

private

the table to use for storing/retrieving pgt's

Definition at line 79 of file Db.php.

Referenced by CAS_PGTStorage_Db\_getTable().

$_table_options

CAS_PGTStorage_Db::$_table_options

private

Definition at line 74 of file Db.php.

$_username

CAS_PGTStorage_Db::$_username

private

Definition at line 72 of file Db.php.