Connection.php 35.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<?php
/*
 *  $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>.
 */
21
Doctrine::autoload('Doctrine_Configurable');
22 23 24
/**
 * Doctrine_Connection
 *
zYne's avatar
zYne committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
 * A wrapper layer on top of PDO / Doctrine_Adapter
 *
 * Doctrine_Connection is the heart of any Doctrine based application.
 *
 * 1. Event listeners
 *    An easy to use, pluggable eventlistener architecture. Aspects such as
 *    logging, query profiling and caching can be easily implemented through
 *    the use of these listeners
 *
 * 2. Lazy-connecting
 *    Creating an instance of Doctrine_Connection does not connect
 *    to database. Connecting to database is only invoked when actually needed
 *    (for example when query() is being called) 
 *
 * 3. Convenience methods
zYne's avatar
zYne committed
40
 *    Doctrine_Connection provides many convenience methods such as fetchAll(), fetchOne() etc.
zYne's avatar
zYne committed
41 42 43 44 45 46
 *
 * 4. Modular structure
 *    Higher level functionality such as schema importing, exporting, sequence handling etc.
 *    is divided into modules. For a full list of connection modules see 
 *    Doctrine_Connection::$_modules
 *
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
 * @package     Doctrine
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @category    Object Relational Mapping
 * @link        www.phpdoctrine.com
 * @since       1.0
 * @version     $Revision$
 * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
 * @author      Lukas Smith <smith@pooteeweet.org> (MDB2 library)
 */
abstract class Doctrine_Connection extends Doctrine_Configurable implements Countable, IteratorAggregate
{
    /**
     * @var $dbh                                the database handler
     */
    protected $dbh;
    /**
     * @var array $tables                       an array containing all the initialized Doctrine_Table objects
     *                                          keys representing Doctrine_Table component names and values as Doctrine_Table objects
     */
    protected $tables           = array();
67 68 69 70
    /**
     * @var array $exported
     */
    protected $exported         = array();
71 72 73 74
    /**
     * @var string $driverName                  the name of this connection driver
     */
    protected $driverName;
75 76 77 78
    /**
     * @var boolean $isConnected                whether or not a connection has been established
     */
    protected $isConnected      = false;
79 80 81 82 83 84
    /**
     * @var array $supported                    an array containing all features this driver supports,
     *                                          keys representing feature names and values as
     *                                          one of the following (true, false, 'emulated')
     */
    protected $supported        = array();
85 86 87 88 89 90
    /**
     * @var array $pendingAttributes            An array of pending attributes. When setting attributes
     *                                          no connection is needed. When connected all the pending
     *                                          attributes are passed to the underlying adapter (usually PDO) instance.
     */
    protected $pendingAttributes  = array();
91 92 93 94 95 96 97 98 99 100
    /**
     * @var array $modules                      an array containing all modules
     *              transaction                 Doctrine_Transaction driver, handles savepoint and transaction isolation abstraction
     *
     *              expression                  Doctrine_Expression driver, handles expression abstraction
     *
     *              dataDict                    Doctrine_DataDict driver, handles datatype abstraction
     *
     *              export                      Doctrine_Export driver, handles db structure modification abstraction (contains
     *                                          methods such as alterTable, createConstraint etc.)
zYne's avatar
zYne committed
101 102 103
     *              import                      Doctrine_Import driver, handles db schema reading
     *
     *              sequence                    Doctrine_Sequence driver, handles sequential id generation and retrieval
104
     *
zYne's avatar
zYne committed
105 106 107 108 109
     *              unitOfWork                  Doctrine_Connection_UnitOfWork handles many orm functionalities such as object
     *                                          deletion and saving
     *
     *              formatter                   Doctrine_Formatter handles data formatting, quoting and escaping
     *
110 111 112 113 114
     * @see Doctrine_Connection::__get()
     * @see Doctrine_DataDict
     * @see Doctrine_Expression
     * @see Doctrine_Export
     * @see Doctrine_Transaction
zYne's avatar
zYne committed
115
     * @see Doctrine_Sequence
zYne's avatar
zYne committed
116 117
     * @see Doctrine_Connection_UnitOfWork
     * @see Doctrine_Formatter
118 119 120 121 122
     */
    private $modules = array('transaction' => false,
                             'expression'  => false,
                             'dataDict'    => false,
                             'export'      => false,
zYne's avatar
zYne committed
123 124
                             'import'      => false,
                             'sequence'    => false,
125
                             'unitOfWork'  => false,
126 127
                             'formatter'   => false,
                             'util'        => false,
128 129 130 131 132
                             );
    /**
     * @var array $properties               an array of connection properties
     */
    protected $properties = array('sql_comments'        => array(array('start' => '--', 'end' => "\n", 'escape' => false),
zYne's avatar
zYne committed
133 134
                                                                 array('start' => '/*', 'end' => '*/', 'escape' => false)),
                                  'identifier_quoting'  => array('start' => '"', 'end' => '"','escape' => '"'),
135 136 137
                                  'string_quoting'      => array('start' => "'",
                                                                 'end' => "'",
                                                                 'escape' => false,
zYne's avatar
zYne committed
138
                                                                 'escape_pattern' => false),
zYne's avatar
zYne committed
139 140
                                  'wildcards'           => array('%', '_'),
                                  'varchar_max_length'  => 255,
141
                                  );
zYne's avatar
zYne committed
142 143 144 145
    /**
     * @var array $serverInfo
     */
    protected $serverInfo = array();
146 147
    
