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 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 2.0.0
47 * Thrown when an assertion for string equality failed.
50 * @subpackage Framework
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 2.0.0
58 abstract class PHPUnit_Framework_ComparisonFailure extends PHPUnit_Framework_AssertionFailedError
61 * Expected value of the retrieval which does not match $actual.
67 * Actually retrieved value which does not match $expected.
78 * Optional message which is placed in front of the first line
79 * returned by toString().
85 * Initialises with the expected value and the actual value.
87 * @param mixed $expected Expected value retrieved.
88 * @param mixed $actual Actual value retrieved.
89 * @param boolean $identical
90 * @param string $message A string which is prefixed on all returned lines
91 * in the difference output.
93 public function __construct($expected, $actual, $identical = FALSE, $message = '')
95 $this->expected = $expected;
96 $this->actual = $actual;
97 $this->identical = $identical;
98 $this->message = $message;
104 public function getActual()
106 return $this->actual;
112 public function getExpected()
114 return $this->expected;
120 public function identical()
122 return $this->identical;
126 * Figures out which diff class to use for the input types then
127 * instantiates that class and returns the object.
128 * @note The diff is type sensitive, if the type differs only the types
131 * @param mixed $expected Expected value retrieved.
132 * @param mixed $actual Actual value retrieved.
133 * @param string $message A string which is prefixed on all returned lines
134 * in the difference output.
135 * @return PHPUnit_Framework_ComparisonFailure
137 public static function diffIdentical($expected, $actual, $message = '')
139 if (gettype($expected) !== gettype($actual)) {
140 return new PHPUnit_Framework_ComparisonFailure_Type(
141 $expected, $actual, TRUE, $message
145 else if (is_array($expected) && is_array($actual)) {
146 return new PHPUnit_Framework_ComparisonFailure_Array(
147 $expected, $actual, TRUE, $message
151 else if (is_object($expected) && is_object($actual)) {
152 return new PHPUnit_Framework_ComparisonFailure_Object(
153 $expected, $actual, TRUE, $message
157 else if (is_string($expected) && !is_object($actual)) {
158 return new PHPUnit_Framework_ComparisonFailure_String(
159 $expected, $actual, TRUE, $message
163 else if (is_null($expected) || is_scalar($expected)) {
164 return new PHPUnit_Framework_ComparisonFailure_Scalar(
165 $expected, $actual, TRUE, $message
171 * Figures out which diff class to use for the input types then
172 * instantiates that class and returns the object.
173 * @note The diff is not type sensitive, if the type differs the $actual
174 * value will be converted to the same type as the $expected.
176 * @param mixed $expected Expected value retrieved.
177 * @param mixed $actual Actual value retrieved.
178 * @param string $message A string which is prefixed on all returned lines
179 * in the difference output.
180 * @return PHPUnit_Framework_ComparisonFailure
182 public static function diffEqual($expected, $actual, $message = '')
184 if (is_array($expected) && is_array($actual)) {
185 return new PHPUnit_Framework_ComparisonFailure_Array(
186 $expected, $actual, FALSE, $message
190 else if (is_object($expected) && is_object($actual)) {
191 return new PHPUnit_Framework_ComparisonFailure_Object(
192 $expected, $actual, FALSE, $message
196 else if (is_string($expected) && !is_object($actual)) {
197 return new PHPUnit_Framework_ComparisonFailure_String(
198 $expected, $actual, FALSE, $message
202 else if (is_null($expected) || is_scalar($expected)) {
203 return new PHPUnit_Framework_ComparisonFailure_Scalar(
204 $expected, $actual, FALSE, $message