tests/PHPUnit/PHPUnit/Framework/Constraint/Not.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 NOT.
  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
  59 class PHPUnit_Framework_Constraint_Not extends PHPUnit_Framework_Constraint
  60 {
  61     /**
  62      * @var PHPUnit_Framework_Constraint
  63      */
  64     protected $constraint;
  65
  66     /**
  67      * @param PHPUnit_Framework_Constraint $constraint
  68      */
  69     public function __construct($constraint)
  70     {
  71         if (!($constraint instanceof PHPUnit_Framework_Constraint)) {
  72             $constraint = new PHPUnit_Framework_Constraint_IsEqual($constraint);
  73         }
  74
  75         $this->constraint = $constraint;
  76     }
  77
  78     /**
  79      * Evaluates the constraint for parameter $other. Returns TRUE if the
  80      * constraint is met, FALSE otherwise.
  81      *
  82      * @param mixed $other Value or object to evaluate.
  83      * @return bool
  84      */
  85     public function evaluate($other)
  86     {
  87         return !$this->constraint->evaluate($other);
  88     }
  89
  90     /**
  91      * @param   mixed   $other The value passed to evaluate() which failed the
  92      *                         constraint check.
  93      * @param   string  $description A string with extra description of what was
  94      *                               going on while the evaluation failed.
  95      * @param   boolean $not Flag to indicate negation.
  96      * @throws  PHPUnit_Framework_ExpectationFailedException
  97      */
  98     public function fail($other, $description, $not = FALSE)
  99     {
 100         if (count($this->constraint) == 1 ||
 101             $this->constraint instanceof PHPUnit_Framework_Constraint_Attribute) {
 102             $this->constraint->fail($other, $description, TRUE);
 103         } else {
 104             parent::fail($other, $description, !$not);
 105         }
 106     }
 107
 108     /**
 109      * Returns a string representation of the constraint.
 110      *
 111      * @return string
 112      */
 113     public function toString()
 114     {
 115         switch (get_class($this->constraint)) {
 116             case 'PHPUnit_Framework_Constraint_And':
 117             case 'PHPUnit_Framework_Constraint_Not':
 118             case 'PHPUnit_Framework_Constraint_Or': {
 119                 return 'not( ' . $this->constraint->toString() . ' )';
 120             }
 121             break;
 122
 123             default: {
 124                 return PHPUnit_Framework_Constraint::negate(
 125                   $this->constraint->toString()
 126                 );
 127             }
 128         }
 129     }
 130
 131     /**
 132      * Counts the number of constraint elements.
 133      *
 134      * @return integer
 135      * @since  Method available since Release 3.4.0
 136      */
 137     public function count()
 138     {
 139         return count($this->constraint);
 140     }
 141 }