Home | Classes | Modules | Annotated | Hierarchy | Functions | Files

PreparedStatementCommon.php

Go to the documentation of this file.

<?php
/*
 *  $Id: PreparedStatementCommon.php,v 1.6 2004/04/13 12:23:02 hlellelid Exp $
 *
 * 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 please see
 * <http://creole.phpdb.org>.
 */

abstract class PreparedStatementCommon {

    protected $conn;
    
    protected $limit = 0;
    
    protected $offset = 0;
    
    protected $sql;

    protected $positions;


    protected $positionsCount;

    protected $boundInVars = array();    
    
    protected $resultSet;

    protected $updateCount;
    
    function __construct(Connection $conn, $sql) 
    {
        $this->conn = $conn;
        $this->sql = $sql;
        
        // get the positiosn for the '?' in the SQL
        // we can move this into its own method if it gets more complex
        $positions = array();
           $position = 0;
        $positionsCount = 0;
           while( $position < strlen($sql) && ($question = strpos($sql, '?', $position)) !== false ) {
            $positions[] = $question;
            $position = $question + 1; 
            $positionsCount++;                      
        }        
        
        $this->positions = $positions;
        $this->positionsCount = $positionsCount; // save processing later in cases where we may repeatedly exec statement
    }

    public function setLimit($v)
    {
        $this->limit = (int) $v;
    }
    
    public function getLimit()
    {
        return $this->limit;
    }
    
    public function setOffset($v)
    {
        $this->offset = (int) $v;
    }
    
    public function getOffset()
    {
        return $this->offset;
    }
    
    public function getResultSet()
    {
        return $this->resultSet;
    }

    public function getUpdateCount()
    {
        return $this->updateCount;
    }
    
    public function getMoreResults()
    {
        if ($this->resultSet) $this->resultSet->close();
        $this->resultSet = null;
        return false;
    }
     
    public function getConnection()
    {
        return $this->conn;
    }
    
    public function getResource()
    {
        return null;
    }
    
    public function close()
    {       
    }
    
    protected function replaceParams()
    {
        // Default behavior for this function is to behave in 'emulated' mode.    
        $sql = '';    
        $last_position = 0;

        for ($position = 0; $position < $this->positionsCount; $position++) {
            if (!isset($this->boundInVars[$position + 1])) {
                throw new SQLException('Replace params: undefined query param: ' . ($position + 1));
            }
            $current_position = $this->positions[$position];            
            $sql .= substr($this->sql, $last_position, $current_position - $last_position);
            $sql .= $this->boundInVars[$position + 1];                    
            $last_position = $current_position + 1;            
        }
        // append the rest of the query
        $sql .= substr($this->sql, $last_position);
        
        return $sql;
    }

    public function executeQuery($p1 = null, $fetchmode = null)
    {    
        $params = null;
        if ($fetchmode !== null) {
            $params = $p1;
        } elseif ($p1 !== null) {
            if (is_array($p1)) $params = $p1;
            else $fetchmode = $p1;
        }
        
        if ($params) {
            for($i=0,$cnt=count($params); $i < $cnt; $i++) {
                $this->set($i+1, $params[$i]);
            }
        }
        
        $this->updateCount = null; // reset
        $sql = $this->replaceParams();        
        
        if ($this->limit > 0) {
            $this->conn->applyLimit($sql, $this->offset, $this->limit);
        } elseif ($this->offset > 0) {
            throw new SQLException('Cannot specify an offset without limit.');
        }
        
        $this->resultSet = $this->conn->executeQuery($sql, $fetchmode);
        return $this->resultSet;
    }

    public function executeUpdate($params = null) 
    {
        if ($params) {
            for($i=0,$cnt=count($params); $i < $cnt; $i++) {
                $this->set($i+1, $params[$i]);
            }
        }

        if($this->resultSet) $this->resultSet->close();
        $this->resultSet = null; // reset                
        $sql = $this->replaceParams();        
        $this->updateCount = $this->conn->executeUpdate($sql);
        return $this->updateCount;
    }    

