Connection.php

Ir para a documentação deste ficheiro.

<?php
/*
 * 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.doctrine-project.org>.
 */
 
namespace Doctrine\DBAL;
 
use PDO, Closure, Exception,
    Doctrine\DBAL\Types\Type,
    Doctrine\DBAL\Driver\Connection as DriverConnection,
    Doctrine\Common\EventManager,
    Doctrine\DBAL\DBALException;
 
class Connection implements DriverConnection
{
    const TRANSACTION_READ_UNCOMMITTED = 1;
    
    const TRANSACTION_READ_COMMITTED = 2;
    
    const TRANSACTION_REPEATABLE_READ = 3;
    
    const TRANSACTION_SERIALIZABLE = 4;
 
    protected $_conn;
 
    protected $_config;
 
    protected $_eventManager;
 
    private $_isConnected = false;
 
    private $_transactionNestingLevel = 0;
 
    private $_transactionIsolationLevel;
 
    private $_nestTransactionsWithSavepoints;
 
    private $_params = array();
 
    protected $_platform;
 
    protected $_schemaManager;
 
    protected $_driver;
    
    private $_isRollbackOnly = false;
 
    public function __construct(array $params, Driver $driver, Configuration $config = null,
            EventManager $eventManager = null)
    {
        $this->_driver = $driver;
        $this->_params = $params;
 
        if (isset($params['pdo'])) {
            $this->_conn = $params['pdo'];
            $this->_isConnected = true;
        }
 
        // Create default config and event manager if none given
        if ( ! $config) {
            $config = new Configuration();
        }
        
        if ( ! $eventManager) {
            $eventManager = new EventManager();
        }
 
        $this->_config = $config;
        $this->_eventManager = $eventManager;
        if ( ! isset($params['platform'])) {
            $this->_platform = $driver->getDatabasePlatform();
        } else if ($params['platform'] instanceof Platforms\AbstractPlatform) {
            $this->_platform = $params['platform'];
        } else {
            throw DBALException::invalidPlatformSpecified();
        }
        $this->_transactionIsolationLevel = $this->_platform->getDefaultTransactionIsolationLevel();
    }
 
    public function getParams()
    {
        return $this->_params;
    }
 
    public function getDatabase()
    {
        return $this->_driver->getDatabase($this);
    }
    
    public function getHost()
    {
        return isset($this->_params['host']) ? $this->_params['host'] : null;
    }
    
    public function getPort()
    {
        return isset($this->_params['port']) ? $this->_params['port'] : null;
    }
    
    public function getUsername()
    {
        return isset($this->_params['user']) ? $this->_params['user'] : null;
    }
    
    public function getPassword()
    {
        return isset($this->_params['password']) ? $this->_params['password'] : null;
    }
 
    public function getDriver()
    {
        return $this->_driver;
    }
 
    public function getConfiguration()
    {
        return $this->_config;
    }
 
    public function getEventManager()
    {
        return $this->_eventManager;
    }
 
    public function getDatabasePlatform()
    {
        return $this->_platform;
    }
 
    public function connect()
    {
        if ($this->_isConnected) return false;
 
        $driverOptions = isset($this->_params['driverOptions']) ?
                $this->_params['driverOptions'] : array();
        $user = isset($this->_params['user']) ? $this->_params['user'] : null;
        $password = isset($this->_params['password']) ?
                $this->_params['password'] : null;
 
        $this->_conn = $this->_driver->connect($this->_params, $user, $password, $driverOptions);
        $this->_isConnected = true;
 
        if ($this->_eventManager->hasListeners(Events::postConnect)) {
            $eventArgs = new Event\ConnectionEventArgs($this);
            $this->_eventManager->dispatchEvent(Events::postConnect, $eventArgs);
        }
 
        return true;
    }
 
    public function fetchAssoc($statement, array $params = array())
    {
        return $this->executeQuery($statement, $params)->fetch(PDO::FETCH_ASSOC);
    }
 
