5 * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.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.
38 * @subpackage Framework
39 * @author Bernhard Schussek <bschussek@2bepublished.at>
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.6.0
47 * Compares objects for equality.
50 * @subpackage Framework_Comparator
51 * @author Bernhard Schussek <bschussek@2bepublished.at>
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.6.3
55 * @link http://www.phpunit.de/
56 * @since Class available since Release 3.6.0
58 class PHPUnit_Framework_Comparator_Object extends PHPUnit_Framework_Comparator_Array
61 * Returns whether the comparator can compare two values.
63 * @param mixed $expected The first value to compare
64 * @param mixed $actual The second value to compare
67 public function accepts($expected, $actual)
69 return is_object($expected) && is_object($actual);
73 * Asserts that two values are equal.
75 * @param mixed $expected The first value to compare
76 * @param mixed $actual The second value to compare
77 * @param float $delta The allowed numerical distance between two values to
79 * @param bool $canonicalize If set to TRUE, arrays are sorted before
81 * @param bool $ignoreCase If set to TRUE, upper- and lowercasing is
82 * ignored when comparing string values
83 * @throws PHPUnit_Framework_ComparisonFailure Thrown when the comparison
84 * fails. Contains information about the
85 * specific errors that lead to the failure.
87 public function assertEquals($expected, $actual, $delta = 0, $canonicalize = FALSE, $ignoreCase = FALSE, array &$processed = array())
89 if (get_class($actual) !== get_class($expected)) {
90 throw new PHPUnit_Framework_ComparisonFailure(
93 PHPUnit_Util_Type::export($expected),
94 PHPUnit_Util_Type::export($actual),
97 '%s is not instance of expected class "%s".',
99 PHPUnit_Util_Type::export($actual),
105 // don't compare twice to allow for cyclic dependencies
106 if (in_array(array($actual, $expected), $processed, TRUE) ||
107 in_array(array($expected, $actual), $processed, TRUE)) {
111 $processed[] = array($actual, $expected);
113 // don't compare objects if they are identical
114 // this helps to avoid the error "maximum function nesting level reached"
115 // CAUTION: this conditional clause is not tested
116 if ($actual !== $expected) {
118 parent::assertEquals($this->toArray($expected), $this->toArray($actual), $delta, $canonicalize, $ignoreCase, $processed);
121 catch (PHPUnit_Framework_ComparisonFailure $e) {
122 throw new PHPUnit_Framework_ComparisonFailure(
125 // replace "Array" with "MyClass object"
126 substr_replace($e->getExpectedAsString(), get_class($expected).' Object', 0, 5),
127 substr_replace($e->getActualAsString(), get_class($actual).' Object', 0, 5),
129 'Failed asserting that two objects are equal.'
136 * Converts an object to an array containing all of its private, protected
137 * and public properties.
139 * @param object $object
142 protected function toArray($object)
144 return PHPUnit_Util_Type::toArray($object);