interface/modules/zend_modules/library/Zend/Db/Sql/Predicate/Between.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 class Between implements PredicateInterface
  13 {
  14     protected $specification = '%1$s BETWEEN %2$s AND %3$s';
  15     protected $identifier    = null;
  16     protected $minValue      = null;
  17     protected $maxValue      = null;
  18
  19     /**
  20      * Constructor
  21      *
  22      * @param  string $identifier
  23      * @param  int|float|string $minValue
  24      * @param  int|float|string $maxValue
  25      */
  26     public function __construct($identifier = null, $minValue = null, $maxValue = null)
  27     {
  28         if ($identifier) {
  29             $this->setIdentifier($identifier);
  30         }
  31         if ($minValue !== null) {
  32             $this->setMinValue($minValue);
  33         }
  34         if ($maxValue !== null) {
  35             $this->setMaxValue($maxValue);
  36         }
  37     }
  38
  39     /**
  40      * Set identifier for comparison
  41      *
  42      * @param  string $identifier
  43      * @return Between
  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 minimum boundary for comparison
  63      *
  64      * @param  int|float|string $minValue
  65      * @return Between
  66      */
  67     public function setMinValue($minValue)
  68     {
  69         $this->minValue = $minValue;
  70         return $this;
  71     }
  72
  73     /**
  74      * Get minimum boundary for comparison
  75      *
  76      * @return null|int|float|string
  77      */
  78     public function getMinValue()
  79     {
  80         return $this->minValue;
  81     }
  82
  83     /**
  84      * Set maximum boundary for comparison
  85      *
  86      * @param  int|float|string $maxValue
  87      * @return Between
  88      */
  89     public function setMaxValue($maxValue)
  90     {
  91         $this->maxValue = $maxValue;
  92         return $this;
  93     }
  94
  95     /**
  96      * Get maximum boundary for comparison
  97      *
  98      * @return null|int|float|string
  99      */
 100     public function getMaxValue()
 101     {
 102         return $this->maxValue;
 103     }
 104
 105     /**
 106      * Set specification string to use in forming SQL predicate
 107      *
 108      * @param  string $specification
 109      * @return Between
 110      */
 111     public function setSpecification($specification)
 112     {
 113         $this->specification = $specification;
 114         return $this;
 115     }
 116
 117     /**
 118      * Get specification string to use in forming SQL predicate
 119      *
 120      * @return string
 121      */
 122     public function getSpecification()
 123     {
 124         return $this->specification;
 125     }
 126
 127     /**
 128      * Return "where" parts
 129      *
 130      * @return array
 131      */
 132     public function getExpressionData()
 133     {
 134         return array(
 135             array(
 136                 $this->getSpecification(),
 137                 array($this->identifier, $this->minValue, $this->maxValue),
 138                 array(self::TYPE_IDENTIFIER, self::TYPE_VALUE, self::TYPE_VALUE),
 139             ),
 140         );
 141     }
 142 }