cakephp/src/Database/Driver.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       MIT License (http://www.opensource.org/licenses/mit-license.php)
 */
namespace Cake\Database;

use Cake\Database\Query;
use Cake\Database\QueryCompiler;
use Cake\Database\ValueBinder;

/**
 * Represents a database diver containing all specificities for
 * a database engine including its SQL dialect
 *
 */
abstract class Driver {

/**
 * Configuration data.
 *
 * @var array
 */
	protected $_config;

/**
 * Base configuration that is merged into the user
 * supplied configuration data.
 *
 * @var array
 */
	protected $_baseConfig = [];

/**
 * Indicates whether or not the driver is doing automatic identifier quoting
 * for all queries
 *
 * @var bool
 */
	protected $_autoQuoting = false;

/**
 * Constructor
 *
 * @param array $config The configuration for the driver.
 */
	public function __construct($config = []) {
		$config += $this->_baseConfig;
		$this->_config = $config;
		if (!empty($config['quoteIdentifiers'])) {
			$this->autoQuoting(true);
		}
	}

/**
 * Establishes a connection to the database server
 *
 * @return boolean true con success
 */
	public abstract function connect();

/**
 * Disconnects from database server
 *
 * @return void
 */
	public abstract function disconnect();

/**
 * Returns correct connection resource or object that is internally used
 * If first argument is passed,
 *
 * @param null|\PDO instance $connection
 * @return void
 */
	public abstract function connection($connection = null);

/**
 * Returns whether php is able to use this driver for connecting to database
 *
 * @return boolean true if it is valid to use this driver
 */
	public abstract function enabled();

/**
 * Prepares a sql statement to be executed
 *
 * @param string|\Cake\Database\Query $query
 * @return \Cake\Database\StatementInterface
 */
	public abstract function prepare($query);

/**
 * Starts a transaction
 *
 * @return boolean true on success, false otherwise
 */
	public abstract function beginTransaction();

/**
 * Commits a transaction
 *
 * @return boolean true on success, false otherwise
 */
	public abstract function commitTransaction();

/**
 * Rollsback a transaction
 *
 * @return boolean true on success, false otherwise
 */
	public abstract function rollbackTransaction();

/**
 * Returns whether this driver supports save points for nested transactions
 *
 * @return boolean true if save points are supported, false otherwise
 */
	public function supportsSavePoints() {
		return true;
	}

/**
 * Returns a value in a safe representation to be used in a query string
 *
 * @param mixed $value
 * @param string $type Type to be used for determining kind of quoting to perform
 * @return string
 */
	public abstract function quote($value, $type);

/**
 * Checks if the driver supports quoting
 *
 * @return boolean
 */
	public function supportsQuoting() {
		return true;
	}

/**
 * Returns a callable function that will be used to transform a passed Query object.
 * This function, in turn, will return an instance of a Query object that has been
 * transformed to accommodate any specificities of the SQL dialect in use.
 *
 * @param string $type the type of query to be transformed
 * (select, insert, update, delete)
 * @return callable
 */
	public abstract function queryTranslator($type);

/**
 * Get the schema dialect.
 *
 * Used by Cake\Database\Schema package to reflect schema and
 * generate schema.
 *
 * If all the tables that use this Driver specify their
 * own schemas, then this may return null.
 *
 * @return \Cake\Database\Schema\BaseSchema
 */
	public abstract function schemaDialect();

/**
 * Quotes a database identifier (a column name, table name, etc..) to
 * be used safely in queries without the risk of using reserved words
 *
 * @param string $identifier
 * @return string
 */
	public abstract function quoteIdentifier($identifier);

/**
 * Escapes values for use in schema definitions.
 *
 * @param mixed $value The value to escape.
 * @return string String for use in schema definitions.
 */
	public function schemaValue($value) {
		if ($value === null) {
			return 'NULL';
		}
		if ($value === false) {
			return 'FALSE';
		}
		if ($value === true) {
			return 'TRUE';
		}
		if (is_float($value)) {
			return str_replace(',', '.', strval($value));
		}
		if ((is_int($value) || $value === '0') || (
			is_numeric($value) && strpos($value, ',') === false &&
			$value[0] != '0' && strpos($value, 'e') === false)
		) {
			return $value;
		}
		return $this->_connection->quote($value, \PDO::PARAM_STR);
	}

/**
 * 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|integer
 */
	public function lastInsertId($table = null, $column = null) {
		return $this->_connection->lastInsertId($table, $column);
	}

/**
 * Check whether or not the driver is connected.
 *
 * @return boolean
 */
	public function isConnected() {
		return $this->_connection !== null;
	}

/**
 * Returns whether or not this driver should automatically quote identifiers
 * in queries
 *
 * If called with a boolean argument, it will toggle the auto quoting setting
 * to the passed value
 *
 * @param boolean $enable whether to enable auto quoting
 * @return boolean
 */
	public function autoQuoting($enable = null) {
		if ($enable === null) {
			return $this->_autoQuoting;
		}
		return $this->_autoQuoting = (bool)$enable;
	}

/**
 * Transforms the passed query to this Driver's dialect and returns an instance
 * of the transformed query and the full compiled SQL string
 *
 * @return array containing 2 entries. The first enty is the transformed query
 * and the secod one the compiled SQL
 */
	public function compileQuery(Query $query, ValueBinder $generator) {
		$processor = $this->newCompiler();
		$translator = $this->queryTranslator($query->type());
		$query = $translator($query);
		return [$query, $processor->compile($query, $generator)];
	}

/**
 * Returns an instance of a QueryCompiler
 *
 * @return \Cake\Database\QueryCompiler
 */
	public function newCompiler() {
		return new QueryCompiler;
	}

/**
 * Destructor
 */
	public function __destruct() {
		$this->_connection = null;
	}

}