tests/PHPUnit/PHPUnit/Framework/Constraint/And.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package    PHPUnit
  38  * @subpackage Framework_Constraint
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 3.0.0
  44  */
  45
  46 /**
  47  * Logical AND.
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Framework_Constraint
  51  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  52  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 3.5.13
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 3.0.0
  57  */
  58 class PHPUnit_Framework_Constraint_And extends PHPUnit_Framework_Constraint
  59 {
  60     /**
  61      * @var PHPUnit_Framework_Constraint[]
  62      */
  63     protected $constraints = array();
  64
  65     /**
  66      * @var PHPUnit_Framework_Constraint
  67      */
  68     protected $lastConstraint = NULL;
  69
  70     /**
  71      * @param PHPUnit_Framework_Constraint[] $constraints
  72      */
  73     public function setConstraints(array $constraints)
  74     {
  75         $this->constraints = array();
  76
  77         foreach($constraints as $key => $constraint) {
  78             if (!($constraint instanceof PHPUnit_Framework_Constraint)) {
  79                 throw new InvalidArgumentException(
  80                   'All parameters to ' . __CLASS__ .
  81                   ' must be a constraint object.'
  82                 );
  83             }
  84
  85             $this->constraints[] = $constraint;
  86         }
  87     }
  88
  89     /**
  90      * Evaluates the constraint for parameter $other. Returns TRUE if the
  91      * constraint is met, FALSE otherwise.
  92      *
  93      * @param mixed $other Value or object to evaluate.
  94      * @return bool
  95      */
  96     public function evaluate($other)
  97     {
  98         $this->lastConstraint = NULL;
  99
 100         foreach($this->constraints as $constraint) {
 101             $this->lastConstraint = $constraint;
 102
 103             if (!$constraint->evaluate($other)) {
 104                 return FALSE;
 105             }
 106         }
 107
 108         return TRUE;
 109     }
 110
 111     /**
 112      * @param   mixed   $other The value passed to evaluate() which failed the
 113      *                         constraint check.
 114      * @param   string  $description A string with extra description of what was
 115      *                               going on while the evaluation failed.
 116      * @param   boolean $not Flag to indicate negation.
 117      * @throws  PHPUnit_Framework_ExpectationFailedException
 118      */
 119     public function fail($other, $description, $not = FALSE)
 120     {
 121         $this->lastConstraint->fail($other, $description, $not);
 122     }
 123
 124     /**
 125      * Returns a string representation of the constraint.
 126      *
 127      * @return string
 128      */
 129     public function toString()
 130     {
 131         $text = '';
 132
 133         foreach($this->constraints as $key => $constraint) {
 134             if ($key > 0) {
 135                 $text .= ' and ';
 136             }
 137
 138             $text .= $constraint->toString();
 139         }
 140
 141         return $text;
 142     }
 143
 144     /**
 145      * Counts the number of constraint elements.
 146      *
 147      * @return integer
 148      * @since  Method available since Release 3.4.0
 149      */
 150     public function count()
 151     {
 152         $count = 0;
 153
 154         foreach ($this->constraints as $constraint) {
 155             $count += count($constraint);
 156         }
 157
 158         return $count;
 159     }
 160 }