interface/modules/zend_modules/library/Zend/Db/Adapter/Driver/Oci8/Oci8.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\Oci8;
  11
  12 use Zend\Db\Adapter\Driver\DriverInterface;
  13 use Zend\Db\Adapter\Exception;
  14 use Zend\Db\Adapter\Profiler;
  15
  16 class Oci8 implements DriverInterface, Profiler\ProfilerAwareInterface
  17 {
  18
  19     /**
  20      * @var Connection
  21      */
  22     protected $connection = null;
  23
  24     /**
  25      * @var Statement
  26      */
  27     protected $statementPrototype = null;
  28
  29     /**
  30      * @var Result
  31      */
  32     protected $resultPrototype = null;
  33
  34     /**
  35      * @var Profiler\ProfilerInterface
  36      */
  37     protected $profiler = null;
  38
  39     /**
  40      * @var array
  41      */
  42     protected $options = array(
  43
  44     );
  45
  46     /**
  47      * @param array|Connection|\oci8 $connection
  48      * @param null|Statement $statementPrototype
  49      * @param null|Result $resultPrototype
  50      * @param array $options
  51      */
  52     public function __construct($connection, Statement $statementPrototype = null, Result $resultPrototype = null, array $options = array())
  53     {
  54         if (!$connection instanceof Connection) {
  55             $connection = new Connection($connection);
  56         }
  57
  58         $options = array_intersect_key(array_merge($this->options, $options), $this->options);
  59
  60         $this->registerConnection($connection);
  61         $this->registerStatementPrototype(($statementPrototype) ?: new Statement());
  62         $this->registerResultPrototype(($resultPrototype) ?: new Result());
  63     }
  64
  65     /**
  66      * @param Profiler\ProfilerInterface $profiler
  67      * @return Oci8
  68      */
  69     public function setProfiler(Profiler\ProfilerInterface $profiler)
  70     {
  71         $this->profiler = $profiler;
  72         if ($this->connection instanceof Profiler\ProfilerAwareInterface) {
  73             $this->connection->setProfiler($profiler);
  74         }
  75         if ($this->statementPrototype instanceof Profiler\ProfilerAwareInterface) {
  76             $this->statementPrototype->setProfiler($profiler);
  77         }
  78         return $this;
  79     }
  80
  81     /**
  82      * @return null|Profiler\ProfilerInterface
  83      */
  84     public function getProfiler()
  85     {
  86         return $this->profiler;
  87     }
  88
  89     /**
  90      * Register connection
  91      *
  92      * @param  Connection $connection
  93      * @return Oci8
  94      */
  95     public function registerConnection(Connection $connection)
  96     {
  97         $this->connection = $connection;
  98         $this->connection->setDriver($this); // needs access to driver to createStatement()
  99         return $this;
 100     }
 101
 102     /**
 103      * Register statement prototype
 104      *
 105      * @param Statement $statementPrototype
 106      * @return Oci8
 107      */
 108     public function registerStatementPrototype(Statement $statementPrototype)
 109     {
 110         $this->statementPrototype = $statementPrototype;
 111         $this->statementPrototype->setDriver($this); // needs access to driver to createResult()
 112         return $this;
 113     }
 114
 115     /**
 116      * @return null|Statement
 117      */
 118     public function getStatementPrototype()
 119     {
 120         return $this->statementPrototype;
 121     }
 122
 123     /**
 124      * Register result prototype
 125      *
 126      * @param Result $resultPrototype
 127      * @return Oci8
 128      */
 129     public function registerResultPrototype(Result $resultPrototype)
 130     {
 131         $this->resultPrototype = $resultPrototype;
 132         return $this;
 133     }
 134
 135     /**
 136      * @return null|Result
 137      */
 138     public function getResultPrototype()
 139     {
 140         return $this->resultPrototype;
 141     }
 142
 143     /**
 144      * Get database platform name
 145      *
 146      * @param  string $nameFormat
 147      * @return string
 148      */
 149     public function getDatabasePlatformName($nameFormat = self::NAME_FORMAT_CAMELCASE)
 150     {
 151         return 'Oracle';
 152     }
 153
 154     /**
 155      * Check environment
 156      */
 157     public function checkEnvironment()
 158     {
 159         if (!extension_loaded('oci8')) {
 160             throw new Exception\RuntimeException('The Oci8 extension is required for this adapter but the extension is not loaded');
 161         }
 162     }
 163
 164     /**
 165      * @return Connection
 166      */
 167     public function getConnection()
 168     {
 169         return $this->connection;
 170     }
 171
 172     /**
 173      * @param string $sqlOrResource
 174      * @return Statement
 175      */
 176     public function createStatement($sqlOrResource = null)
 177     {
 178         $statement = clone $this->statementPrototype;
 179         if (is_resource($sqlOrResource) && get_resource_type($sqlOrResource) == 'oci8 statement') {
 180             $statement->setResource($sqlOrResource);
 181         } else {
 182             if (is_string($sqlOrResource)) {
 183                 $statement->setSql($sqlOrResource);
 184             } elseif ($sqlOrResource !== null) {
 185                 throw new Exception\InvalidArgumentException(
 186                     'Oci8 only accepts an SQL string or a oci8 resource in ' . __FUNCTION__
 187                 );
 188             }
 189             if (!$this->connection->isConnected()) {
 190                 $this->connection->connect();
 191             }
 192             $statement->initialize($this->connection->getResource());
 193         }
 194         return $statement;
 195     }
 196
 197     /**
 198      * @param  resource $resource
 199      * @param  null     $isBuffered
 200      * @return Result
 201      */
 202     public function createResult($resource, $isBuffered = null)
 203     {
 204         $result = clone $this->resultPrototype;
 205         $result->initialize($resource, $this->connection->getLastGeneratedValue(), $isBuffered);
 206         return $result;
 207     }
 208
 209     /**
 210      * @return array
 211      */
 212     public function getPrepareType()
 213     {
 214         return self::PARAMETERIZATION_NAMED;
 215     }
 216
 217     /**
 218      * @param string $name
 219      * @param mixed  $type
 220      * @return string
 221      */
 222     public function formatParameterName($name, $type = null)
 223     {
 224         return ':' . $name;
 225     }
 226
 227     /**
 228      * @return mixed
 229      */
 230     public function getLastGeneratedValue()
 231     {
 232         return $this->getConnection()->getLastGeneratedValue();
 233     }
 234
 235 }