    public function fetchArray($statement, array $params = array())
    {
        return $this->executeQuery($statement, $params)->fetch(PDO::FETCH_NUM);
    }
 
    public function fetchColumn($statement, array $params = array(), $colnum = 0)
    {
        return $this->executeQuery($statement, $params)->fetchColumn($colnum);
    }
 
    public function isConnected()
    {
        return $this->_isConnected;
    }
 
    public function isTransactionActive()
    {
        return $this->_transactionNestingLevel > 0;
    }
 
    public function delete($tableName, array $identifier)
    {
        $this->connect();
 
        $criteria = array();
 
        foreach (array_keys($identifier) as $columnName) {
            $criteria[] = $columnName . ' = ?';
        }
 
        $query = 'DELETE FROM ' . $tableName . ' WHERE ' . implode(' AND ', $criteria);
 
        return $this->executeUpdate($query, array_values($identifier));
    }
 
    public function close()
    {
        unset($this->_conn);
        
        $this->_isConnected = false;
    }
 
    public function setTransactionIsolation($level)
    {
        $this->_transactionIsolationLevel = $level;
        
        return $this->executeUpdate($this->_platform->getSetTransactionIsolationSQL($level));
    }
 
    public function getTransactionIsolation()
    {
        return $this->_transactionIsolationLevel;
    }
 
    public function update($tableName, array $data, array $identifier)
    {
        $this->connect();
        $set = array();
        foreach ($data as $columnName => $value) {
            $set[] = $columnName . ' = ?';
        }
 
        $params = array_merge(array_values($data), array_values($identifier));
 
        $sql  = 'UPDATE ' . $tableName . ' SET ' . implode(', ', $set)
                . ' WHERE ' . implode(' = ? AND ', array_keys($identifier))
                . ' = ?';
 
        return $this->executeUpdate($sql, $params);
    }
 
    public function insert($tableName, array $data)
    {
        $this->connect();
 
        // column names are specified as array keys
        $cols = array();
        $placeholders = array();
        
        foreach ($data as $columnName => $value) {
            $cols[] = $columnName;
            $placeholders[] = '?';
        }
 
        $query = 'INSERT INTO ' . $tableName
               . ' (' . implode(', ', $cols) . ')'
               . ' VALUES (' . implode(', ', $placeholders) . ')';
 
        return $this->executeUpdate($query, array_values($data));
    }
 
    public function setCharset($charset)
    {
        $this->executeUpdate($this->_platform->getSetCharsetSQL($charset));
    }
 
    public function quoteIdentifier($str)
    {
        return $this->_platform->quoteIdentifier($str);
    }
 
    public function quote($input, $type = null)
    {
        $this->connect();
        
        return $this->_conn->quote($input, $type);
    }
 
    public function fetchAll($sql, array $params = array())
    {
        return $this->executeQuery($sql, $params)->fetchAll(PDO::FETCH_ASSOC);
    }
 
    public function prepare($statement)
    {
        $this->connect();
 
        return new Statement($statement, $this);
    }
 
    public function executeQuery($query, array $params = array(), $types = array())
    {
        $this->connect();
 
        $hasLogger = $this->_config->getSQLLogger() !== null;
        if ($hasLogger) {
            $this->_config->getSQLLogger()->startQuery($query, $params, $types);
        }
 
        if ($params) {
            $stmt = $this->_conn->prepare($query);
            if ($types) {
                $this->_bindTypedValues($stmt, $params, $types);
                $stmt->execute();
            } else {
                $stmt->execute($params);
            }
        } else {
            $stmt = $this->_conn->query($query);
        }
 
        if ($hasLogger) {
            $this->_config->getSQLLogger()->stopQuery();
        }
 
        return $stmt;
    }
 
