<?php
/* 
| DBWrapper.php                                                           
| $Id$
+-------------------------------------------------------------------------+
| http://phpfunk.com                                                      |
| Copyright (c) 2006 Salvador T. Pimienta                                 |
| All Rights Reserved.                                                    |
+-------------------------------------------------------------------------+
| Redistribution and use in source and binary forms, with or without      |
| modification, are permitted provided that the following conditions      | 
| are met:                                                                |
|  * Redistributions of source code must retain the above copyright       |
| notice, this list of conditions and the following disclaimer.           |
| * Redistributions in binary form must reproduce the above copyright     |
| notice, this list of conditions and the following disclaimer in the     |
| documentation and/or other materials provided with the distribution.    |
| * Neither the name of the phpfunk.com nor the names of its              |
| contributors may be used to endorse or promote products derived from    |
| this software without specific prior written permission.                |
|                                                                         |
| 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.    |                               
+----------------------------------------------------------------------- */

# changelog
#--------------------------------------
# 2007-01-10 if an error occurs an error will be triggered rather than swallowed
# 2006-10-28 added transaction support

/**
* @package persistance
*/

// BAD: means having to add all new drivers to this file!, better: a factory that gives you
// the right type of driver class
require_once 'MySQLDriver.php';

/**
* Uses a driver to execute commands on 
* database SQL statements can contain placeholder ?'s which can be bound 
* by $args (ordered array).  Released under BSD license.
*
* @version 0.1
* @author Salvador T. Pimienta
* @copyright Copyright 2006 Salvador T. Pimienta  All Rights Reserved
*/
class DBWrapper {
    
    /**
    * @access private
    * @var driver object
    */
    var $driver;
    
    /**
    * @param mixed $driver a driver object
    */
    function DBWrapper( &$driver ) {
        $this->driver =& $driver;
    }
    
    function connect($host, $user, $password, $database) {
        return $this->driver->connect($host, $user, $password, $database);
    }
    
    function disconnect() {
        return $this->driver->disconnect();
    }
    
    function isConnected() {
        return $this->driver->isConnected();
    }
    
    /**
    * @return single row, or single value, or FALSE on error
    */
    function selectOne($sql, $args='', $FILE='', $LINE='') {
        return $this->driver->selectOne($sql, $args, $FILE, $LINE);
    }
    
    /**
    * @return array of assoc arrays, or NULL if no matches found, or FALSE on error
    */
    function selectRows($sql, $args='', $FILE='', $LINE='') {
        return $this->driver->selectRows($sql, $args, $FILE, $LINE);
    }
    
    /**
    * Returns ordered array of first column of each selected record in result set, so $sql need not be a query
    * that returns a single column (but probably should be)
    * @return array ordered array
    */
    function selectColumn($sql, $args='', $FILE='', $LINE='') {
        return $this->driver->selectColumn($sql, $args, $FILE, $LINE);
    }
    
    /**
    * @return number of rows affected
    */
    function execute($sql, $args='', $FILE='', $LINE='') {
        return $this->driver->execute($sql, $args, $FILE, $LINE);
    }
    
    /**
    * Prepare a statement for execution w/ executePrepared(), this is client-side prepared statement
    */
    function prepare($sql) {
        $this->driver->prepare($sql);
    }
    
    /**
    * Execute a prepared statement.
    * @param mixed $args scalar or ordered array
    */
    function executePrepared($args) {
        $this->driver->executePrepared($args);
    }
    
    /**
    * @return int number of rows affected by last query
    */
    function affectedRows() {
        return $this->driver->affectedRows();
    }
    
    /**
    * @return information on last error or FALSE if there was none
    * @todo accumulate errors?
    */
    function lastError() {
        return $this->driver->lastError();
    }
    
    /**
     * The driver will attempt to return the last insert ID or FALSE if feature is not supported
     */
    function lastInsertID() {
        return $this->driver->lastInsertID();
    }
    
    /**
     * Private (package private) method to strip slashes
     */
    function array_stripslashes(&$var) {
        if(is_array($var)) {
            return array_map(array('DBWrapper', 'array_stripslashes'), $var);
        } else {
            return stripslashes($var);
        }
    }
    
    /**
     * Returns FALSE if unable to start transaction
     */
    function startTransaction() {
        $res = $this->driver->startTransaction();
        if($res === FALSE) {
            trigger_error("DBWrapper::startTransaction - transactions not supported");
        }
        return $res;
    }
    
    /**
     * Returns FALSE if unable to commit
     */
    function commit() {
        $this->driver->commit();
    }
    
    /**
     * Returns FALSE if unable to rollback!
     */
    function rollback() {
        $this->driver->rollback();
    }

    function escape($arg) {
        return $this->driver->escape($arg);
    }
}
?>