CO_PDO Class Reference

This class provides a genericized interface to the PHP PDO toolkit. More...

Collaboration diagram for CO_PDO:

Public Member Functions
	__construct ( $driver, $host, $database, $user=NULL, $password=NULL, $charset=NULL)
	Initializes connection param class members. More...
	preparedExec ( $sql, $params=array())
	Wrapper for preparing and executing a PDOStatement that does not return a resultset e.g. INSERT or UPDATE SQL statements. More...
	preparedQuery ( $sql, $params=array(), $fetchKeyPair=false)
	Wrapper for preparing and executing a PDOStatement that returns a resultset e.g. SELECT SQL statements. More...

Public Attributes
	$driver_type = NULL
	The type of PDO driver we are configured for. More...
	$class_description = NULL
	A simple description of this class. More...
	$last_insert = NULL
	This holds the integer ID of the last AUTO_INCREMENT insert. More...
	$owner_instance = NULL
	This is the instance of A_CO_DB that "owns" this instance. We can use this for auditing. More...

Private Attributes
	$_pdo = NULL
	Internal PDO object. More...
	$fetchMode = PDO::FETCH_ASSOC
	Default fetch mode for internal PDOStatements. More...

Detailed Description

This class provides a genericized interface to the PHP PDO toolkit.

Definition at line 32 of file co_pdo.class.php.

Constructor & Destructor Documentation

__construct()

CO_PDO::__construct	(		$driver,
			$host,
			$database,
			$user = NULL,
			$password = NULL,
			$charset = NULL
	)

Initializes connection param class members.

Must be called BEFORE any attempts to connect to or query a database.

Will destroy previous connection (if one exists).

Parameters

$driver	database server type (ex: 'mysql')
$host	database server host
$database	database name
$user	user, optional
$password	password, optional
$charset	connection charset, optional

Definition at line 56 of file co_pdo.class.php.

                                  {
        
        $this->class_description = 'A class for managing PDO access to the databases.';
 
        $this->_pdo = NULL;
        $this->driver_type = $driver;
        $this->last_insert = NULL;
        
        $dsn = $driver . ':host=' . $host . ';dbname=' . $database ;
        try {
            $this->_pdo = new PDO($dsn, $user, $password, array(PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES 'utf8'"));
            $this->_pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
            $this->_pdo->setAttribute(PDO::ATTR_CASE, PDO::CASE_LOWER);
            $this->_pdo->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
            if (strlen($charset) > 0) {
                self::preparedExec('SET NAMES :charset', array(':charset' => $charset), false);
            }
        } catch (PDOException $exception) {
            throw new Exception(__METHOD__ . '() ' . $exception->getMessage());
        }
    }

Member Function Documentation

preparedExec()

CO_PDO::preparedExec	(		$sql,
			$params = array()
	)

Wrapper for preparing and executing a PDOStatement that does not return a resultset e.g. INSERT or UPDATE SQL statements.

See PDO documentation about prepared queries.

If there isn't already a database connection, it will "lazy load" the connection.

Exceptions

Exception

thrown if internal PDO exception is thrown

Returns

true if execution is successful.

Parameters

$sql	same as kind provided to PDO::prepare()
$params	same as kind provided to PDO::prepare()

Definition at line 96 of file co_pdo.class.php.

    {
        $this->last_insert = NULL;
        try {
            if ('pgsql' == $this->driver_type) {
                if (strpos($sql, 'RETURNING id;')) {
                    $response = $this->preparedQuery($sql, $params);
                    $this->last_insert = intval($response[0]['id']);
                    return true;
                }
            }
            
            $sql = str_replace(' RETURNING id', '', $sql);
            // This represents a potential MASSIVE security, performnce and legal issue. This should ONLY be used for debugging!
            if (method_exists('CO_Config', 'call_low_level_log_handler_function')) {
                CO_Config::call_low_level_log_handler_function(isset($this->owner_instance) ? $this->owner_instance->access_object->get_login_id() : 0, $sql, $params);
            }
            $this->_pdo->beginTransaction(); 
            $stmt = $this->_pdo->prepare($sql);
            $stmt->execute($params);
            if ('pgsql' != $this->driver_type) {
                $this->last_insert = $this->_pdo->lastInsertId();
            }
            $this->_pdo->commit();
        
            return true;
        } catch (PDOException $exception) {
            $this->last_insert = NULL;
            $this->_pdo->rollback();
            throw new Exception(__METHOD__ . '() ' . $exception->getMessage());
        }
        
        return false;
    }

preparedQuery()

CO_PDO::preparedQuery	(		$sql,
			$params = array(),
			$fetchKeyPair = false
	)

Wrapper for preparing and executing a PDOStatement that returns a resultset e.g. SELECT SQL statements.

Returns a multidimensional array depending on internal fetch mode setting ($this->fetchMode) See PDO documentation about prepared queries.

Fetching key pairs- when $fetchKeyPair is set to true, it will force the returned array to be a one-dimensional array indexed on the first column in the query. Note- query may contain only two columns or an exception/error is thrown. See PDO::PDO::FETCH_KEY_PAIR for more details

Returns

associative array of results.

Exceptions

Exception

thrown if internal PDO exception is thrown

Parameters

$sql	same as kind provided to PDO::prepare()
$params	same as kind provided to PDO::prepare()
$fetchKeyPair	See description in method documentation

Definition at line 149 of file co_pdo.class.php.

                                  {
        $this->last_insert = NULL;
        try {
            // This represents a potential MASSIVE security, performnce and legal issue. This should ONLY be used for debugging!
            if (method_exists('CO_Config', 'call_low_level_log_handler_function')) {
                CO_Config::call_low_level_log_handler_function(isset($this->owner_instance) ? $this->owner_instance->access_object->get_login_id() : 0, $sql, $params);
            }
            $this->_pdo->beginTransaction(); 
            $stmt = $this->_pdo->prepare($sql);
            $stmt->setFetchMode($this->fetchMode);
            $stmt->execute($params);
            $this->_pdo->commit();
            
            $ret = NULL;
            
            if ($fetchKeyPair) {
                $ret = $stmt->fetchAll(PDO::FETCH_KEY_PAIR);
            } else {
                $ret = $stmt->fetchAll();
            }
            
            return $ret;
        } catch (PDOException $exception) {
            $this->last_insert = NULL;
            $this->_pdo->rollback();
            throw new Exception(__METHOD__ . '() ' . $exception->getMessage());
        }
        
        return false;
    }

Member Data Documentation

$_pdo

CO_PDO::$_pdo = NULL

private

Internal PDO object.

Definition at line 34 of file co_pdo.class.php.

$class_description

CO_PDO::$class_description = NULL

A simple description of this class.

Definition at line 38 of file co_pdo.class.php.

$driver_type

CO_PDO::$driver_type = NULL

The type of PDO driver we are configured for.

Definition at line 36 of file co_pdo.class.php.

$fetchMode

CO_PDO::$fetchMode = PDO::FETCH_ASSOC

private

Default fetch mode for internal PDOStatements.

Definition at line 45 of file co_pdo.class.php.

$last_insert

CO_PDO::$last_insert = NULL

This holds the integer ID of the last AUTO_INCREMENT insert.

Definition at line 40 of file co_pdo.class.php.

$owner_instance

CO_PDO::$owner_instance = NULL

This is the instance of A_CO_DB that "owns" this instance. We can use this for auditing.

Definition at line 42 of file co_pdo.class.php.