    protected $options    = array();
148
    /**
fabien's avatar
fabien committed
149
     * @var array $availableDrivers         an array containing all availible drivers
150
     */
fabien's avatar
fabien committed
151
    private static $availableDrivers    = array(
152 153 154 155 156 157 158 159
                                        'Mysql',
                                        'Pgsql',
                                        'Oracle',
                                        'Informix',
                                        'Mssql',
                                        'Sqlite',
                                        'Firebird'
                                        );
160
    protected $_count;
161 162 163 164 165 166 167

    /**
     * the constructor
     *
     * @param Doctrine_Manager $manager                 the manager object
     * @param PDO|Doctrine_Adapter_Interface $adapter   database driver
     */
168
    public function __construct(Doctrine_Manager $manager, $adapter, $user = null, $pass = null)
169
    {
170 171 172
    	if (is_object($adapter)) {
            if ( ! ($adapter instanceof PDO) && ! in_array('Doctrine_Adapter_Interface', class_implements($adapter))) {
                throw new Doctrine_Connection_Exception('First argument should be an instance of PDO or implement Doctrine_Adapter_Interface');
173
            }
174
            $this->dbh = $adapter;
175

176
            $this->isConnected = true;
177

178 179
        } elseif(is_array($adapter)) {
            $this->pendingAttributes[Doctrine::ATTR_DRIVER_NAME] = $adapter['scheme'];
180

181 182 183
            $this->options['dsn']      = $adapter['dsn'];
            $this->options['username'] = $adapter['user'];
            $this->options['password'] = $adapter['pass'];
184
        }
185 186 187

        $this->setParent($manager);

188 189
        $this->setAttribute(Doctrine::ATTR_CASE, Doctrine::CASE_NATURAL);
        $this->setAttribute(Doctrine::ATTR_ERRMODE, Doctrine::ERRMODE_EXCEPTION);
190 191 192

        $this->getAttribute(Doctrine::ATTR_LISTENER)->onOpen($this);
    }
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
    /**
     * getAttribute
     * retrieves a database connection attribute
     *
     * @param integer $attribute
     * @return mixed
     */
    public function getAttribute($attribute)
    {

    	if ($attribute >= 100) {
            if ( ! isset($this->attributes[$attribute])) {
                return $this->parent->getAttribute($attribute);
            }
            return $this->attributes[$attribute];
    	}

        if ($this->isConnected) {
            try {
                return $this->dbh->getAttribute($attribute);
            } catch(Exception $e) {
                throw new Doctrine_Connection_Exception('Attribute ' . $attribute . ' not found.');
            }
        } else {
            if ( ! isset($this->pendingAttributes[$attribute])) {
                $this->connect();
                $this->getAttribute($attribute);
            }

            return $this->pendingAttributes[$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)
    {
    	if ($attribute >= 100) {
            parent::setAttribute($attribute, $value);
    	} else {
            if ($this->isConnected) {
                $this->dbh->setAttribute($attribute, $value);
            } else {
                $this->pendingAttributes[$attribute] = $value;
            }
        }
        return $this;
    }
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
    /**
     * getName
     * returns the name of this driver
     *
     * @return string           the name of this driver
     */
    public function getName()
    {
        return $this->driverName;
    }
    /**
     * __get
     * lazy loads given module and returns it
     *
     * @see Doctrine_DataDict
     * @see Doctrine_Expression
     * @see Doctrine_Export
     * @see Doctrine_Transaction
     * @see Doctrine_Connection::$modules       all availible modules
     * @param string $name                      the name of the module to get
     * @throws Doctrine_Connection_Exception    if trying to get an unknown module
     * @return Doctrine_Connection_Module       connection module
     */
    public function __get($name)
    {
zYne's avatar
zYne committed
278
        if (isset($this->properties[$name])) {
279
            return $this->properties[$name];
280
        }
281 282 283 284 285 286 287 288 289

        if ( ! isset($this->modules[$name])) {
            throw new Doctrine_Connection_Exception('Unknown module / property ' . $name);
        }
        if ($this->modules[$name] === false) {
            switch ($name) {
                case 'unitOfWork':
                    $this->modules[$name] = new Doctrine_Connection_UnitOfWork($this);
                    break;
zYne's avatar
zYne committed
290 291 292
                case 'formatter':
                    $this->modules[$name] = new Doctrine_Formatter($this);
                    break;
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
                default:
                    $class = 'Doctrine_' . ucwords($name) . '_' . $this->getName();
                    $this->modules[$name] = new $class($this);
                }
        }

        return $this->modules[$name];
    }
    /**
     * returns the manager that created this connection
     *
     * @return Doctrine_Manager
     */
    public function getManager()
    {
        return $this->getParent();
    }
    /**
     * returns the database handler of which this connection uses
     *
     * @return PDO              the database handler
     */
    public function getDbh()
    {
        return $this->dbh;
    }
319 320 321 322 323 324 325 326
    /**
     * connect
     * connects into database
     *
     * @return boolean
     */
    public function connect()
    {
327

328 329 330 331
        if ($this->isConnected) {
            return false;
        }

332 333 334
        $event = new Doctrine_Event($this, Doctrine_Event::CONNECT);

        $this->getListener()->onPreConnect($event);
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356

        $e     = explode(':', $this->options['dsn']);
        $found = false;
        
        if (extension_loaded('pdo')) {
            if (in_array($e[0], PDO::getAvailableDrivers())) {
                $this->dbh = new PDO($this->options['dsn'], $this->options['username'], $this->options['password']);
                $this->dbh->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
                $found = true;
            }
        }

        if ( ! $found) {
            $class = 'Doctrine_Adapter_' . ucwords($e[0]);

            if (class_exists($class)) {
                $this->dbh = new $class($this->options['dsn'], $this->options['username'], $this->options['password']);
            } else {
                throw new Doctrine_Connection_Exception("Couldn't locate driver named " . $e[0]);      	
            }
        }

357
        // attach the pending attributes to adapter
358 359 360 361 362 363 364 365 366 367
        foreach($this->pendingAttributes as $attr => $value) {
            // some drivers don't support setting this so we just skip it
            if($attr == Doctrine::ATTR_DRIVER_NAME) {
                continue;
            }
            $this->dbh->setAttribute($attr, $value);
        }

        $this->isConnected = true;

368
        $this->getListener()->onConnect($event);
369 370
        return true;
    }
371 372 373 374 375
    
    public function incrementQueryCount() 
    {
        $this->_count++;
    }
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
    /**
     * converts given driver name
     *
     * @param
     */
    public function driverName($name)
    {
    }
    /**
     * supports
     *
     * @param string $feature   the name of the feature
     * @return boolean          whether or not this drivers supports given feature
     */
    public function supports($feature)
    {
        return (isset($this->supported[$feature])
zYne's avatar
zYne committed
393 394
                  && ($this->supported[$feature] === 'emulated'
                   || $this->supported[$feature]));
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
    }
    /**
     * Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
     * query, except that if there is already a row in the table with the same
     * key field values, the REPLACE query just updates its values instead of
     * inserting a new row.
     *
     * The REPLACE type of query does not make part of the SQL standards. Since
     * practically only MySQL and SQLIte implement it natively, this type of
     * query isemulated through this method for other DBMS using standard types
     * of queries inside a transaction to assure the atomicity of the operation.
     *
     * @param                   string  name of the table on which the REPLACE query will
     *                          be executed.
     *
     * @param   array           an associative array that describes the fields and the
     *                          values that will be inserted or updated in the specified table. The
     *                          indexes of the array are the names of all the fields of the table.
     *
     *                          The values of the array are values to be assigned to the specified field.
     *
     * @param array $keys       an array containing all key fields (primary key fields
     *                          or unique index fields) for this table
     *
     *                          the uniqueness of a row will be determined according to
     *                          the provided key fields
     *
     *                          this method will fail if no key fields are specified
     *
     * @throws Doctrine_Connection_Exception        if this driver doesn't support replace
     * @throws Doctrine_Connection_Exception        if some of the key values was null
     * @throws Doctrine_Connection_Exception        if there were no key fields
     * @throws PDOException                         if something fails at PDO level
     * @return integer                              number of rows affected
     */
    public function replace($table, array $fields, array $keys)
    {
        //if ( ! $this->supports('replace'))
        //    throw new Doctrine_Connection_Exception('replace query is not supported');

        if (empty($keys)) {
            throw new Doctrine_Connection_Exception('Not specified which fields are keys');
        }
        $condition = $values = array();

        foreach ($fields as $name => $value) {
            $values[$name] = $value;

            if (in_array($name, $keys)) {
                if ($value === null)
                    throw new Doctrine_Connection_Exception('key value '.$name.' may not be null');

                $condition[]       = $name . ' = ?';
                $conditionValues[] = $value;
            }
        }

zYne's avatar
zYne committed
452
        $query          = 'DELETE FROM ' . $this->quoteIdentifier($table) . ' WHERE ' . implode(' AND ', $condition);
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
        $affectedRows   = $this->exec($query);

        $this->insert($table, $values);

        $affectedRows++;


        return $affectedRows;
    }
    /**
     * Inserts a table row with specified data.
     *
     * @param string $table     The table to insert data into.
     * @param array $values     An associateve array containing column-value pairs.
     * @return boolean
     */
    public function insert($table, array $values = array()) {
        if (empty($values)) {
            return false;
        }
        // column names are specified as array keys
        $cols = array_keys($values);

        // build the statement
zYne's avatar
zYne committed
477
        $query = 'INSERT INTO ' . $this->quoteIdentifier($table) 
478 479 480 481
               . '(' . implode(', ', $cols) . ') '
               . 'VALUES (' . substr(str_repeat('?, ', count($values)), 0, -2) . ')';

        // prepare and execute the statement
482
        $this->execute($query, array_values($values));
zYne's avatar
zYne committed
483

484 485 486 487 488 489 490 491 492 493 494
        return true;
    }
    /**
     * Set the charset on the current connection
     *
     * @param string    charset
     *
     * @return void
     */
    public function setCharset($charset)
    {
zYne's avatar
zYne committed
495

zYne's avatar
zYne committed
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
    }
    /**
     * Quote a string so it can be safely used as a table or column name
     *
     * Delimiting style depends on which database driver is being used.
     *
     * NOTE: just because you CAN use delimited identifiers doesn't mean
     * you SHOULD use them.  In general, they end up causing way more
     * problems than they solve.
     *
     * Portability is broken by using the following characters inside
     * delimited identifiers:
     *   + backtick (<kbd>`</kbd>) -- due to MySQL
     *   + double quote (<kbd>"</kbd>) -- due to Oracle
     *   + brackets (<kbd>[</kbd> or <kbd>]</kbd>) -- due to Access
     *
     * Delimited identifiers are known to generally work correctly under
     * the following drivers:
     *   + mssql
     *   + mysql
     *   + mysqli
     *   + oci8
     *   + pgsql
     *   + sqlite
     *
     * InterBase doesn't seem to be able to use delimited identifiers
     * via PHP 4.  They work fine under PHP 5.
     *
     * @param string $str           identifier name to be quoted
     * @param bool $checkOption     check the 'quote_identifier' option
     *
     * @return string               quoted identifier string
     */
    public function quoteIdentifier($str, $checkOption = true)
    {
        return $this->formatter->quoteIdentifier($str, $checkOption);
    }
    /**
     * convertBooleans
     * some drivers need the boolean values to be converted into integers
     * when using DQL API
     *
     * This method takes care of that conversion
     *
     * @param array $item
     * @return void
     */
    public function convertBooleans($item)
    {
        return $this->formatter->convertBooleans($item);
    }
    /**
     * quote
     * quotes given input parameter
     *
     * @param mixed $input      parameter to be quoted
     * @param string $type
     * @return mixed
     */
    public function quote($input, $type = null)
    {
        return $this->formatter->quote($input, $type);
558
    }
559 560 561 562 563 564 565 566 567 568
    /**
     * Set the date/time format for the current connection
     *
     * @param string    time format
     *
     * @return void
     */
    public function setDateFormat($format = null)
    {
    }
569 570 571 572 573 574 575
    /**
     * fetchAll
     *
     * @param string $statement         sql query to be executed
     * @param array $params             prepared statement params
     * @return array
     */
zYne's avatar
zYne committed
576 577
    public function fetchAll($statement, array $params = array()) 
    {
zYne's avatar
zYne committed
578
        return $this->execute($statement, $params)->fetchAll(PDO::FETCH_ASSOC);
579 580 581 582 583 584 585 586 587
    }
    /**
     * fetchOne
     *
     * @param string $statement         sql query to be executed
     * @param array $params             prepared statement params
     * @param int $colnum               0-indexed column number to retrieve
     * @return mixed
     */
zYne's avatar
zYne committed
588 589
    public function fetchOne($statement, array $params = array(), $colnum = 0) 
    {
590 591 592 593 594 595 596 597 598
        return $this->execute($statement, $params)->fetchColumn($colnum);
    }
    /**
     * fetchRow
     *
     * @param string $statement         sql query to be executed
     * @param array $params             prepared statement params
     * @return array
     */
zYne's avatar
zYne committed
599 600
    public function fetchRow($statement, array $params = array()) 
    {
zYne's avatar
zYne committed
601
        return $this->execute($statement, $params)->fetch(PDO::FETCH_ASSOC);
602 603 604 605 606 607 608 609
    }
    /**
     * fetchArray
     *
     * @param string $statement         sql query to be executed
     * @param array $params             prepared statement params
     * @return array
     */
zYne's avatar
zYne committed
610 611
    public function fetchArray($statement, array $params = array()) 
    {
zYne's avatar
zYne committed
612
        return $this->execute($statement, $params)->fetch(PDO::FETCH_NUM);
613 614 615 616 617 618 619 620 621
    }
    /**
     * fetchColumn
     *
     * @param string $statement         sql query to be executed
     * @param array $params             prepared statement params
     * @param int $colnum               0-indexed column number to retrieve
     * @return array
     */
zYne's avatar
zYne committed
622 623
    public function fetchColumn($statement, array $params = array(), $colnum = 0) 
    {
zYne's avatar
zYne committed
624
        return $this->execute($statement, $params)->fetchAll(PDO::FETCH_COLUMN, $colnum);
625 626 627 628 629 630 631 632
    }
    /**
     * fetchAssoc
     *
     * @param string $statement         sql query to be executed
     * @param array $params             prepared statement params
     * @return array
     */
zYne's avatar
zYne committed
633 634
    public function fetchAssoc($statement, array $params = array()) 
    {
zYne's avatar
zYne committed
635
        return $this->execute($statement, $params)->fetchAll(PDO::FETCH_ASSOC);
636 637 638 639 640 641 642 643
    }
    /**
     * fetchBoth
     *
     * @param string $statement         sql query to be executed
     * @param array $params             prepared statement params
     * @return array
     */
zYne's avatar
zYne committed
644 645
    public function fetchBoth($statement, array $params = array()) 
    {
zYne's avatar
zYne committed
646
        return $this->execute($statement, $params)->fetchAll(PDO::FETCH_BOTH);
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
    }
    /**
     * query
     * queries the database using Doctrine Query Language
     * returns a collection of Doctrine_Record objects
     *
     * <code>
     * $users = $conn->query('SELECT u.* FROM User u');
     *
     * $users = $conn->query('SELECT u.* FROM User u WHERE u.name LIKE ?', array('someone'));
     * </code>
     *
     * @param string $query             DQL query
     * @param array $params             query parameters
     * @see Doctrine_Query
     * @return Doctrine_Collection      Collection of Doctrine_Record objects
     */
zYne's avatar
zYne committed
664 665
    public function query($query, array $params = array()) 
    {
666 667 668 669
        $parser = new Doctrine_Query($this);

        return $parser->query($query, $params);
    }
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
    /**
     * prepare
     *
     * @param string $statement
     */
    public function prepare($statement)
    {
        $this->connect();

        $event = new Doctrine_Event($this, Doctrine_Db_Event::PREPARE, $statement);

        $this->getAttribute(Doctrine::ATTR_LISTENER)->onPrePrepare($event);

        $stmt = $this->dbh->prepare($statement);

        $this->getAttribute(Doctrine::ATTR_LISTENER)->onPrepare($event);

        return new Doctrine_Connection_Statement($this, $stmt);
    }
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
    /**
     * query
     * queries the database using Doctrine Query Language and returns
     * the first record found
     *
     * <code>
     * $user = $conn->queryOne('SELECT u.* FROM User u WHERE u.id = ?', array(1));
     *
     * $user = $conn->queryOne('SELECT u.* FROM User u WHERE u.name LIKE ? AND u.password = ?',
     *         array('someone', 'password')
     *         );
     * </code>
     *
     * @param string $query             DQL query
     * @param array $params             query parameters
     * @see Doctrine_Query
     * @return Doctrine_Record|false    Doctrine_Record object on success,
     *                                  boolean false on failure
     */
zYne's avatar
zYne committed
708 709
    public function queryOne($query, array $params = array()) 
    {
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
        $parser = new Doctrine_Query($this);

        $coll = $parser->query($query, $params);
        if ( ! $coll->contains(0)) {
            return false;
        }
        return $coll[0];
    }
    /**
     * queries the database with limit and offset
     * added to the query and returns a PDOStatement object
     *
     * @param string $query
     * @param integer $limit
     * @param integer $offset
     * @return PDOStatement
     */
727
    public function select($query, $limit = 0, $offset = 0)
728 729 730 731 732 733
    {
        if ($limit > 0 || $offset > 0) {
            $query = $this->modifyLimitQuery($query, $limit, $offset);
        }
        return $this->dbh->query($query);
    }
zYne's avatar
zYne committed
734 735 736 737 738 739 740 741 742 743 744 745
    /**
     * standaloneQuery
     *
     * @param string $query     sql query
     * @param array $params     query parameters
     *
     * @return PDOStatement|Doctrine_Adapter_Statement
     */
    public function standaloneQuery($query, $params = array())
    {
        return $this->execute($query, $params);
    }
746 747 748 749 750 751 752
    /**
     * execute
     * @param string $query     sql query
     * @param array $params     query parameters
     *
     * @return PDOStatement|Doctrine_Adapter_Statement
     */
zYne's avatar
zYne committed
753 754
    public function execute($query, array $params = array()) 
    {
755 756
    	$this->connect();

757 758 759 760
        try {
            if ( ! empty($params)) {
                $stmt = $this->dbh->prepare($query);
                $stmt->execute($params);
zYne's avatar
zYne committed
761
                return $stmt;
762
            } else {
763 764 765 766 767 768 769 770 771 772 773
                $event = new Doctrine_Event($this, Doctrine_EVENT::QUERY, $query, $params);

                $this->getAttribute(Doctrine::ATTR_LISTENER)->onPreQuery($event);

                $stmt = $this->dbh->query($query);
                
                $this->getAttribute(Doctrine::ATTR_LISTENER)->onQuery($event);
                
                $this->_count++;

                return $stmt;
774 775 776
            }
        } catch(Doctrine_Adapter_Exception $e) {
        } catch(PDOException $e) { }
zYne's avatar
zYne committed
777

778 779 780 781 782 783 784 785 786 787
        $this->rethrowException($e);
    }
    /**
     * exec
     * @param string $query     sql query
     * @param array $params     query parameters
     *
     * @return PDOStatement|Doctrine_Adapter_Statement
     */
    public function exec($query, array $params = array()) {
788 789
    	$this->connect();

790 791
        try {
            if ( ! empty($params)) {
792
                $stmt = $this->prepare($query);
793
                $stmt->execute($params);
794

zYne's avatar
zYne committed
795
                return $stmt->rowCount();
796
            } else {
797 798 799 800 801 802 803 804 805 806 807
                $event = new Doctrine_Event($this, Doctrine_EVENT::EXEC, $query, $params);

                $this->getAttribute(Doctrine::ATTR_LISTENER)->onPreExec($event);

                $count = $this->dbh->exec($query);

                $this->getAttribute(Doctrine::ATTR_LISTENER)->onExec($event);
                
                $this->_count++;

                return $count;
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
            }
        } catch(Doctrine_Adapter_Exception $e) {
        } catch(PDOException $e) { }

        $this->rethrowException($e);
    }
    /**
     * rethrowException
     *
     * @throws Doctrine_Connection_Exception
     */
    private function rethrowException(Exception $e)
    {
        $name = 'Doctrine_Connection_' . $this->driverName . '_Exception';

        $exc  = new $name($e->getMessage(), (int) $e->getCode());
        if ( ! is_array($e->errorInfo)) {
            $e->errorInfo = array(null, null, null, null);
        }
        $exc->processErrorInfo($e->errorInfo);

        throw $exc;
    }
    /**
     * hasTable
     * whether or not this connection has table $name initialized
     *
     * @param mixed $name
     * @return boolean
     */
    public function hasTable($name)
    {
        return isset($this->tables[$name]);
    }
    /**
     * returns a table object for given component name
     *
     * @param string $name              component name
     * @return object Doctrine_Table
     */
zYne's avatar
zYne committed
848
    public function getTable($name, $allowExport = true)
849 850 851 852
    {
        if (isset($this->tables[$name])) {
            return $this->tables[$name];
        }
zYne's avatar
zYne committed
853
        $class = $name . 'Table';
854

zYne's avatar
zYne committed
855
        if (class_exists($class) && in_array('Doctrine_Table', class_parents($class))) {
856
            $table = new $class($name, $this);
857
        } else {
858
            $table = new Doctrine_Table($name, $this);
859
        }
860

zYne's avatar
zYne committed
861
        $this->tables[$name] = $table;
862

zYne's avatar
zYne committed
863

zYne's avatar
zYne committed
864
        return $table;
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
    }
    /**
     * returns an array of all initialized tables
     *
     * @return array
     */
    public function getTables()
    {
        return $this->tables;
    }
    /**
     * returns an iterator that iterators through all
     * initialized table objects
     *
     * <code>
     * foreach ($conn as $index => $table) {
     *      print $table;  // get a string representation of each table object
     * }
     * </code>
     *
     * @return ArrayIterator        SPL ArrayIterator object
     */
    public function getIterator()
    {
        return new ArrayIterator($this->tables);
    }
    /**
     * returns the count of initialized table objects
     *
     * @return integer
     */
    public function count()
    {
898
        return $this->_count;
899 900 901 902 903
    }
    /**
     * addTable
     * adds a Doctrine_Table object into connection registry
     *
904
     * @param $table                a Doctrine_Table object to be added into registry
905 906
     * @return boolean
     */
907
    public function addTable(Doctrine_Table $table)
908
    {
909
        $name = $table->getComponentName();
910 911 912 913

        if (isset($this->tables[$name])) {
            return false;
        }
914
        $this->tables[$name] = $table;
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
        return true;
    }
    /**
     * create
     * creates a record
     *
     * create                       creates a record
     * @param string $name          component name
     * @return Doctrine_Record      Doctrine_Record object
     */
    public function create($name)
    {
        return $this->getTable($name)->create();
    }
    /**
     * flush
     * saves all the records from all tables
     * this operation is isolated using a transaction
     *
     * @throws PDOException         if something went wrong at database level
     * @return void
     */
    public function flush()
    {
        $this->beginTransaction();
        $this->unitOfWork->saveAll();
        $this->commit();
    }
    /**
     * clear
     * clears all repositories
     *
     * @return void
     */
    public function clear()
    {
        foreach ($this->tables as $k => $table) {
            $table->getRepository()->evictAll();
            $table->clear();
        }
    }
    /**
     * evictTables
     * evicts all tables
     *
     * @return void
     */
    public function evictTables()
    {
        $this->tables = array();
965
        $this->exported = array();
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
    }
    /**
     * close
     * closes the connection
     *
     * @return void
     */
    public function close()
    {
        $this->getAttribute(Doctrine::ATTR_LISTENER)->onPreClose($this);

        $this->clear();

        $this->getAttribute(Doctrine::ATTR_LISTENER)->onClose($this);
    }
    /**
     * get the current transaction nesting level
     *
     * @return integer
     */
    public function getTransactionLevel()
    {
        return $this->transaction->getTransactionLevel();
    }
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
    /**
     * errorCode
     * Fetch the SQLSTATE associated with the last operation on the database handle
     *
     * @return integer
     */
    public function errorCode()
    {
    	$this->connect();

        return $this->dbh->errorCode();
    }
    /**
     * errorInfo
     * Fetch extended error information associated with the last operation on the database handle
     *
     * @return array
     */
    public function errorInfo()
    {
    	$this->connect();

        return $this->dbh->errorInfo();
    }
zYne's avatar
zYne committed
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
    /**
     * lastInsertId
     *
     * Returns the ID of the last inserted row, or the last value from a sequence object,
     * depending on the underlying driver.
     *
     * Note: This method may not return a meaningful or consistent result across different drivers, 
     * because the underlying database may not even support the notion of auto-increment fields or sequences.
     *
     * @param string $table     name of the table into which a new row was inserted
     * @param string $field     name of the field into which a new row was inserted
     */
    public function lastInsertId($table = null, $field = null)
    {
        return $this->sequence->lastInsertId($table, $field);
    }
1030 1031
    /**
     * beginTransaction
1032
     * Start a transaction or set a savepoint.
1033
     *
1034 1035
     * if trying to set a savepoint and there is no active transaction
     * a new transaction is being started
1036
     *
1037 1038 1039 1040 1041
     * Listeners: onPreTransactionBegin, onTransactionBegin
     *
     * @param string $savepoint                 name of a savepoint to set
     * @throws Doctrine_Transaction_Exception   if the transaction fails at database level
     * @return integer                          current transaction nesting level
1042
     */
1043
    public function beginTransaction($savepoint = null)
1044
    {
1045
        $this->transaction->beginTransaction($savepoint);
1046 1047
    }
    /**
1048 1049 1050 1051
     * commit
     * Commit the database changes done during a transaction that is in
     * progress or release a savepoint. This function may only be called when
     * auto-committing is disabled, otherwise it will fail.
1052
     *
1053 1054 1055 1056 1057 1058
     * Listeners: onPreTransactionCommit, onTransactionCommit
     *
     * @param string $savepoint                 name of a savepoint to release
     * @throws Doctrine_Transaction_Exception   if the transaction fails at PDO level
     * @throws Doctrine_Validator_Exception     if the transaction fails due to record validations
     * @return boolean                          false if commit couldn't be performed, true otherwise
1059
     */
1060
    public function commit($savepoint = null)
1061
    {
1062
        $this->transaction->commit($savepoint);
1063 1064 1065
    }
    /**
     * rollback
1066 1067 1068 1069
     * Cancel any database changes done during a transaction or since a specific
     * savepoint that is in progress. This function may only be called when
     * auto-committing is disabled, otherwise it will fail. Therefore, a new
     * transaction is implicitly started after canceling the pending changes.
1070
     *
1071 1072
     * this method can be listened with onPreTransactionRollback and onTransactionRollback
     * eventlistener methods
1073
     *
1074 1075 1076
     * @param string $savepoint                 name of a savepoint to rollback to   
     * @throws Doctrine_Transaction_Exception   if the rollback operation fails at database level
     * @return boolean                          false if rollback couldn't be performed, true otherwise
1077
     */
1078
    public function rollback($savepoint = null)
1079
    {
1080
        $this->transaction->rollback($savepoint);
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
    }
    /**
     * returns a string representation of this object
     * @return string
     */
    public function __toString()
    {
        return Doctrine_Lib::getConnectionAsString($this);
    }
}