1
0
mirror of synced 2024-12-14 23:26:04 +03:00
doctrine2/lib/Doctrine/Db.php

538 lines
16 KiB
PHP
Raw Normal View History

2006-05-30 12:42:10 +04:00
<?php
2006-08-23 00:14:29 +04:00
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Db
* A thin wrapper layer on top of PDO / Doctrine_Adapter
*
* The purpose of this class is to provide an easy to use, pluggable eventlistener
* architecture to database handler object
*
* Aspects such as logging, query profiling and caching can be easily implemented through
* the use of these listeners
*
2006-11-12 15:14:08 +03:00
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db implements Countable, IteratorAggregate, Doctrine_Adapter_Interface {
/**
* error constants
*/
const ERR = -1;
const ERR_SYNTAX = -2;
const ERR_CONSTRAINT = -3;
const ERR_NOT_FOUND = -4;
const ERR_ALREADY_EXISTS = -5;
const ERR_UNSUPPORTED = -6;
const ERR_MISMATCH = -7;
const ERR_INVALID = -8;
const ERR_NOT_CAPABLE = -9;
const ERR_TRUNCATED = -10;
const ERR_INVALID_NUMBER = -11;
const ERR_INVALID_DATE = -12;
const ERR_DIVZERO = -13;
const ERR_NODBSELECTED = -14;
const ERR_CANNOT_CREATE = -15;
const ERR_CANNOT_DELETE = -16;
const ERR_CANNOT_DROP = -17;
const ERR_NOSUCHTABLE = -18;
const ERR_NOSUCHFIELD = -19;
const ERR_NEED_MORE_DATA = -20;
const ERR_NOT_LOCKED = -21;
const ERR_VALUE_COUNT_ON_ROW = -22;
const ERR_INVALID_DSN = -23;
const ERR_CONNECT_FAILED = -24;
const ERR_EXTENSION_NOT_FOUND = -25;
const ERR_NOSUCHDB = -26;
const ERR_ACCESS_VIOLATION = -27;
const ERR_CANNOT_REPLACE = -28;
const ERR_CONSTRAINT_NOT_NULL = -29;
const ERR_DEADLOCK = -30;
const ERR_CANNOT_ALTER = -31;
const ERR_MANAGER = -32;
const ERR_MANAGER_PARSE = -33;
const ERR_LOADMODULE = -34;
const ERR_INSUFFICIENT_DATA = -35;
/**
* @var array $instances all the instances of this class
*/
protected static $instances = array();
2006-05-30 12:42:10 +04:00
/**
* @var array $isConnected whether or not a connection has been established
2006-05-30 12:42:10 +04:00
*/
protected $isConnected = false;
2006-05-30 12:42:10 +04:00
/**
* @var PDO $dbh the database handler
2006-05-30 12:42:10 +04:00
*/
protected $dbh;
2006-05-30 12:42:10 +04:00
/**
* @var array $options
2006-05-30 12:42:10 +04:00
*/
protected $options = array('dsn' => null,
'username' => null,
'password' => null,
);
/**
* @var Doctrine_Db_EventListener_Interface|Doctrine_Overloadable $listener
* listener for listening events
*/
protected $listener;
/**
* @var integer $querySequence
*/
protected $querySequence = 0;
private static $driverMap = array('oracle' => 'oci8',
'postgres' => 'pgsql',
'oci' => 'oci8',
'sqlite2' => 'sqlite',
'sqlite3' => 'sqlite');
2006-05-30 12:42:10 +04:00
/**
* constructor
*
* @param string $dsn data source name
* @param string $user database username
* @param string $pass database password
2006-05-30 12:42:10 +04:00
*/
public function __construct($dsn, $user, $pass) {
if( ! isset($user)) {
$a = self::parseDSN($dsn);
extract($a);
}
$this->options['dsn'] = $dsn;
$this->options['username'] = $user;
$this->options['password'] = $pass;
$this->listener = new Doctrine_Db_EventListener();
2006-05-30 12:42:10 +04:00
}
public function nextQuerySequence() {
return ++$this->querySequence;
}
/**
* getQuerySequence
*/
public function getQuerySequence() {
return $this->querySequence;
}
/**
* getDBH
*/
public function getDBH() {
return $this->dbh;
}
public function getOption($name) {
if( ! array_key_exists($name, $this->options))
throw new Doctrine_Db_Exception('Unknown option ' . $name);
2006-05-30 12:42:10 +04:00
return $this->options[$name];
2006-05-30 12:42:10 +04:00
}
/**
* addListener
*
* @param Doctrine_Db_EventListener_Interface|Doctrine_Overloadable $listener
* @return Doctrine_Db
*/
public function addListener($listener, $name = null) {
if( ! ($this->listener instanceof Doctrine_Db_EventListener_Chain))
$this->listener = new Doctrine_Db_EventListener_Chain();
2006-05-30 12:42:10 +04:00
$this->listener->add($listener, $name);
return $this;
}
/**
* getListener
*
* @return Doctrine_Db_EventListener_Interface|Doctrine_Overloadable
*/
public function getListener() {
return $this->listener;
}
2006-05-30 12:42:10 +04:00
/**
* setListener
*
* @param Doctrine_Db_EventListener_Interface|Doctrine_Overloadable $listener
* @return Doctrine_Db
2006-05-30 12:42:10 +04:00
*/
public function setListener($listener) {
if( ! ($listener instanceof Doctrine_Db_EventListener_Interface) &&
! ($listener instanceof Doctrine_Overloadable))
throw new Doctrine_Db_Exception("Couldn't set eventlistener for database handler. EventListeners should implement either Doctrine_Db_EventListener_Interface or Doctrine_Overloadable");
2006-05-30 12:42:10 +04:00
$this->listener = $listener;
2006-05-30 12:42:10 +04:00
return $this;
}
/**
* connect
* connects into database
*
* @return boolean
*/
public function connect() {
if($this->isConnected)
return false;
$this->dbh = new PDO($this->options['dsn'], $this->options['username'], $this->options['password']);
$this->dbh->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
$this->dbh->setAttribute(PDO::ATTR_STATEMENT_CLASS, array("Doctrine_Db_Statement", array($this)));
$this->isConnected = true;
return true;
}
/**
* getConnection
*
* @param string $dsn PEAR::DB like DSN or PDO like DSN
* format for PEAR::DB like DSN: schema://user:password@address/dbname
*
* @return
*/
public static function getConnection($dsn = null, $username = null, $password = null) {
return new self($dsn, $username, $password);
}
/**
* driverName
* converts a driver name like (oracle) to appropriate PDO
* driver name (oci8 in the case of oracle)
*
* @param string $name
* @return string
*/
public static function driverName($name) {
if(isset(self::$driverMap[$name]))
return self::$driverMap[$name];
2006-05-30 12:42:10 +04:00
return $name;
}
/**
* parseDSN
*
* @param string $dsn
* @return array Parsed contents of DSN
*/
function parseDSN($dsn) {
// silence any warnings
$parts = @parse_url($dsn);
$names = array('scheme', 'host', 'port', 'user', 'pass', 'path', 'query', 'fragment');
foreach($names as $name) {
if( ! isset($parts[$name]))
$parts[$name] = null;
2006-05-30 12:42:10 +04:00
}
if(count($parts) == 0 || ! isset($parts['scheme']))
throw new Doctrine_Db_Exception('Empty data source name');
$drivers = self::getAvailableDrivers();
$parts['scheme'] = self::driverName($parts['scheme']);
if( ! in_array($parts['scheme'], $drivers))
throw new Doctrine_Db_Exception('Driver '.$parts['scheme'].' not availible or extension not loaded');
switch($parts['scheme']) {
case 'sqlite':
if(isset($parts['host']) && $parts['host'] == ':memory') {
$parts['database'] = ':memory:';
$parts['dsn'] = 'sqlite::memory:';
}
break;
case 'mysql':
case 'informix':
case 'oci8':
case 'mssql':
case 'firebird':
case 'pgsql':
case 'odbc':
if( ! isset($parts['path']) || $parts['path'] == '/')
throw new Doctrine_Db_Exception('No database availible in data source name');
if(isset($parts['path']))
$parts['database'] = substr($parts['path'], 1);
if( ! isset($parts['host']))
throw new Doctrine_Db_Exception('No hostname set in data source name');
$parts['dsn'] = $parts["scheme"].":host=".$parts["host"].";dbname=".$parts["database"];
break;
default:
throw new Doctrine_Db_Exception('Unknown driver '.$parts['scheme']);
}
return $parts;
}
/**
* clear
* clears all instances from the memory
*
* @return void
*/
public static function clear() {
self::$instances = array();
}
/**
* errorCode
* Fetch the SQLSTATE associated with the last operation on the database handle
*
* @return integer
*/
public function errorCode() {
return $this->dbh->errorCode();
2006-05-30 12:42:10 +04:00
}
/**
* errorInfo
* Fetch extended error information associated with the last operation on the database handle
*
* @return array
2006-05-30 12:42:10 +04:00
*/
public function errorInfo() {
return $this->dbh->errorInfo();
}
/**
* prepare
*
* @param string $statement
*/
public function prepare($statement) {
$this->connect();
2006-05-30 12:42:10 +04:00
$event = new Doctrine_Db_Event($this, Doctrine_Db_Event::PREPARE, $statement);
2006-05-30 12:42:10 +04:00
$this->listener->onPrePrepare($event);
$stmt = $this->dbh->prepare($statement);
$this->listener->onPrepare($event);
$this->querySequence++;
return $stmt;
}
/**
* query
*
* @param string $statement
* @param array $params
* @return Doctrine_Db_Statement|boolean
*/
public function query($statement, array $params = array()) {
$this->connect();
$event = new Doctrine_Db_Event($this, Doctrine_Db_Event::QUERY, $statement);
$this->listener->onPreQuery($event);
if( ! empty($params))
$stmt = $this->dbh->query($statement)->execute($params);
else
$stmt = $this->dbh->query($statement);
$this->listener->onQuery($event);
$this->querySequence++;
return $stmt;
2006-05-30 12:42:10 +04:00
}
/**
* quote
* quotes a string for use in a query
*
* @param string $input
* @return string
2006-05-30 12:42:10 +04:00
*/
public function quote($input) {
$this->connect();
2006-06-01 15:58:05 +04:00
return $this->dbh->quote($input);
2006-05-30 12:42:10 +04:00
}
/**
* exec
* executes an SQL statement and returns the number of affected rows
*
* @param string $statement
* @return integer
*/
public function exec($statement) {
$this->connect();
$args = func_get_args();
$event = new Doctrine_Db_Event($this, Doctrine_Db_Event::EXEC, $statement);
$this->listener->onPreExec($event);
$rows = $this->dbh->exec($statement);
$this->listener->onExec($event);
return $rows;
}
/**
* fetchAll
*
* @return array
*/
public function fetchAll($statement, array $params = array()) {
return $this->query($statement, $params)->fetchAll(PDO::FETCH_ASSOC);
}
public function fetchOne($statement, array $params = array()) {
return current($this->query($statement, $params)->fetch(PDO::FETCH_NUM));
}
public function fetchRow($statement, array $params = array()) {
return $this->query($statement, $params)->fetch(PDO::FETCH_ASSOC);
}
public function fetchArray($statement, array $params = array()) {
return $this->query($statement, $params)->fetch(PDO::FETCH_NUM);
}
public function fetchColumn($statement, array $params = array()) {
return $this->query($statement, $params)->fetchAll(PDO::FETCH_COLUMN);
}
public function fetchAssoc($statement, array $params = array()) {
return $this->query($statement, $params)->fetchAll(PDO::FETCH_ASSOC);
}
public function fetchBoth($statement, array $params = array()) {
return $this->query($statement, $params)->fetchAll(PDO::FETCH_BOTH);
}
/**
* lastInsertId
*
* @return integer
2006-05-30 12:42:10 +04:00
*/
public function lastInsertId() {
$this->connect();
return $this->dbh->lastInsertId();
2006-05-30 12:42:10 +04:00
}
/**
* begins a transaction
*
* @return boolean
*/
public function beginTransaction() {
$event = new Doctrine_Db_Event($this, Doctrine_Db_Event::BEGIN);
$this->listener->onPreBeginTransaction($event);
$return = $this->dbh->beginTransaction();
$this->listener->onBeginTransaction($event);
2006-05-30 12:42:10 +04:00
return $return;
2006-05-30 12:42:10 +04:00
}
/**
* commits a transaction
*
* @return boolean
2006-05-30 12:42:10 +04:00
*/
public function commit() {
$event = new Doctrine_Db_Event($this, Doctrine_Db_Event::COMMIT);
$this->listener->onPreCommit($event);
$return = $this->dbh->commit();
$this->listener->onCommit($event);
return $return;
2006-05-30 12:42:10 +04:00
}
/**
* rollBack
*
* @return boolean
*/
public function rollBack() {
$this->connect();
$event = new Doctrine_Db_Event($this, Doctrine_Db_Event::ROLLBACK);
$this->listener->onPreRollback($event);
$this->dbh->rollBack();
$this->listener->onRollback($event);
}
/**
* getAttribute
* retrieves a database connection attribute
*
* @param integer $attribute
* @return mixed
*/
public function getAttribute($attribute) {
$this->connect();
return $this->dbh->getAttribute($attribute);
}
/**
* returns an array of available PDO drivers
*/
public static function getAvailableDrivers() {
return PDO::getAvailableDrivers();
}
/**
* setAttribute
* sets an attribute
*
* @param integer $attribute
* @param mixed $value
* @return boolean
*/
public function setAttribute($attribute, $value) {
$this->connect();
$this->dbh->setAttribute($attribute, $value);
}
/**
* getIterator
*
2006-05-30 12:42:10 +04:00
* @return ArrayIterator
*/
public function getIterator() {
if($this->listener instanceof Doctrine_Db_Profiler)
return $this->listener;
2006-05-30 12:42:10 +04:00
}
/**
* count
2006-05-30 12:42:10 +04:00
* returns the number of executed queries
*
2006-05-30 12:42:10 +04:00
* @return integer
*/
public function count() {
return $this->querySequence;
}
2006-05-30 12:42:10 +04:00
}