    abstract protected function escape($str);
    
    function set($paramIndex, $value)
    {
        $type = gettype($value);
        if ($type == "object") {
            if (is_a($value, 'Blob')) {
                $this->setBlob($paramIndex, $value);
            } elseif (is_a($value, 'Clob')) {
                $this->setClob($paramIndex, $value);
            } elseif (is_a($value, 'Date')) {
                 // can't be sure if the column type is a DATE, TIME, or TIMESTAMP column
                 // we'll just use TIMESTAMP by default; hopefully DB won't complain (if
                 // it does, then this method just shouldn't be used).
                 $this->setTimestamp($paramIndex, $value);
            } else {
                throw new SQLException("Unsupported object type passed to set(): " . get_class($value));
            }
        } else {
            if ($type == "integer") {
                $type = "int";
            } elseif ($type == "double") {
                $type = "float";
            }
            $setter = 'set' . ucfirst($type); // PHP types are case-insensitive, but we'll do this in case that changes
            $this->$setter($paramIndex, $value);
        }        
    }
    
    function setArray($paramIndex, $value) 
    {        
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = "'" . $this->escape(serialize($value)) . "'";
        }
    }

    function setBoolean($paramIndex, $value) 
    {                
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = (int) $value;
        }
    }
    

    function setBlob($paramIndex, $blob) 
    {        
        if ($blob === null) {
            $this->setNull($paramIndex);
        } else {
            // they took magic __toString() out of PHP5.0.0; this sucks
            if (is_object($blob)) {
                $blob = $blob->__toString();
            }            
            $this->boundInVars[$paramIndex] = "'" . $this->escape($blob) . "'";
        }
    } 

    function setClob($paramIndex, $clob) 
    {
        if ($clob === null) {
            $this->setNull($paramIndex);
        } else {      
            // they took magic __toString() out of PHP5.0.0; this sucks
            if (is_object($clob)) {
                $clob = $clob->__toString();
            }              
            $this->boundInVars[$paramIndex] = "'" . $this->escape($clob) . "'";
        }
    }     

    function setDate($paramIndex, $value) 
    {
        if (is_numeric($value)) $value = date("Y-m-d", $value);
        if (is_object($value)) $value = date("Y-m-d", $value->getTime());        
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = "'" . $this->escape($value) . "'";
        }
    } 
    
    function setDecimal($paramIndex, $value) 
    {
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = (float) $value;
        }
    }             

    function setDouble($paramIndex, $value) 
    {
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = (double) $value;
        }
    } 
        
    function setFloat($paramIndex, $value) 
    {
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = (float) $value;
        }
    } 

    function setInt($paramIndex, $value) 
    {
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = (int) $value;
        }
    } 
    
    function setInteger($paramIndex, $value)
    {
        $this->setInt($paramIndex, $value);
    }

    function setNull($paramIndex) 
    {
        $this->boundInVars[$paramIndex] = 'NULL';
    }

    function setString($paramIndex, $value) 
    {
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            // it's ok to have a fatal error here, IMO, if object doesn't have
            // __toString() and is being passed to this method.
            $value = (is_object($value) ? $value->__toString() : (string) $value);
            $this->boundInVars[$paramIndex] = "'" . $this->escape($value) . "'";
        }
    } 
    
    function setTime($paramIndex, $value) 
    {        
        if (is_numeric($value)) $value = date("H:i:s", $value);
        elseif (is_object($value)) $value = date("H:i:s", $value->getTime());
        
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = "'" . $this->escape($value) . "'";
        }
    }
    
    function setTimestamp($paramIndex, $value) 
    {
        if (is_numeric($value)) $value = date('Y-m-d H:i:s', $value);
        elseif (is_object($value)) $value = date("Y-m-d H:i:s", $value->getTime());
        
        if ($value === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = "'".$value."'";
        }
    }
            
}

---

This file is part of the Creole[php5] library.