Home | Classes | Modules | Annotated | Functions | Files

PreparedStatementCommon.php

Go to the documentation of this file.

<?php
/*
 *  $Id: PreparedStatementCommon.php,v 1.2 2004/03/29 18:46:46 micha 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>.
 */

//
// STATUS:
// - ported:   y
// - exceptions: y
// - compiled: y
// - tested:   n
//

require_once 'creole/PreparedStatement.php';

class PreparedStatementCommon extends PreparedStatement
{
    var $conn;

    var $limit = 0;

    var $offset = 0;

    var $sql;

    var $positions;


    var $positionsCount;

    var $boundInVars = array();

    var $resultSet;

    var $updateCount;

  function PreparedStatementCommon(/*Connection*/ &$conn, &$sql)
  {
    if (! is_a($conn, 'Connection')) {
      trigger_error (
        "PreparedStatementCommon::PreparedStatementCommon(): parameter 1 not of type 'Connection' !",
        E_USER_ERROR
      );
    }

    $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();
    $positionsCount = 0;
    $position = 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
  }

  function setLimit($v)
  {
    $this->limit = (int) $v;
  }

  function getLimit()
  {
    return $this->limit;
  }

  function setOffset($v)
  {
    $this->offset = (int) $v;
  }

  function getOffset()
  {
    return $this->offset;
  }

  function & getResultSet()
  {
    return $this->resultSet;
  }

  function getUpdateCount()
  {
    return $this->updateCount;
  }

  function getMoreResults()
  {
    if ($this->resultSet) $this->resultSet->close();
    $this->resultSet = null;
    return false;
  }

  function & getConnection()
  {
    return $this->conn;
  }

  function getResource()
  {
    return null;
  }

  function close()
  {
  }

  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])) {
        return new SQLException(CREOLE_ERROR, '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;
  }

  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 (Creole::isError($sql)) {
      return $sql;
    }

    if ($this->limit > 0) {
        $this->conn->applyLimit($sql, $this->offset, $this->limit);
    } elseif ($this->offset > 0) {
        return new SQLException(CREOLE_ERROR, 'Cannot specify an offset without limit.');
    }

    $this->resultSet =& $this->conn->executeQuery($sql, $fetchmode);
    return $this->resultSet;
  }

  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();

    if (Creole::isError($sql)) {
      return $sql;
    }

    $this->updateCount =& $this->conn->executeUpdate($sql);
    return $this->updateCount;
  }

  function escape(&$str)
  {
    trigger_error (
      "PreparedStatementCommon::escape(): abstract function has to be reimplemented !",
      E_USER_ERROR
    );
  }

  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 {
              return new SQLException(CREOLE_ERROR_UNSUPPORTED, "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);
      }

      return true;
  }

    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 {
            $this->boundInVars[$paramIndex] = "'" . $this->escape((string) $blob) . "'";
        }
    }

    function setClob($paramIndex, $clob)
    {
        if ($clob === null) {
            $this->setNull($paramIndex);
        } else {
            $this->boundInVars[$paramIndex] = "'" . $this->escape((string) $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 {
            $this->boundInVars[$paramIndex] = "'" . $this->escape( (string) $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[php4] library.