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 3.0.0
47 * Exception for expectations which failed their check.
49 * The exception contains the error message and optionally a
50 * PHPUnit_Framework_ComparisonFailure which is used to
51 * generate diff output of the failed expectations.
54 * @subpackage Framework
55 * @author Sebastian Bergmann <sebastian@phpunit.de>
56 * @copyright 2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
57 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
58 * @version Release: 3.5.14
59 * @link http://www.phpunit.de/
60 * @since Class available since Release 3.0.0
62 class PHPUnit_Framework_ExpectationFailedException extends PHPUnit_Framework_AssertionFailedError
65 * @var PHPUnit_Framework_ComparisonFailure
67 protected $comparisonFailure;
72 protected $description;
77 protected $customMessage;
79 public function __construct($description, PHPUnit_Framework_ComparisonFailure $comparisonFailure = NULL, $message = '')
81 $this->description = $description;
82 $this->comparisonFailure = $comparisonFailure;
83 $this->customMessage = $message;
85 if (!empty($message)) {
86 $description .= "\n" . $message;
89 parent::__construct($description);
93 * @return PHPUnit_Framework_ComparisonFailure
95 public function getComparisonFailure()
97 return $this->comparisonFailure;
103 public function getDescription()
105 return $this->description;
111 public function getCustomMessage()
113 return $this->customMessage;
117 * @param string $customMessage
118 * @since Method available since Release 3.4.0
120 public function setCustomMessage($customMessage)
122 $this->customMessage = $customMessage;