interface/modules/zend_modules/library/Zend/Db/Sql/Expression.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 class Expression implements ExpressionInterface
  13 {
  14     /**
  15      * @const
  16      */
  17     const PLACEHOLDER = '?';
  18
  19     /**
  20      * @var string
  21      */
  22     protected $expression = '';
  23
  24     /**
  25      * @var array
  26      */
  27     protected $parameters = array();
  28
  29     /**
  30      * @var array
  31      */
  32     protected $types = array();
  33
  34     /**
  35      * @param string $expression
  36      * @param string|array $parameters
  37      * @param array $types
  38      */
  39     public function __construct($expression = '', $parameters = null, array $types = array())
  40     {
  41         if ($expression) {
  42             $this->setExpression($expression);
  43         }
  44         if ($parameters) {
  45             $this->setParameters($parameters);
  46         }
  47         if ($types) {
  48             $this->setTypes($types);
  49         }
  50     }
  51
  52     /**
  53      * @param $expression
  54      * @return Expression
  55      * @throws Exception\InvalidArgumentException
  56      */
  57     public function setExpression($expression)
  58     {
  59         if (!is_string($expression) || $expression == '') {
  60             throw new Exception\InvalidArgumentException('Supplied expression must be a string.');
  61         }
  62         $this->expression = $expression;
  63         return $this;
  64     }
  65
  66     /**
  67      * @return string
  68      */
  69     public function getExpression()
  70     {
  71         return $this->expression;
  72     }
  73
  74     /**
  75      * @param $parameters
  76      * @return Expression
  77      * @throws Exception\InvalidArgumentException
  78      */
  79     public function setParameters($parameters)
  80     {
  81         if (!is_scalar($parameters) && !is_array($parameters)) {
  82             throw new Exception\InvalidArgumentException('Expression parameters must be a scalar or array.');
  83         }
  84         $this->parameters = $parameters;
  85         return $this;
  86     }
  87
  88     /**
  89      * @return array
  90      */
  91     public function getParameters()
  92     {
  93         return $this->parameters;
  94     }
  95
  96     /**
  97      * @param array $types
  98      * @return Expression
  99      */
 100     public function setTypes(array $types)
 101     {
 102         $this->types = $types;
 103         return $this;
 104     }
 105
 106     /**
 107      * @return array
 108      */
 109     public function getTypes()
 110     {
 111         return $this->types;
 112     }
 113
 114     /**
 115      * @return array
 116      * @throws Exception\RuntimeException
 117      */
 118     public function getExpressionData()
 119     {
 120         $parameters = (is_scalar($this->parameters)) ? array($this->parameters) : $this->parameters;
 121
 122         $types = array();
 123         $parametersCount = count($parameters);
 124
 125         if ($parametersCount == 0 && strpos($this->expression, self::PLACEHOLDER) !== false) {
 126             // if there are no parameters, but there is a placeholder
 127             $parametersCount = substr_count($this->expression, self::PLACEHOLDER);
 128             $parameters = array_fill(0, $parametersCount, null);
 129         }
 130
 131         for ($i = 0; $i < $parametersCount; $i++) {
 132             $types[$i] = (isset($this->types[$i]) && ($this->types[$i] == self::TYPE_IDENTIFIER || $this->types[$i] == self::TYPE_LITERAL))
 133                 ? $this->types[$i] : self::TYPE_VALUE;
 134         }
 135
 136         // assign locally, escaping % signs
 137         $expression = str_replace('%', '%%', $this->expression);
 138
 139         if ($parametersCount > 0) {
 140             $count = 0;
 141             $expression = str_replace(self::PLACEHOLDER, '%s', $expression, $count);
 142             if ($count !== $parametersCount) {
 143                 throw new Exception\RuntimeException('The number of replacements in the expression does not match the number of parameters');
 144             }
 145         }
 146
 147         return array(array(
 148             $expression,
 149             $parameters,
 150             $types
 151         ));
 152     }
 153 }