interface/modules/zend_modules/library/Zend/Db/Sql/AbstractSql.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\Sql;
  11
  12 use Zend\Db\Adapter\Driver\DriverInterface;
  13 use Zend\Db\Adapter\ParameterContainer;
  14 use Zend\Db\Adapter\Platform\PlatformInterface;
  15 use Zend\Db\Adapter\StatementContainer;
  16
  17 abstract class AbstractSql
  18 {
  19     /**
  20      * @var array
  21      */
  22     protected $specifications = array();
  23
  24     /**
  25      * @var string
  26      */
  27     protected $processInfo = array('paramPrefix' => '', 'subselectCount' => 0);
  28
  29     /**
  30      * @var array
  31      */
  32     protected $instanceParameterIndex = array();
  33
  34     protected function processExpression(ExpressionInterface $expression, PlatformInterface $platform, DriverInterface $driver = null, $namedParameterPrefix = null)
  35     {
  36         // static counter for the number of times this method was invoked across the PHP runtime
  37         static $runtimeExpressionPrefix = 0;
  38
  39         if ($driver && ((!is_string($namedParameterPrefix) || $namedParameterPrefix == ''))) {
  40             $namedParameterPrefix = sprintf('expr%04dParam', ++$runtimeExpressionPrefix);
  41         }
  42
  43         $sql = '';
  44         $statementContainer = new StatementContainer;
  45         $parameterContainer = $statementContainer->getParameterContainer();
  46
  47         // initialize variables
  48         $parts = $expression->getExpressionData();
  49
  50         if (!isset($this->instanceParameterIndex[$namedParameterPrefix])) {
  51             $this->instanceParameterIndex[$namedParameterPrefix] = 1;
  52         }
  53
  54         $expressionParamIndex = &$this->instanceParameterIndex[$namedParameterPrefix];
  55
  56         foreach ($parts as $part) {
  57
  58             // if it is a string, simply tack it onto the return sql "specification" string
  59             if (is_string($part)) {
  60                 $sql .= $part;
  61                 continue;
  62             }
  63
  64             if (!is_array($part)) {
  65                 throw new Exception\RuntimeException('Elements returned from getExpressionData() array must be a string or array.');
  66             }
  67
  68             // process values and types (the middle and last position of the expression data)
  69             $values = $part[1];
  70             $types = (isset($part[2])) ? $part[2] : array();
  71             foreach ($values as $vIndex => $value) {
  72                 if (isset($types[$vIndex]) && $types[$vIndex] == ExpressionInterface::TYPE_IDENTIFIER) {
  73                     $values[$vIndex] = $platform->quoteIdentifierInFragment($value);
  74                 } elseif (isset($types[$vIndex]) && $types[$vIndex] == ExpressionInterface::TYPE_VALUE && $value instanceof Select) {
  75                     // process sub-select
  76                     if ($driver) {
  77                         $values[$vIndex] = '(' . $this->processSubSelect($value, $platform, $driver, $parameterContainer) . ')';
  78                     } else {
  79                         $values[$vIndex] = '(' . $this->processSubSelect($value, $platform) . ')';
  80                     }
  81                 } elseif (isset($types[$vIndex]) && $types[$vIndex] == ExpressionInterface::TYPE_VALUE && $value instanceof ExpressionInterface) {
  82                     // recursive call to satisfy nested expressions
  83                     $innerStatementContainer = $this->processExpression($value, $platform, $driver, $namedParameterPrefix . $vIndex . 'subpart');
  84                     $values[$vIndex] = $innerStatementContainer->getSql();
  85                     if ($driver) {
  86                         $parameterContainer->merge($innerStatementContainer->getParameterContainer());
  87                     }
  88                 } elseif (isset($types[$vIndex]) && $types[$vIndex] == ExpressionInterface::TYPE_VALUE) {
  89
  90                     // if prepareType is set, it means that this particular value must be
  91                     // passed back to the statement in a way it can be used as a placeholder value
  92                     if ($driver) {
  93                         $name = $namedParameterPrefix . $expressionParamIndex++;
  94                         $parameterContainer->offsetSet($name, $value);
  95                         $values[$vIndex] = $driver->formatParameterName($name);
  96                         continue;
  97                     }
  98
  99                     // if not a preparable statement, simply quote the value and move on
 100                     $values[$vIndex] = $platform->quoteValue($value);
 101                 } elseif (isset($types[$vIndex]) && $types[$vIndex] == ExpressionInterface::TYPE_LITERAL) {
 102                     $values[$vIndex] = $value;
 103                 }
 104             }
 105
 106             // after looping the values, interpolate them into the sql string (they might be placeholder names, or values)
 107             $sql .= vsprintf($part[0], $values);
 108         }
 109
 110         $statementContainer->setSql($sql);
 111         return $statementContainer;
 112     }
 113
 114     /**
 115      * @param $specifications
 116      * @param $parameters
 117      * @return string
 118      * @throws Exception\RuntimeException
 119      */
 120     protected function createSqlFromSpecificationAndParameters($specifications, $parameters)
 121     {
 122         if (is_string($specifications)) {
 123             return vsprintf($specifications, $parameters);
 124         }
 125
 126         $parametersCount = count($parameters);
 127         foreach ($specifications as $specificationString => $paramSpecs) {
 128             if ($parametersCount == count($paramSpecs)) {
 129                 break;
 130             }
 131             unset($specificationString, $paramSpecs);
 132         }
 133
 134         if (!isset($specificationString)) {
 135             throw new Exception\RuntimeException(
 136                 'A number of parameters was found that is not supported by this specification'
 137             );
 138         }
 139
 140         $topParameters = array();
 141         foreach ($parameters as $position => $paramsForPosition) {
 142             if (isset($paramSpecs[$position]['combinedby'])) {
 143                 $multiParamValues = array();
 144                 foreach ($paramsForPosition as $multiParamsForPosition) {
 145                     $ppCount = count($multiParamsForPosition);
 146                     if (!isset($paramSpecs[$position][$ppCount])) {
 147                         throw new Exception\RuntimeException('A number of parameters (' . $ppCount . ') was found that is not supported by this specification');
 148                     }
 149                     $multiParamValues[] = vsprintf($paramSpecs[$position][$ppCount], $multiParamsForPosition);
 150                 }
 151                 $topParameters[] = implode($paramSpecs[$position]['combinedby'], $multiParamValues);
 152             } elseif ($paramSpecs[$position] !== null) {
 153                 $ppCount = count($paramsForPosition);
 154                 if (!isset($paramSpecs[$position][$ppCount])) {
 155                     throw new Exception\RuntimeException('A number of parameters (' . $ppCount . ') was found that is not supported by this specification');
 156                 }
 157                 $topParameters[] = vsprintf($paramSpecs[$position][$ppCount], $paramsForPosition);
 158             } else {
 159                 $topParameters[] = $paramsForPosition;
 160             }
 161         }
 162         return vsprintf($specificationString, $topParameters);
 163     }
 164
 165     protected function processSubSelect(Select $subselect, PlatformInterface $platform, DriverInterface $driver = null, ParameterContainer $parameterContainer = null)
 166     {
 167         if ($driver) {
 168             $stmtContainer = new StatementContainer;
 169
 170             // Track subselect prefix and count for parameters
 171             $this->processInfo['subselectCount']++;
 172             $subselect->processInfo['subselectCount'] = $this->processInfo['subselectCount'];
 173             $subselect->processInfo['paramPrefix'] = 'subselect' . $subselect->processInfo['subselectCount'];
 174
 175             // call subselect
 176             $subselect->prepareStatement(new \Zend\Db\Adapter\Adapter($driver, $platform), $stmtContainer);
 177
 178             // copy count
 179             $this->processInfo['subselectCount'] = $subselect->processInfo['subselectCount'];
 180
 181             $parameterContainer->merge($stmtContainer->getParameterContainer()->getNamedArray());
 182             $sql = $stmtContainer->getSql();
 183         } else {
 184             $sql = $subselect->getSqlString($platform);
 185         }
 186         return $sql;
 187     }
 188 }