interface/modules/zend_modules/library/Zend/Db/Adapter/Driver/Pdo/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\Pdo;
  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 \PDO
  22      */
  23     protected $pdo = null;
  24
  25     /**
  26      * @var Profiler\ProfilerInterface
  27      */
  28     protected $profiler = null;
  29
  30     /**
  31      * @var Pdo
  32      */
  33     protected $driver = null;
  34
  35     /**
  36      *
  37      * @var string
  38      */
  39     protected $sql = '';
  40
  41     /**
  42      *
  43      * @var bool
  44      */
  45     protected $isQuery = null;
  46
  47     /**
  48      *
  49      * @var ParameterContainer
  50      */
  51     protected $parameterContainer = null;
  52
  53     /**
  54      * @var bool
  55      */
  56     protected $parametersBound = false;
  57
  58     /**
  59      * @var \PDOStatement
  60      */
  61     protected $resource = null;
  62
  63     /**
  64      *
  65      * @var bool
  66      */
  67     protected $isPrepared = false;
  68
  69     /**
  70      * Set driver
  71      *
  72      * @param  Pdo $driver
  73      * @return Statement
  74      */
  75     public function setDriver(Pdo $driver)
  76     {
  77         $this->driver = $driver;
  78         return $this;
  79     }
  80
  81     /**
  82      * @param Profiler\ProfilerInterface $profiler
  83      * @return Statement
  84      */
  85     public function setProfiler(Profiler\ProfilerInterface $profiler)
  86     {
  87         $this->profiler = $profiler;
  88         return $this;
  89     }
  90
  91     /**
  92      * @return null|Profiler\ProfilerInterface
  93      */
  94     public function getProfiler()
  95     {
  96         return $this->profiler;
  97     }
  98
  99     /**
 100      * Initialize
 101      *
 102      * @param  \PDO $connectionResource
 103      * @return Statement
 104      */
 105     public function initialize(\PDO $connectionResource)
 106     {
 107         $this->pdo = $connectionResource;
 108         return $this;
 109     }
 110
 111     /**
 112      * Set resource
 113      *
 114      * @param  \PDOStatement $pdoStatement
 115      * @return Statement
 116      */
 117     public function setResource(\PDOStatement $pdoStatement)
 118     {
 119         $this->resource = $pdoStatement;
 120         return $this;
 121     }
 122
 123     /**
 124      * Get resource
 125      *
 126      * @return mixed
 127      */
 128     public function getResource()
 129     {
 130         return $this->resource;
 131     }
 132
 133     /**
 134      * Set sql
 135      *
 136      * @param string $sql
 137      * @return Statement
 138      */
 139     public function setSql($sql)
 140     {
 141         $this->sql = $sql;
 142         return $this;
 143     }
 144
 145     /**
 146      * Get sql
 147      *
 148      * @return string
 149      */
 150     public function getSql()
 151     {
 152         return $this->sql;
 153     }
 154
 155     /**
 156      * @param ParameterContainer $parameterContainer
 157      * @return Statement
 158      */
 159     public function setParameterContainer(ParameterContainer $parameterContainer)
 160     {
 161         $this->parameterContainer = $parameterContainer;
 162         return $this;
 163     }
 164
 165     /**
 166      * @return ParameterContainer
 167      */
 168     public function getParameterContainer()
 169     {
 170         return $this->parameterContainer;
 171     }
 172
 173     /**
 174      * @param string $sql
 175      * @throws Exception\RuntimeException
 176      */
 177     public function prepare($sql = null)
 178     {
 179         if ($this->isPrepared) {
 180             throw new Exception\RuntimeException('This statement has been prepared already');
 181         }
 182
 183         if ($sql == null) {
 184             $sql = $this->sql;
 185         }
 186
 187         $this->resource = $this->pdo->prepare($sql);
 188
 189         if ($this->resource === false) {
 190             $error = $this->pdo->errorInfo();
 191             throw new Exception\RuntimeException($error[2]);
 192         }
 193
 194         $this->isPrepared = true;
 195     }
 196
 197     /**
 198      * @return bool
 199      */
 200     public function isPrepared()
 201     {
 202         return $this->isPrepared;
 203     }
 204
 205     /**
 206      * @param mixed $parameters
 207      * @throws Exception\InvalidQueryException
 208      * @return Result
 209      */
 210     public function execute($parameters = null)
 211     {
 212         if (!$this->isPrepared) {
 213             $this->prepare();
 214         }
 215
 216         /** START Standard ParameterContainer Merging Block */
 217         if (!$this->parameterContainer instanceof ParameterContainer) {
 218             if ($parameters instanceof ParameterContainer) {
 219                 $this->parameterContainer = $parameters;
 220                 $parameters = null;
 221             } else {
 222                 $this->parameterContainer = new ParameterContainer();
 223             }
 224         }
 225
 226         if (is_array($parameters)) {
 227             $this->parameterContainer->setFromArray($parameters);
 228         }
 229
 230         if ($this->parameterContainer->count() > 0) {
 231             $this->bindParametersFromContainer();
 232         }
 233         /** END Standard ParameterContainer Merging Block */
 234
 235         if ($this->profiler) {
 236             $this->profiler->profilerStart($this);
 237         }
 238
 239         try {
 240             $this->resource->execute();
 241         } catch (\PDOException $e) {
 242             if ($this->profiler) {
 243                 $this->profiler->profilerFinish();
 244             }
 245             throw new Exception\InvalidQueryException('Statement could not be executed', null, $e);
 246         }
 247
 248         if ($this->profiler) {
 249             $this->profiler->profilerFinish();
 250         }
 251
 252         $result = $this->driver->createResult($this->resource, $this);
 253         return $result;
 254     }
 255
 256     /**
 257      * Bind parameters from container
 258      */
 259     protected function bindParametersFromContainer()
 260     {
 261         if ($this->parametersBound) {
 262             return;
 263         }
 264
 265         $parameters = $this->parameterContainer->getNamedArray();
 266         foreach ($parameters as $name => &$value) {
 267             $type = \PDO::PARAM_STR;
 268             if ($this->parameterContainer->offsetHasErrata($name)) {
 269                 switch ($this->parameterContainer->offsetGetErrata($name)) {
 270                     case ParameterContainer::TYPE_INTEGER:
 271                         $type = \PDO::PARAM_INT;
 272                         break;
 273                     case ParameterContainer::TYPE_NULL:
 274                         $type = \PDO::PARAM_NULL;
 275                         break;
 276                     case ParameterContainer::TYPE_LOB:
 277                         $type = \PDO::PARAM_LOB;
 278                         break;
 279                     case (is_bool($value)):
 280                         $type = \PDO::PARAM_BOOL;
 281                         break;
 282                 }
 283             }
 284
 285             // parameter is named or positional, value is reference
 286             $parameter = is_int($name) ? ($name + 1) : $name;
 287             $this->resource->bindParam($parameter, $value, $type);
 288         }
 289
 290     }
 291
 292     /**
 293      * Perform a deep clone
 294      * @return Statement A cloned statement
 295      */
 296     public function __clone()
 297     {
 298         $this->isPrepared = false;
 299         $this->parametersBound = false;
 300         $this->resource = null;
 301         if ($this->parameterContainer) {
 302             $this->parameterContainer = clone $this->parameterContainer;
 303         }
 304
 305     }
 306 }