interface/modules/zend_modules/library/Zend/Db/Sql/Predicate/PredicateSet.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 Countable;
  13
  14 class PredicateSet implements PredicateInterface, Countable
  15 {
  16     const COMBINED_BY_AND = 'AND';
  17     const OP_AND          = 'AND';
  18
  19     const COMBINED_BY_OR  = 'OR';
  20     const OP_OR           = 'OR';
  21
  22     protected $defaultCombination = self::COMBINED_BY_AND;
  23     protected $predicates         = array();
  24
  25     /**
  26      * Constructor
  27      *
  28      * @param  null|array $predicates
  29      * @param  string $defaultCombination
  30      */
  31     public function __construct(array $predicates = null, $defaultCombination = self::COMBINED_BY_AND)
  32     {
  33         $this->defaultCombination = $defaultCombination;
  34         if ($predicates) {
  35             foreach ($predicates as $predicate) {
  36                 $this->addPredicate($predicate);
  37             }
  38         }
  39     }
  40
  41     /**
  42      * Add predicate to set
  43      *
  44      * @param  PredicateInterface $predicate
  45      * @param  string $combination
  46      * @return PredicateSet
  47      */
  48     public function addPredicate(PredicateInterface $predicate, $combination = null)
  49     {
  50         if ($combination === null || !in_array($combination, array(self::OP_AND, self::OP_OR))) {
  51             $combination = $this->defaultCombination;
  52         }
  53
  54         if ($combination == self::OP_OR) {
  55             $this->orPredicate($predicate);
  56             return $this;
  57         }
  58
  59         $this->andPredicate($predicate);
  60         return $this;
  61     }
  62
  63     /**
  64      * Return the predicates
  65      *
  66      * @return PredicateInterface[]
  67      */
  68     public function getPredicates()
  69     {
  70         return $this->predicates;
  71     }
  72
  73     /**
  74      * Add predicate using OR operator
  75      *
  76      * @param  PredicateInterface $predicate
  77      * @return PredicateSet
  78      */
  79     public function orPredicate(PredicateInterface $predicate)
  80     {
  81         $this->predicates[] = array(self::OP_OR, $predicate);
  82         return $this;
  83     }
  84
  85     /**
  86      * Add predicate using AND operator
  87      *
  88      * @param  PredicateInterface $predicate
  89      * @return PredicateSet
  90      */
  91     public function andPredicate(PredicateInterface $predicate)
  92     {
  93         $this->predicates[] = array(self::OP_AND, $predicate);
  94         return $this;
  95     }
  96
  97     /**
  98      * Get predicate parts for where statement
  99      *
 100      * @return array
 101      */
 102     public function getExpressionData()
 103     {
 104         $parts = array();
 105         for ($i = 0, $count = count($this->predicates); $i < $count; $i++) {
 106
 107             /** @var $predicate PredicateInterface */
 108             $predicate = $this->predicates[$i][1];
 109
 110             if ($predicate instanceof PredicateSet) {
 111                 $parts[] = '(';
 112             }
 113
 114             $parts = array_merge($parts, $predicate->getExpressionData());
 115
 116             if ($predicate instanceof PredicateSet) {
 117                 $parts[] = ')';
 118             }
 119
 120             if (isset($this->predicates[$i+1])) {
 121                 $parts[] = sprintf(' %s ', $this->predicates[$i+1][0]);
 122             }
 123         }
 124         return $parts;
 125     }
 126
 127     /**
 128      * Get count of attached predicates
 129      *
 130      * @return int
 131      */
 132     public function count()
 133     {
 134         return count($this->predicates);
 135     }
 136 }