interface/modules/zend_modules/library/Zend/Db/Sql/Predicate/In.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\Predicate;
  11
  12 use Zend\Db\Sql\Exception;
  13 use Zend\Db\Sql\Select;
  14
  15 class In implements PredicateInterface
  16 {
  17     protected $identifier;
  18     protected $valueSet;
  19
  20     protected $selectSpecification = '%s IN %s';
  21     protected $valueSpecSpecification = '%%s IN (%s)';
  22
  23     /**
  24      * Constructor
  25      *
  26      * @param  null|string $identifier
  27      * @param  array $valueSet
  28      */
  29     public function __construct($identifier = null, $valueSet = null)
  30     {
  31         if ($identifier) {
  32             $this->setIdentifier($identifier);
  33         }
  34         if ($valueSet) {
  35             $this->setValueSet($valueSet);
  36         }
  37     }
  38
  39     /**
  40      * Set identifier for comparison
  41      *
  42      * @param  string $identifier
  43      * @return In
  44      */
  45     public function setIdentifier($identifier)
  46     {
  47         $this->identifier = $identifier;
  48         return $this;
  49     }
  50
  51     /**
  52      * Get identifier of comparison
  53      *
  54      * @return null|string
  55      */
  56     public function getIdentifier()
  57     {
  58         return $this->identifier;
  59     }
  60
  61     /**
  62      * Set set of values for IN comparison
  63      *
  64      * @param  array $valueSet
  65      * @throws Exception\InvalidArgumentException
  66      * @return In
  67      */
  68     public function setValueSet($valueSet)
  69     {
  70         if (!is_array($valueSet) && !$valueSet instanceof Select) {
  71             throw new Exception\InvalidArgumentException(
  72                 '$valueSet must be either an array or a Zend\Db\Sql\Select object, ' . gettype($valueSet) . ' given'
  73             );
  74         }
  75         $this->valueSet = $valueSet;
  76         return $this;
  77     }
  78
  79     public function getValueSet()
  80     {
  81         return $this->valueSet;
  82     }
  83
  84     /**
  85      * Return array of parts for where statement
  86      *
  87      * @return array
  88      */
  89     public function getExpressionData()
  90     {
  91         $values = $this->getValueSet();
  92         if ($values instanceof Select) {
  93             $specification = $this->selectSpecification;
  94             $types = array(self::TYPE_VALUE);
  95             $values = array($values);
  96         } else {
  97             $specification = sprintf($this->valueSpecSpecification, implode(', ', array_fill(0, count($values), '%s')));
  98             $types = array_fill(0, count($values), self::TYPE_VALUE);
  99         }
 100
 101         $identifier = $this->getIdentifier();
 102         array_unshift($values, $identifier);
 103         array_unshift($types, self::TYPE_IDENTIFIER);
 104
 105         return array(array(
 106             $specification,
 107             $values,
 108             $types,
 109         ));
 110     }
 111 }