PDODriverTrait.php

<?php
/**
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP(tm) Project
 * @since         3.0.0
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Database\Driver;

use Cake\Database\Statement\PDOStatement;
use PDO;

/**
 * PDO driver trait
 */
trait PDODriverTrait {

/**
 * Instance of PDO.
 *
 * @var \PDO
 */
	protected $_connection;

/**
 * Establishes a connection to the database server
 *
 * @param string $dsn A Driver-specific PDO-DSN
 * @param array $config configuration to be used for creating connection
 * @return bool true on success
 */
	protected function _connect($dsn, array $config) {
		$connection = new PDO(
			$dsn,
			$config['username'],
			$config['password'],
			$config['flags']
		);
		$this->connection($connection);
		return true;
	}

/**
 * Returns correct connection resource or object that is internally used
 * If first argument is passed, it will set internal connection object or
 * result to the value passed
 *
 * @param null|\PDO $connection The PDO connection instance.
 * @return mixed connection object used internally
 */
	public function connection($connection = null) {
		if ($connection !== null) {
			$this->_connection = $connection;
		}
		return $this->_connection;
	}

/**
 * Disconnects from database server
 *
 * @return void
 */
	public function disconnect() {
		$this->_connection = null;
	}

/**
 * Prepares a sql statement to be executed
 *
 * @param string|\Cake\Database\Query $query The query to turn into a prepared statement.
 * @return \Cake\Database\StatementInterface
 */
	public function prepare($query) {
		$this->connect();
		$statement = $this->_connection->prepare((string)$query);
		return new PDOStatement($statement, $this);
	}

/**
 * Starts a transaction
 *
 * @return bool true on success, false otherwise
 */
	public function beginTransaction() {
		$this->connect();
		if ($this->_connection->inTransaction()) {
			return true;
		}
		return $this->_connection->beginTransaction();
	}

/**
 * Commits a transaction
 *
 * @return bool true on success, false otherwise
 */
	public function commitTransaction() {
		$this->connect();
		if (!$this->_connection->inTransaction()) {
			return false;
		}
		return $this->_connection->commit();
	}

/**
 * Rollsback a transaction
 *
 * @return bool true on success, false otherwise
 */
	public function rollbackTransaction() {
		if (!$this->_connection->inTransaction()) {
			return false;
		}
		return $this->_connection->rollback();
	}

/**
 * Returns a value in a safe representation to be used in a query string
 *
 * @param mixed $value The value to quote.
 * @param string $type Type to be used for determining kind of quoting to perform
 * @return string
 */
	public function quote($value, $type) {
		$this->connect();
		return $this->_connection->quote($value, $type);
	}

/**
 * Returns last id generated for a table or sequence in database
 *
 * @param string $table table name or sequence to get last insert value from
 * @param string $column the name of the column representing the primary key
 * @return string|int
 */
	public function lastInsertId($table = null, $column = null) {
		$this->connect();
		return $this->_connection->lastInsertId($table);
	}

/**
 * Checks if the driver supports quoting, as PDO_ODBC does not support it.
 *
 * @return bool
 */
	public function supportsQuoting() {
		$this->connect();
		return $this->_connection->getAttribute(PDO::ATTR_DRIVER_NAME) !== 'odbc';
	}

}