vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/And.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2001-2012, 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  * @author     Bernhard Schussek <bschussek@2bepublished.at>
  41  * @copyright  2001-2012 Sebastian Bergmann <sebastian@phpunit.de>
  42  * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.0.0
  45  */
  46
  47 /**
  48  * Logical AND.
  49  *
  50  * @package    PHPUnit
  51  * @subpackage Framework_Constraint
  52  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  53  * @author     Bernhard Schussek <bschussek@2bepublished.at>
  54  * @copyright  2001-2012 Sebastian Bergmann <sebastian@phpunit.de>
  55  * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
  56  * @version    Release: @package_version@
  57  * @link       http://www.phpunit.de/
  58  * @since      Class available since Release 3.0.0
  59  */
  60 class PHPUnit_Framework_Constraint_And extends PHPUnit_Framework_Constraint
  61 {
  62     /**
  63      * @var PHPUnit_Framework_Constraint[]
  64      */
  65     protected $constraints = array();
  66
  67     /**
  68      * @var PHPUnit_Framework_Constraint
  69      */
  70     protected $lastConstraint = NULL;
  71
  72     /**
  73      * @param  PHPUnit_Framework_Constraint[] $constraints
  74      * @throws PHPUnit_Framework_Exception
  75      */
  76     public function setConstraints(array $constraints)
  77     {
  78         $this->constraints = array();
  79
  80         foreach ($constraints as $key => $constraint) {
  81             if (!($constraint instanceof PHPUnit_Framework_Constraint)) {
  82                 throw new PHPUnit_Framework_Exception(
  83                   'All parameters to ' . __CLASS__ .
  84                   ' must be a constraint object.'
  85                 );
  86             }
  87
  88             $this->constraints[] = $constraint;
  89         }
  90     }
  91
  92     /**
  93      * Evaluates the constraint for parameter $other
  94      *
  95      * If $returnResult is set to FALSE (the default), an exception is thrown
  96      * in case of a failure. NULL is returned otherwise.
  97      *
  98      * If $returnResult is TRUE, the result of the evaluation is returned as
  99      * a boolean value instead: TRUE in case of success, FALSE in case of a
 100      * failure.
 101      *
 102      * @param  mixed $other Value or object to evaluate.
 103      * @param  string $description Additional information about the test
 104      * @param  bool $returnResult Whether to return a result or throw an exception
 105      * @return mixed
 106      * @throws PHPUnit_Framework_ExpectationFailedException
 107      */
 108     public function evaluate($other, $description = '', $returnResult = FALSE)
 109     {
 110         $success = TRUE;
 111         $constraint = NULL;
 112
 113         foreach ($this->constraints as $constraint) {
 114             if (!$constraint->evaluate($other, $description, TRUE)) {
 115                 $success = FALSE;
 116                 break;
 117             }
 118         }
 119
 120         if ($returnResult) {
 121             return $success;
 122         }
 123
 124         if (!$success) {
 125             $this->fail($other, $description);
 126         }
 127     }
 128
 129     /**
 130      * Returns a string representation of the constraint.
 131      *
 132      * @return string
 133      */
 134     public function toString()
 135     {
 136         $text = '';
 137
 138         foreach ($this->constraints as $key => $constraint) {
 139             if ($key > 0) {
 140                 $text .= ' and ';
 141             }
 142
 143             $text .= $constraint->toString();
 144         }
 145
 146         return $text;
 147     }
 148
 149     /**
 150      * Counts the number of constraint elements.
 151      *
 152      * @return integer
 153      * @since  Method available since Release 3.4.0
 154      */
 155     public function count()
 156     {
 157         $count = 0;
 158
 159         foreach ($this->constraints as $constraint) {
 160             $count += count($constraint);
 161         }
 162
 163         return $count;
 164     }
 165 }