Home | Classes | Modules | Annotated | Functions | Files

MSSQLCallableStatement.php

Go to the documentation of this file.

<?php
/*
 *  $Id: MSSQLCallableStatement.php,v 1.2 2004/05/22 13:43:36 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>.
 */

require_once 'creole/drivers/mssql/MSSQLPreparedStatement.php';
include_once 'creole/CreoleTypes.php';

class MSSQLCallableStatement extends MSSQLPreparedStatement
{
  var $boundOutVars = array();
  
  /*var $typeMap = array(); */    
  var $stmt;


  var $result;
    
  function MSSQLCallableStatement(/*Connection*/ &$conn, $stmt)
  {
    if (! is_a($table, 'Connection')) {
      trigger_error(
        "MSSQLCallableStatement::MSSQLCallableStatement(): parameter 1 not of type 'Connection' !",
        E_USER_ERROR
      );
    }

    $this->conn =& $conn;
    $this->stmt = $stmt;
  }   
    
  function getResource()
  {
    return $this->stmt;
  }
      
  function close()
  {
    @mssql_free_statement($this->stmt);
    $this->rsFetchCount = 0;
  }
  
  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]);
      }
    }
    
    // no need to copy offset/limit in this class, because
    // we're not modifying an SQL here
    if ($this->offset > 0 && !($this->limit > 0)) {
      return new SQLException(CREOLE_ERROR, 'Cannot specify an offset without limit.');
    }
    
    $this->result = mssql_execute($this->stmt);
    if (!$this->result) {
      return new SQLException(CREOLE_ERROR, 'unable to execute callable statement', mssql_get_last_message());
    }
    
    return new MSSQLResultSet($this->conn, $this->result, $fetchmode, $this->offset, $this->limit);
  }
  
  function getMoreResults()
  {
    $this->rsFetchCount++; // we track this because 
    $hasMore = mssql_next_result($this->result);
    if ($this->resultSet) $this->resultSet->close();                    
    if ($hasMore) {
      $clazz = $this->resultClass;
      $this->resultSet =& new $clazz($this, $this->result);
    } else {
      $this->resultSet = null;
    }
    return $hasMore;
  }

  function registerOutParameter($paramIndex, $sqlType)
  {
    /* $typeMap seems to be only used here, so keep it simple */
    static $typeMap;
    
    if ($typeMap === null) 
    {
      $typeMap = array
      (
        CreoleTypes::BOOLEAN() => SQLBIT,
        CreoleTypes::BIGINT() => SQLINT4,
        CreoleTypes::SMALLINT() => SQLINT2,
        CreoleTypes::TINYINT() => SQLINT2,
        CreoleTypes::INTEGER() => SQLINT4,
        CreoleTypes::CHAR() => SQLCHAR,
        CreoleTypes::VARCHAR() => SQLVARCHAR,
        CreoleTypes::TEXT() => SQLTEXT,
        CreoleTypes::FLOAT() => SQLFLT8,
        CreoleTypes::DOUBLE() => SQLFLT8,
        CreoleTypes::DATE() => SQLVARCHAR,
        CreoleTypes::TIME() => SQLVARCHAR,
        CreoleTypes::TIMESTAMP() => SQLVARCHAR,
        CreoleTypes::VARBINARY() => SQLVARCHAR,
        CreoleTypes::NUMERIC() => SQLINT4,
        CreoleTypes::DECIMAL() => SQLFLT8                                        
      );
    }

    mssql_bind($this->stmt, $paramIndex, $this->boundOutVars[$paramIndex], $typeMap[$sqlType], true);
  }
  
  function setArray($paramIndex, &$value, $out = false) 
  {
    if ($out) $this->boundOutVars[$paramIndex] = &$value; // reference means that changes to value, will be reflected
    if ($value === null) {
      $this->setNull($paramIndex);
    } else {
      $value = serialize($value);
      mssql_bind($this->stmt, $paramIndex, $value, SQLTEXT, $out);
    }
  }

  function setBoolean($paramIndex, &$value, $out = false) 
  {
    if ($out) $this->boundOutVars[$paramIndex] = &$value; // reference means that changes to value, will be reflected        
    if ($value === null) {
      $this->setNull($paramIndex);
    } else {
      $value = ($value) ? 1 : 0;
      mssql_bind($this->stmt, $paramIndex, $value, SQLBIT, $out);
    }
  }
  

  function setBlob($paramIndex, &$blob, $out = false) 
  {
    if ($blob === null) {
      $this->setNull($paramIndex);
    } else {
      if (is_object($blob)) {
        $blob = $blob->__toString();
      }
      if ($out) $this->boundOutVars[$paramIndex] = &$blob; // reference means that changes to value, will be reflected        
      $data = unpack("H*hex", $blob);
      mssql_bind($this->stmt, $paramIndex, $data, SQLTEXT, $out);
    }
  } 
  
  function setClob($paramIndex, &$clob, $out = false) 
  {
    if ($clob === null) {
      $this->setNull($paramIndex);
    } else {
      if (is_object($clob)) {
        $clob = $clob->__toString();
      }
      if ($out) $this->boundOutVars[$paramIndex] = &$clob; // reference means that changes to value, will be reflected
      mssql_bind($this->stmt, $paramIndex, $clob, SQLTEXT, $out);
    }
  }

  function setDate($paramIndex, &$value, $out = false) 
  {
    if ($out) $this->boundOutVars[$paramIndex] = &$value; // reference means that changes to value, will be reflected
    if ($value === null) {
      $this->setNull($paramIndex);
    } else {
      if (is_numeric($value)) $value = date("Y-m-d", $value);
      mssql_bind($this->stmt, $paramIndex, $value, SQLVARCHAR, $out);
    }
  } 
      
  function setFloat($paramIndex, &$value, $out = false) 
  {
    if ($out) $this->boundOutVars[$paramIndex] = &$value; // reference means that changes to value, will be reflected
    if ($value === null) {
      $this->setNull($paramIndex);
    } else {
      $value = (float) $value;
      mssql_bind($this->stmt, $paramIndex, $value, SQLFLT8, $out);
    }
  }
  
  function setInt($paramIndex, &$value, $out = false) 
  {
    if ($out) $this->boundOutVars[$paramIndex] = &$value; // reference means that changes to value, will be reflected
    if ($value === null) {
      $this->setNull($paramIndex);
    } else {
      $value = (int) $value;
      mssql_bind($this->stmt, $paramIndex, $value, SQLINT4, $out);
    }
  }    
  
  function setNull($paramIndex) 
  {
    // hopefully type isn't essential here :)
    $value = null; // wants a var to pass by reference
    mssql_bind($this->stmt, $paramIndex, $value, $type=null, $out=false, $is_null=true);
  }

  function setString($paramIndex, &$value, $out = false) 
  {    
    if ($out) $this->boundOutVars[$paramIndex] = &$value; // reference means that changes to value, will be reflected
    if ($value === null) {
      $this->setNull($paramIndex);
    } else {
      $value = (string) $value;            
      mssql_bind($this->stmt, $paramIndex, $value, SQLVARCHAR, $out);
    }
  } 
  
  function setTime($paramIndex, &$value, $out = false) 
  {    
    if ($out) $this->boundOutVars[$paramIndex] = &$value; // reference means that changes to value, will be reflected
    if ($value === null) {
      $this->setNull($paramIndex);
    } else {
      if (is_numeric($value)) $value = date("H:i:s", $value);
      mssql_bind($this->stmt, $paramIndex, $value, SQLVARCHAR, $out);
    }
  }
  
  function setTimestamp($paramIndex, &$value, $out = false) 
  {
    if ($out) $this->boundOutVars[$paramIndex] = &$value; // reference means that changes to value, will be reflected
    if ($value === null) {
      $this->setNull($paramIndex);
    } else {
      if (is_numeric($value)) $value = date('Y-m-d H:i:s', $value);
      mssql_bind($this->stmt, $paramIndex, $value, SQLVARCHAR, $out);
    }
  }            
      
  function getArray($paramIndex) 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
    return (array) unserialize($this->boundOutVars[$paramIndex]);
  } 

  function getBoolean($paramIndex) 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
    return (boolean) $this->boundOutVars[$paramIndex];
  }
          
  function & getBlob($paramIndex) 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
    require_once 'creole/util/Blob.php';
    $b =& new Blob();
    $b->setContents($this->boundOutVars[$paramIndex]);
    return $b;
  }     

  function & getClob($paramIndex) 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
    require_once 'creole/util/Clob.php';
    $c =& new Clob();
    $c->setContents($this->boundOutVars[$paramIndex]);
    return $c;
  } 
  
  function getDate($paramIndex, $fmt = '%Y-%m-%d') 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
    
    $ts = strtotime($this->boundOutVars[$paramIndex]);        
    if ($ts === -1) {
      return new SQLException(CREOLE_ERROR_INVALID, "Unable to convert value at column " . $paramIndex . " to timestamp: " . $this->boundOutVars[$paramIndex]);
    }        
    if (strpos($format, '%') !== false) {
      return strftime($format, $ts);
    } else {
      return date($format, $ts);
    }
    
    return $this->boundOutVars[$paramIndex];
  } 

  function getFloat($paramIndex) 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
    return (float) $this->boundOutVars[$paramIndex];
  }

  function getInt($paramIndex) 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
    return (int) $this->boundOutVars[$paramIndex];
  }            

  function getString($paramIndex) 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
    return (string) $this->boundOutVars[$paramIndex];
  } 

  function getTime($paramIndex, $format='%X') 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
    
    $ts = strtotime($this->boundOutVars[$paramIndex]);        
    if ($ts === -1) {
      return new SQLException(CREOLE_ERROR_INVALID, "Unable to convert value at column " . $paramIndex . " to timestamp: " . $this->boundOutVars[$paramIndex]);
    }        
    if (strpos($format, '%') !== false) {
      return strftime($format, $ts);
    } else {
      return date($format, $ts);
    }
  }

  function getTimestamp($paramIndex, $format = 'Y-m-d H:i:s') 
  {
    if (!array_key_exists($paramIndex, $this->boundOutVars)) {
      return new SQLException(CREOLE_ERROR_INVALID, 'Requesting variable not bound to output var: '.$paramIndex);
    }
    if ($this->boundOutVars[$paramIndex] === null) { return null; }
            
    $ts = strtotime($this->boundOutVars[$paramIndex]);        
    if ($ts === -1) {
      return new SQLException(CREOLE_ERROR_INVALID, "Unable to convert value at column " . $paramIndex . " to timestamp: " . $this->boundOutVars[$paramIndex]);
    }        
    if (strpos($format, '%') !== false) {
      return strftime($format, $ts);
    } else {
      return date($format, $ts);
    }
  }    

}

---

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