interface/modules/zend_modules/library/Zend/Db/Adapter/Platform/Mysql.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\Platform;
  11
  12 use Zend\Db\Adapter\Driver\DriverInterface;
  13 use Zend\Db\Adapter\Driver\Mysqli;
  14 use Zend\Db\Adapter\Driver\Pdo;
  15 use Zend\Db\Adapter\Exception;
  16
  17 class Mysql implements PlatformInterface
  18 {
  19     /** @var \mysqli|\PDO */
  20     protected $resource = null;
  21
  22     public function __construct($driver = null)
  23     {
  24         if ($driver) {
  25             $this->setDriver($driver);
  26         }
  27     }
  28
  29     /**
  30      * @param \Zend\Db\Adapter\Driver\Mysqli\Mysqli|\Zend\Db\Adapter\Driver\Pdo\Pdo||\mysqli|\PDO $driver
  31      * @throws \Zend\Db\Adapter\Exception\InvalidArgumentException
  32      * @return $this
  33      */
  34     public function setDriver($driver)
  35     {
  36         // handle Zend\Db drivers
  37         if ($driver instanceof Mysqli\Mysqli
  38             || ($driver instanceof Pdo\Pdo && $driver->getDatabasePlatformName() == 'Mysql')
  39             || ($driver instanceof \mysqli)
  40             || ($driver instanceof \PDO && $driver->getAttribute(\PDO::ATTR_DRIVER_NAME) == 'mysql')
  41         ) {
  42             $this->resource = $driver;
  43             return $this;
  44         }
  45
  46         throw new Exception\InvalidArgumentException('$driver must be a Mysqli or Mysql PDO Zend\Db\Adapter\Driver, Mysqli instance or MySQL PDO instance');
  47     }
  48
  49     /**
  50      * Get name
  51      *
  52      * @return string
  53      */
  54     public function getName()
  55     {
  56         return 'MySQL';
  57     }
  58
  59     /**
  60      * Get quote identifier symbol
  61      *
  62      * @return string
  63      */
  64     public function getQuoteIdentifierSymbol()
  65     {
  66         return '`';
  67     }
  68
  69     /**
  70      * Quote identifier
  71      *
  72      * @param  string $identifier
  73      * @return string
  74      */
  75     public function quoteIdentifier($identifier)
  76     {
  77         return '`' . str_replace('`', '``', $identifier) . '`';
  78     }
  79
  80     /**
  81      * Quote identifier chain
  82      *
  83      * @param string|string[] $identifierChain
  84      * @return string
  85      */
  86     public function quoteIdentifierChain($identifierChain)
  87     {
  88         $identifierChain = str_replace('`', '``', $identifierChain);
  89         if (is_array($identifierChain)) {
  90             $identifierChain = implode('`.`', $identifierChain);
  91         }
  92         return '`' . $identifierChain . '`';
  93     }
  94
  95     /**
  96      * Get quote value symbol
  97      *
  98      * @return string
  99      */
 100     public function getQuoteValueSymbol()
 101     {
 102         return '\'';
 103     }
 104
 105     /**
 106      * Quote value
 107      *
 108      * @param  string $value
 109      * @return string
 110      */
 111     public function quoteValue($value)
 112     {
 113         if ($this->resource instanceof DriverInterface) {
 114             $this->resource = $this->resource->getConnection()->getResource();
 115         }
 116         if ($this->resource instanceof \mysqli) {
 117             return '\'' . $this->resource->real_escape_string($value) . '\'';
 118         }
 119         if ($this->resource instanceof \PDO) {
 120             return $this->resource->quote($value);
 121         }
 122         trigger_error(
 123             'Attempting to quote a value in ' . __CLASS__ . ' without extension/driver support '
 124                 . 'can introduce security vulnerabilities in a production environment.'
 125         );
 126         return '\'' . addcslashes($value, "\x00\n\r\\'\"\x1a") . '\'';
 127     }
 128
 129     /**
 130      * Quote Trusted Value
 131      *
 132      * The ability to quote values without notices
 133      *
 134      * @param $value
 135      * @return mixed
 136      */
 137     public function quoteTrustedValue($value)
 138     {
 139         if ($this->resource instanceof DriverInterface) {
 140             $this->resource = $this->resource->getConnection()->getResource();
 141         }
 142         if ($this->resource instanceof \mysqli) {
 143             return '\'' . $this->resource->real_escape_string($value) . '\'';
 144         }
 145         if ($this->resource instanceof \PDO) {
 146             return $this->resource->quote($value);
 147         }
 148         return '\'' . addcslashes($value, "\x00\n\r\\'\"\x1a") . '\'';
 149     }
 150
 151     /**
 152      * Quote value list
 153      *
 154      * @param string|string[] $valueList
 155      * @return string
 156      */
 157     public function quoteValueList($valueList)
 158     {
 159         if (!is_array($valueList)) {
 160             return $this->quoteValue($valueList);
 161         }
 162
 163         $value = reset($valueList);
 164         do {
 165             $valueList[key($valueList)] = $this->quoteValue($value);
 166         } while ($value = next($valueList));
 167         return implode(', ', $valueList);
 168     }
 169
 170     /**
 171      * Get identifier separator
 172      *
 173      * @return string
 174      */
 175     public function getIdentifierSeparator()
 176     {
 177         return '.';
 178     }
 179
 180     /**
 181      * Quote identifier in fragment
 182      *
 183      * @param  string $identifier
 184      * @param  array $safeWords
 185      * @return string
 186      */
 187     public function quoteIdentifierInFragment($identifier, array $safeWords = array())
 188     {
 189         // regex taken from @link http://dev.mysql.com/doc/refman/5.0/en/identifiers.html
 190         $parts = preg_split('#([^0-9,a-z,A-Z$_])#', $identifier, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
 191         if ($safeWords) {
 192             $safeWords = array_flip($safeWords);
 193             $safeWords = array_change_key_case($safeWords, CASE_LOWER);
 194         }
 195         foreach ($parts as $i => $part) {
 196             if ($safeWords && isset($safeWords[strtolower($part)])) {
 197                 continue;
 198             }
 199             switch ($part) {
 200                 case ' ':
 201                 case '.':
 202                 case '*':
 203                 case 'AS':
 204                 case 'As':
 205                 case 'aS':
 206                 case 'as':
 207                     break;
 208                 default:
 209                     $parts[$i] = '`' . str_replace('`', '``', $part) . '`';
 210             }
 211         }
 212         return implode('', $parts);
 213     }
 214 }