    public function project($query, array $params, Closure $function)
    {
        $result = array();
        $stmt = $this->executeQuery($query, $params ?: array());
 
        while ($row = $stmt->fetch()) {
            $result[] = $function($row);
        }
 
        $stmt->closeCursor();
 
        return $result;
    }
 
    public function query()
    {
        $this->connect();
 
        return call_user_func_array(array($this->_conn, 'query'), func_get_args());
    }
 
    public function executeUpdate($query, array $params = array(), array $types = array())
    {
        $this->connect();
 
        $hasLogger = $this->_config->getSQLLogger() !== null;
        if ($hasLogger) {
            $this->_config->getSQLLogger()->startQuery($query, $params, $types);
        }
 
        if ($params) {
            $stmt = $this->_conn->prepare($query);
            if ($types) {
                $this->_bindTypedValues($stmt, $params, $types);
                $stmt->execute();
            } else {
                $stmt->execute($params);
            }
            $result = $stmt->rowCount();
        } else {
            $result = $this->_conn->exec($query);
        }
 
        if ($hasLogger) {
            $this->_config->getSQLLogger()->stopQuery();
        }
 
        return $result;
    }
 
    public function exec($statement)
    {
        $this->connect();
        return $this->_conn->exec($statement);
    }
 
    public function getTransactionNestingLevel()
    {
        return $this->_transactionNestingLevel;
    }
 
    public function errorCode()
    {
        $this->connect();
        return $this->_conn->errorCode();
    }
 
    public function errorInfo()
    {
        $this->connect();
        return $this->_conn->errorInfo();
    }
 
    public function lastInsertId($seqName = null)
    {
        $this->connect();
        return $this->_conn->lastInsertId($seqName);
    }
 
    public function transactional(Closure $func)
    {
        $this->beginTransaction();
        try {
            $func($this);
            $this->commit();
        } catch (Exception $e) {
            $this->rollback();
            throw $e;
        }
    }
 
    public function setNestTransactionsWithSavepoints($nestTransactionsWithSavepoints)
    {
        if ($this->_transactionNestingLevel > 0) {
            throw ConnectionException::mayNotAlterNestedTransactionWithSavepointsInTransaction();
        }
 
        if (!$this->_platform->supportsSavepoints()) {
            throw ConnectionException::savepointsNotSupported();
        }
 
        $this->_nestTransactionsWithSavepoints = $nestTransactionsWithSavepoints;
    }
 
    public function getNestTransactionsWithSavepoints()
    {
        return $this->_nestTransactionsWithSavepoints;
    }
 
    protected function _getNestedTransactionSavePointName()
    {
        return 'DOCTRINE2_SAVEPOINT_'.$this->_transactionNestingLevel;
    }
 
    public function beginTransaction()
    {
        $this->connect();
 
        ++$this->_transactionNestingLevel;
 
        if ($this->_transactionNestingLevel == 1) {
            $this->_conn->beginTransaction();
        } else if ($this->_nestTransactionsWithSavepoints) {
            $this->createSavepoint($this->_getNestedTransactionSavePointName());
        }
    }
 
    public function commit()
    {
        if ($this->_transactionNestingLevel == 0) {
            throw ConnectionException::noActiveTransaction();
        }
        if ($this->_isRollbackOnly) {
            throw ConnectionException::commitFailedRollbackOnly();
        }
 
        $this->connect();
 
        if ($this->_transactionNestingLevel == 1) {
            $this->_conn->commit();
        } else if ($this->_nestTransactionsWithSavepoints) {
            $this->releaseSavepoint($this->_getNestedTransactionSavePointName());
        }
 
        --$this->_transactionNestingLevel;
    }
 
