tests/PHPUnit/PHPUnit/Framework/Constraint/IsIdentical.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  * Constraint that asserts that one value is identical to another.
  48  *
  49  * Identical check is performed with PHP's === operator, the operator is
  50  * explained in detail at
  51  * {@url http://www.php.net/manual/en/types.comparisons.php}.
  52  * Two values are identical if they have the same value and are of the same
  53  * type.
  54  *
  55  * The expected value is passed in the constructor.
  56  *
  57  * @package    PHPUnit
  58  * @subpackage Framework_Constraint
  59  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  60  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  61  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  62  * @version    Release: 3.5.13
  63  * @link       http://www.phpunit.de/
  64  * @since      Class available since Release 3.0.0
  65  */
  66 class PHPUnit_Framework_Constraint_IsIdentical extends PHPUnit_Framework_Constraint
  67 {
  68     /**
  69      * @var mixed
  70      */
  71     protected $value;
  72
  73     /**
  74      * @param mixed $value
  75      */
  76     public function __construct($value)
  77     {
  78         $this->value = $value;
  79     }
  80
  81     /**
  82      * Evaluates the constraint for parameter $other. Returns TRUE if the
  83      * constraint is met, FALSE otherwise.
  84      *
  85      * @param mixed $other Value or object to evaluate.
  86      * @return bool
  87      */
  88     public function evaluate($other)
  89     {
  90         return $this->value === $other;
  91     }
  92
  93     /**
  94      * @param   mixed   $other The value passed to evaluate() which failed the
  95      *                         constraint check.
  96      * @param   string  $description A string with extra description of what was
  97      *                               going on while the evaluation failed.
  98      * @param   boolean $not Flag to indicate negation.
  99      * @throws  PHPUnit_Framework_ExpectationFailedException
 100      */
 101     public function fail($other, $description, $not = FALSE)
 102     {
 103         $failureDescription = $this->failureDescription(
 104           $other,
 105           $description,
 106           $not
 107         );
 108
 109         if (!$not) {
 110             throw new PHPUnit_Framework_ExpectationFailedException(
 111               $failureDescription,
 112               PHPUnit_Framework_ComparisonFailure::diffIdentical(
 113                 $this->value, $other
 114               ),
 115               $description
 116             );
 117         } else {
 118             throw new PHPUnit_Framework_ExpectationFailedException(
 119               $failureDescription,
 120               NULL
 121             );
 122         }
 123     }
 124
 125     /**
 126      * Returns a string representation of the constraint.
 127      *
 128      * @return string
 129      */
 130     public function toString()
 131     {
 132         if (is_object($this->value)) {
 133             return 'is identical to an object of class "' .
 134                    get_class($this->value) . '"';
 135         } else {
 136             return 'is identical to ' .
 137                    PHPUnit_Util_Type::toString($this->value);
 138         }
 139     }
 140 }