interface/modules/zend_modules/library/Zend/Db/Adapter/Driver/Mysqli/Connection.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\ConnectionInterface;
  13 use Zend\Db\Adapter\Exception;
  14 use Zend\Db\Adapter\Profiler;
  15
  16 class Connection implements ConnectionInterface, Profiler\ProfilerAwareInterface
  17 {
  18
  19     /**
  20      * @var Mysqli
  21      */
  22     protected $driver = null;
  23
  24     /**
  25      * @var Profiler\ProfilerInterface
  26      */
  27     protected $profiler = null;
  28
  29     /**
  30      * Connection parameters
  31      *
  32      * @var array
  33      */
  34     protected $connectionParameters = array();
  35
  36     /**
  37      * @var \mysqli
  38      */
  39     protected $resource = null;
  40
  41     /**
  42      * In transaction
  43      *
  44      * @var bool
  45      */
  46     protected $inTransaction = false;
  47
  48     /**
  49      * Constructor
  50      *
  51      * @param array|mysqli|null $connectionInfo
  52      * @throws \Zend\Db\Adapter\Exception\InvalidArgumentException
  53      */
  54     public function __construct($connectionInfo = null)
  55     {
  56         if (is_array($connectionInfo)) {
  57             $this->setConnectionParameters($connectionInfo);
  58         } elseif ($connectionInfo instanceof \mysqli) {
  59             $this->setResource($connectionInfo);
  60         } elseif (null !== $connectionInfo) {
  61             throw new Exception\InvalidArgumentException('$connection must be an array of parameters, a mysqli object or null');
  62         }
  63     }
  64
  65     /**
  66      * @param Mysqli $driver
  67      * @return Connection
  68      */
  69     public function setDriver(Mysqli $driver)
  70     {
  71         $this->driver = $driver;
  72         return $this;
  73     }
  74
  75     /**
  76      * @param Profiler\ProfilerInterface $profiler
  77      * @return Connection
  78      */
  79     public function setProfiler(Profiler\ProfilerInterface $profiler)
  80     {
  81         $this->profiler = $profiler;
  82         return $this;
  83     }
  84
  85     /**
  86      * @return null|Profiler\ProfilerInterface
  87      */
  88     public function getProfiler()
  89     {
  90         return $this->profiler;
  91     }
  92
  93     /**
  94      * Set connection parameters
  95      *
  96      * @param  array $connectionParameters
  97      * @return Connection
  98      */
  99     public function setConnectionParameters(array $connectionParameters)
 100     {
 101         $this->connectionParameters = $connectionParameters;
 102         return $this;
 103     }
 104
 105     /**
 106      * Get connection parameters
 107      *
 108      * @return array
 109      */
 110     public function getConnectionParameters()
 111     {
 112         return $this->connectionParameters;
 113     }
 114
 115     /**
 116      * Get current schema
 117      *
 118      * @return string
 119      */
 120     public function getCurrentSchema()
 121     {
 122         if (!$this->isConnected()) {
 123             $this->connect();
 124         }
 125
 126         /** @var $result \mysqli_result */
 127         $result = $this->resource->query('SELECT DATABASE()');
 128         $r = $result->fetch_row();
 129         return $r[0];
 130     }
 131
 132     /**
 133      * Set resource
 134      *
 135      * @param  \mysqli $resource
 136      * @return Connection
 137      */
 138     public function setResource(\mysqli $resource)
 139     {
 140         $this->resource = $resource;
 141         return $this;
 142     }
 143
 144     /**
 145      * Get resource
 146      *
 147      * @return \mysqli
 148      */
 149     public function getResource()
 150     {
 151         $this->connect();
 152         return $this->resource;
 153     }
 154
 155     /**
 156      * Connect
 157      *
 158      * @throws Exception\RuntimeException
 159      * @return Connection
 160      */
 161     public function connect()
 162     {
 163         if ($this->resource instanceof \mysqli) {
 164             return $this;
 165         }
 166
 167         // localize
 168         $p = $this->connectionParameters;
 169
 170         // given a list of key names, test for existence in $p
 171         $findParameterValue = function (array $names) use ($p) {
 172             foreach ($names as $name) {
 173                 if (isset($p[$name])) {
 174                     return $p[$name];
 175                 }
 176             }
 177             return;
 178         };
 179
 180         $hostname = $findParameterValue(array('hostname', 'host'));
 181         $username = $findParameterValue(array('username', 'user'));
 182         $password = $findParameterValue(array('password', 'passwd', 'pw'));
 183         $database = $findParameterValue(array('database', 'dbname', 'db', 'schema'));
 184         $port     = (isset($p['port'])) ? (int) $p['port'] : null;
 185         $socket   = (isset($p['socket'])) ? $p['socket'] : null;
 186
 187         $this->resource = new \mysqli();
 188         $this->resource->init();
 189
 190         if (!empty($p['driver_options'])) {
 191             foreach ($p['driver_options'] as $option => $value) {
 192                 if (is_string($option)) {
 193                     $option = strtoupper($option);
 194                     if (!defined($option)) {
 195                         continue;
 196                     }
 197                     $option = constant($option);
 198                 }
 199                 $this->resource->options($option, $value);
 200             }
 201         }
 202
 203         $this->resource->real_connect($hostname, $username, $password, $database, $port, $socket);
 204
 205         if ($this->resource->connect_error) {
 206             throw new Exception\RuntimeException(
 207                 'Connection error',
 208                 null,
 209                 new Exception\ErrorException($this->resource->connect_error, $this->resource->connect_errno)
 210             );
 211         }
 212
 213         if (!empty($p['charset'])) {
 214             $this->resource->set_charset($p['charset']);
 215         }
 216
 217         return $this;
 218     }
 219
 220     /**
 221      * Is connected
 222      *
 223      * @return bool
 224      */
 225     public function isConnected()
 226     {
 227         return ($this->resource instanceof \mysqli);
 228     }
 229
 230     /**
 231      * Disconnect
 232      *
 233      * @return void
 234      */
 235     public function disconnect()
 236     {
 237         if ($this->resource instanceof \mysqli) {
 238             $this->resource->close();
 239         }
 240         unset($this->resource);
 241     }
 242
 243     /**
 244      * Begin transaction
 245      *
 246      * @return void
 247      */
 248     public function beginTransaction()
 249     {
 250         if (!$this->isConnected()) {
 251             $this->connect();
 252         }
 253
 254         $this->resource->autocommit(false);
 255         $this->inTransaction = true;
 256     }
 257
 258     /**
 259      * Commit
 260      *
 261      * @return void
 262      */
 263     public function commit()
 264     {
 265         if (!$this->resource) {
 266             $this->connect();
 267         }
 268
 269         $this->resource->commit();
 270         $this->inTransaction = false;
 271         $this->resource->autocommit(true);
 272     }
 273
 274     /**
 275      * Rollback
 276      *
 277      * @throws Exception\RuntimeException
 278      * @return Connection
 279      */
 280     public function rollback()
 281     {
 282         if (!$this->resource) {
 283             throw new Exception\RuntimeException('Must be connected before you can rollback.');
 284         }
 285
 286         if (!$this->inTransaction) {
 287             throw new Exception\RuntimeException('Must call commit() before you can rollback.');
 288         }
 289
 290         $this->resource->rollback();
 291         $this->resource->autocommit(true);
 292         return $this;
 293     }
 294
 295     /**
 296      * Execute
 297      *
 298      * @param  string $sql
 299      * @throws Exception\InvalidQueryException
 300      * @return Result
 301      */
 302     public function execute($sql)
 303     {
 304         if (!$this->isConnected()) {
 305             $this->connect();
 306         }
 307
 308         if ($this->profiler) {
 309             $this->profiler->profilerStart($sql);
 310         }
 311
 312         $resultResource = $this->resource->query($sql);
 313
 314         if ($this->profiler) {
 315             $this->profiler->profilerFinish($sql);
 316         }
 317
 318         // if the returnValue is something other than a mysqli_result, bypass wrapping it
 319         if ($resultResource === false) {
 320             throw new Exception\InvalidQueryException($this->resource->error);
 321         }
 322
 323         $resultPrototype = $this->driver->createResult(($resultResource === true) ? $this->resource : $resultResource);
 324         return $resultPrototype;
 325     }
 326
 327     /**
 328      * Get last generated id
 329      *
 330      * @param  null $name Ignored
 331      * @return int
 332      */
 333     public function getLastGeneratedValue($name = null)
 334     {
 335         return $this->resource->insert_id;
 336     }
 337 }