5 * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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.
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.
39 * @author Jan Borsodi <jb@ez.no>
40 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
41 * @copyright 2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
42 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
44 * @link http://www.phpunit.de/
45 * @since File available since Release 3.0.0
48 require_once 'PHPUnit/Framework.php';
49 require_once 'PHPUnit/Util/Filter.php';
50 require_once 'PHPUnit/Util/Type.php';
52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
55 * Constraint that asserts that one value is identical to another.
57 * Identical check is performed with PHP's === operator, the operator is explained
58 * in detail at {@url http://www.php.net/manual/en/types.comparisons.php}.
59 * Two values are identical if they have the same value and are of the same type.
61 * The expected value is passed in the constructor.
65 * @author Jan Borsodi <jb@ez.no>
66 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
67 * @copyright 2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
68 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
69 * @version Release: 3.3.17
70 * @link http://www.phpunit.de/
71 * @since Class available since Release 3.0.0
73 class PHPUnit_Framework_Constraint_IsIdentical extends PHPUnit_Framework_Constraint
77 public function __construct($value)
79 $this->value = $value;
83 * Evaluates the constraint for parameter $other. Returns TRUE if the
84 * constraint is met, FALSE otherwise.
86 * @param mixed $other Value or object to evaluate.
89 public function evaluate($other)
91 return $this->value === $other;
95 * @param mixed $other The value passed to evaluate() which failed the
97 * @param string $description A string with extra description of what was
98 * going on while the evaluation failed.
99 * @param boolean $not Flag to indicate negation.
100 * @throws PHPUnit_Framework_ExpectationFailedException
102 public function fail($other, $description, $not = FALSE)
104 $failureDescription = $this->failureDescription(
111 throw new PHPUnit_Framework_ExpectationFailedException(
113 PHPUnit_Framework_ComparisonFailure::diffIdentical($this->value, $other),
117 throw new PHPUnit_Framework_ExpectationFailedException(
125 * Returns a string representation of the constraint.
129 public function toString()
131 if (is_object($this->value)) {
132 return 'is identical to an object of class "' . get_class($this->value) . '"';
134 return 'is identical to ' . PHPUnit_Util_Type::toString($this->value);