tests/PHPUnit/Framework/ExpectationFailedException.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.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  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.0.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49
  50 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  51
  52 if (!class_exists('PHPUnit_Framework_ExpectationFailedException', FALSE)) {
  53
  54 /**
  55  * Exception for expectations which failed their check.
  56  *
  57  * The exception contains the error message and optionally a
  58  * PHPUnit_Framework_ComparisonFailure which is used to
  59  * generate diff output of the failed expectations.
  60  *
  61  * @category   Testing
  62  * @package    PHPUnit
  63  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  64  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  65  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  66  * @version    Release: 3.3.17
  67  * @link       http://www.phpunit.de/
  68  * @since      Class available since Release 3.0.0
  69  */
  70 class PHPUnit_Framework_ExpectationFailedException extends PHPUnit_Framework_AssertionFailedError
  71 {
  72     protected $comparisonFailure;
  73     protected $description;
  74     protected $customMessage;
  75
  76     public function __construct($description, PHPUnit_Framework_ComparisonFailure $comparisonFailure = NULL, $message = '')
  77     {
  78         $this->description       = $description;
  79         $this->comparisonFailure = $comparisonFailure;
  80         $this->customMessage     = $message;
  81
  82         if (!empty($message)) {
  83             $description .= "\n" . $message;
  84         }
  85
  86         parent::__construct($description);
  87     }
  88
  89     public function getComparisonFailure()
  90     {
  91         return $this->comparisonFailure;
  92     }
  93
  94     public function getDescription()
  95     {
  96         return $this->description;
  97     }
  98
  99     public function getCustomMessage()
 100     {
 101         return $this->customMessage;
 102     }
 103 }
 104
 105 }
 106 ?>