interface/modules/zend_modules/library/Zend/Db/Adapter/Driver/Mysqli/Statement.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Db\Adapter\Driver\Mysqli;
  11
  12 use Zend\Db\Adapter\Driver\StatementInterface;
  13 use Zend\Db\Adapter\Exception;
  14 use Zend\Db\Adapter\ParameterContainer;
  15 use Zend\Db\Adapter\Profiler;
  16
  17 class Statement implements StatementInterface, Profiler\ProfilerAwareInterface
  18 {
  19
  20     /**
  21      * @var \mysqli
  22      */
  23     protected $mysqli = null;
  24
  25     /**
  26      * @var Mysqli
  27      */
  28     protected $driver = null;
  29
  30     /**
  31      * @var Profiler\ProfilerInterface
  32      */
  33     protected $profiler = null;
  34
  35     /**
  36      * @var string
  37      */
  38     protected $sql = '';
  39
  40     /**
  41      * Parameter container
  42      *
  43      * @var ParameterContainer
  44      */
  45     protected $parameterContainer = null;
  46
  47     /**
  48      * @var \mysqli_stmt
  49      */
  50     protected $resource = null;
  51
  52     /**
  53      * Is prepared
  54      *
  55      * @var bool
  56      */
  57     protected $isPrepared = false;
  58
  59     /**
  60      * @var bool
  61      */
  62     protected $bufferResults = false;
  63
  64     /**
  65      * @param  bool $bufferResults
  66      */
  67     public function __construct($bufferResults = false)
  68     {
  69         $this->bufferResults = (bool) $bufferResults;
  70     }
  71
  72     /**
  73      * Set driver
  74      *
  75      * @param  Mysqli $driver
  76      * @return Statement
  77      */
  78     public function setDriver(Mysqli $driver)
  79     {
  80         $this->driver = $driver;
  81         return $this;
  82     }
  83
  84     /**
  85      * @param Profiler\ProfilerInterface $profiler
  86      * @return Statement
  87      */
  88     public function setProfiler(Profiler\ProfilerInterface $profiler)
  89     {
  90         $this->profiler = $profiler;
  91         return $this;
  92     }
  93
  94     /**
  95      * @return null|Profiler\ProfilerInterface
  96      */
  97     public function getProfiler()
  98     {
  99         return $this->profiler;
 100     }
 101
 102     /**
 103      * Initialize
 104      *
 105      * @param  \mysqli $mysqli
 106      * @return Statement
 107      */
 108     public function initialize(\mysqli $mysqli)
 109     {
 110         $this->mysqli = $mysqli;
 111         return $this;
 112     }
 113
 114     /**
 115      * Set sql
 116      *
 117      * @param  string $sql
 118      * @return Statement
 119      */
 120     public function setSql($sql)
 121     {
 122         $this->sql = $sql;
 123         return $this;
 124     }
 125
 126     /**
 127      * Set Parameter container
 128      *
 129      * @param ParameterContainer $parameterContainer
 130      * @return Statement
 131      */
 132     public function setParameterContainer(ParameterContainer $parameterContainer)
 133     {
 134         $this->parameterContainer = $parameterContainer;
 135         return $this;
 136     }
 137
 138     /**
 139      * Get resource
 140      *
 141      * @return mixed
 142      */
 143     public function getResource()
 144     {
 145         return $this->resource;
 146     }
 147
 148     /**
 149      * Set resource
 150      *
 151      * @param  \mysqli_stmt $mysqliStatement
 152      * @return Statement
 153      */
 154     public function setResource(\mysqli_stmt $mysqliStatement)
 155     {
 156         $this->resource = $mysqliStatement;
 157         $this->isPrepared = true;
 158         return $this;
 159     }
 160
 161     /**
 162      * Get sql
 163      *
 164      * @return string
 165      */
 166     public function getSql()
 167     {
 168         return $this->sql;
 169     }
 170
 171     /**
 172      * Get parameter count
 173      *
 174      * @return ParameterContainer
 175      */
 176     public function getParameterContainer()
 177     {
 178         return $this->parameterContainer;
 179     }
 180
 181     /**
 182      * Is prepared
 183      *
 184      * @return bool
 185      */
 186     public function isPrepared()
 187     {
 188         return $this->isPrepared;
 189     }
 190
 191     /**
 192      * Prepare
 193      *
 194      * @param string $sql
 195      * @throws Exception\InvalidQueryException
 196      * @throws Exception\RuntimeException
 197      * @return Statement
 198      */
 199     public function prepare($sql = null)
 200     {
 201         if ($this->isPrepared) {
 202             throw new Exception\RuntimeException('This statement has already been prepared');
 203         }
 204
 205         $sql = ($sql) ?: $this->sql;
 206
 207         $this->resource = $this->mysqli->prepare($sql);
 208         if (!$this->resource instanceof \mysqli_stmt) {
 209             throw new Exception\InvalidQueryException(
 210                 'Statement couldn\'t be produced with sql: ' . $sql,
 211                 null,
 212                 new Exception\ErrorException($this->mysqli->error, $this->mysqli->errno)
 213             );
 214         }
 215
 216         $this->isPrepared = true;
 217         return $this;
 218     }
 219
 220     /**
 221      * Execute
 222      *
 223      * @param  ParameterContainer|array $parameters
 224      * @throws Exception\RuntimeException
 225      * @return mixed
 226      */
 227     public function execute($parameters = null)
 228     {
 229         if (!$this->isPrepared) {
 230             $this->prepare();
 231         }
 232
 233         /** START Standard ParameterContainer Merging Block */
 234         if (!$this->parameterContainer instanceof ParameterContainer) {
 235             if ($parameters instanceof ParameterContainer) {
 236                 $this->parameterContainer = $parameters;
 237                 $parameters = null;
 238             } else {
 239                 $this->parameterContainer = new ParameterContainer();
 240             }
 241         }
 242
 243         if (is_array($parameters)) {
 244             $this->parameterContainer->setFromArray($parameters);
 245         }
 246
 247         if ($this->parameterContainer->count() > 0) {
 248             $this->bindParametersFromContainer();
 249         }
 250         /** END Standard ParameterContainer Merging Block */
 251
 252         if ($this->profiler) {
 253             $this->profiler->profilerStart($this);
 254         }
 255
 256         $return = $this->resource->execute();
 257
 258         if ($this->profiler) {
 259             $this->profiler->profilerFinish();
 260         }
 261
 262         if ($return === false) {
 263             throw new Exception\RuntimeException($this->resource->error);
 264         }
 265
 266         if ($this->bufferResults === true) {
 267             $this->resource->store_result();
 268             $this->isPrepared = false;
 269             $buffered = true;
 270         } else {
 271             $buffered = false;
 272         }
 273
 274         $result = $this->driver->createResult($this->resource, $buffered);
 275         return $result;
 276     }
 277
 278     /**
 279      * Bind parameters from container
 280      *
 281      * @return void
 282      */
 283     protected function bindParametersFromContainer()
 284     {
 285         $parameters = $this->parameterContainer->getNamedArray();
 286         $type = '';
 287         $args = array();
 288
 289         foreach ($parameters as $name => &$value) {
 290             if ($this->parameterContainer->offsetHasErrata($name)) {
 291                 switch ($this->parameterContainer->offsetGetErrata($name)) {
 292                     case ParameterContainer::TYPE_DOUBLE:
 293                         $type .= 'd';
 294                         break;
 295                     case ParameterContainer::TYPE_NULL:
 296                         $value = null; // as per @see http://www.php.net/manual/en/mysqli-stmt.bind-param.php#96148
 297                     case ParameterContainer::TYPE_INTEGER:
 298                         $type .= 'i';
 299                         break;
 300                     case ParameterContainer::TYPE_STRING:
 301                     default:
 302                         $type .= 's';
 303                         break;
 304                 }
 305             } else {
 306                 $type .= 's';
 307             }
 308             $args[] = &$value;
 309         }
 310
 311         if ($args) {
 312             array_unshift($args, $type);
 313             call_user_func_array(array($this->resource, 'bind_param'), $args);
 314         }
 315     }
 316 }