    public function rollback()
    {
        if ($this->_transactionNestingLevel == 0) {
            throw ConnectionException::noActiveTransaction();
        }
 
        $this->connect();
 
        if ($this->_transactionNestingLevel == 1) {
            $this->_transactionNestingLevel = 0;
            $this->_conn->rollback();
            $this->_isRollbackOnly = false;
        } else if ($this->_nestTransactionsWithSavepoints) {
            $this->rollbackSavepoint($this->_getNestedTransactionSavePointName());
            --$this->_transactionNestingLevel;
        } else {
            $this->_isRollbackOnly = true;
            --$this->_transactionNestingLevel;
        }
    }
 
    public function createSavepoint($savepoint)
    {
        if (!$this->_platform->supportsSavepoints()) {
            throw ConnectionException::savepointsNotSupported();
        }
 
        $this->_conn->exec($this->_platform->createSavePoint($savepoint));
    }
 
    public function releaseSavepoint($savepoint)
    {
        if (!$this->_platform->supportsSavepoints()) {
            throw ConnectionException::savepointsNotSupported();
        }
 
        if ($this->_platform->supportsReleaseSavepoints()) {
            $this->_conn->exec($this->_platform->releaseSavePoint($savepoint));
        }
    }
 
    public function rollbackSavepoint($savepoint)
    {
        if (!$this->_platform->supportsSavepoints()) {
            throw ConnectionException::savepointsNotSupported();
        }
 
        $this->_conn->exec($this->_platform->rollbackSavePoint($savepoint));
    }
 
    public function getWrappedConnection()
    {
        $this->connect();
 
        return $this->_conn;
    }
 
    public function getSchemaManager()
    {
        if ( ! $this->_schemaManager) {
            $this->_schemaManager = $this->_driver->getSchemaManager($this);
        }
 
        return $this->_schemaManager;
    }
 
    public function setRollbackOnly()
    {
        if ($this->_transactionNestingLevel == 0) {
            throw ConnectionException::noActiveTransaction();
        }
        $this->_isRollbackOnly = true;
    }
 
    public function isRollbackOnly()
    {
        if ($this->_transactionNestingLevel == 0) {
            throw ConnectionException::noActiveTransaction();
        }
        return $this->_isRollbackOnly;
    }
 
    public function convertToDatabaseValue($value, $type)
    {
        return Type::getType($type)->convertToDatabaseValue($value, $this->_platform);
    }
 
    public function convertToPHPValue($value, $type)
    {
        return Type::getType($type)->convertToPHPValue($value, $this->_platform);
    }
 
    private function _bindTypedValues($stmt, array $params, array $types)
    {
        // Check whether parameters are positional or named. Mixing is not allowed, just like in PDO.
        if (is_int(key($params))) {
            // Positional parameters
            $typeOffset = array_key_exists(0, $types) ? -1 : 0;
            $bindIndex = 1;
            foreach ($params as $position => $value) {
                $typeIndex = $bindIndex + $typeOffset;
                if (isset($types[$typeIndex])) {
                    $type = $types[$typeIndex];
                    if (is_string($type)) {
                        $type = Type::getType($type);
                    }
                    if ($type instanceof Type) {
                        $value = $type->convertToDatabaseValue($value, $this->_platform);
                        $bindingType = $type->getBindingType();
                    } else {
                        $bindingType = $type; // PDO::PARAM_* constants
                    }
                    $stmt->bindValue($bindIndex, $value, $bindingType);
                } else {
                    $stmt->bindValue($bindIndex, $value);
                }
                ++$bindIndex;
            }
        } else {
            // Named parameters
            foreach ($params as $name => $value) {
                if (isset($types[$name])) {
                    $type = $types[$name];
                    if (is_string($type)) {
                        $type = Type::getType($type);
                    }
                    if ($type instanceof Type) {
                        $value = $type->convertToDatabaseValue($value, $this->_platform);
                        $bindingType = $type->getBindingType();
                    } else {
                        $bindingType = $type; // PDO::PARAM_* constants
                    }
                    $stmt->bindValue($name, $value, $bindingType);
                } else {
                    $stmt->bindValue($name, $value);
                }
            }
        }
    }
}