tests/PHPUnit/PHPUnit/Framework/ExpectationFailedException.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.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  * @package    PHPUnit
  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
  44  */
  45
  46 /**
  47  * Exception for expectations which failed their check.
  48  *
  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.
  52  *
  53  * @package    PHPUnit
  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.13
  59  * @link       http://www.phpunit.de/
  60  * @since      Class available since Release 3.0.0
  61  */
  62 class PHPUnit_Framework_ExpectationFailedException extends PHPUnit_Framework_AssertionFailedError
  63 {
  64     /**
  65      * @var PHPUnit_Framework_ComparisonFailure
  66      */
  67     protected $comparisonFailure;
  68
  69     /**
  70      * @var string
  71      */
  72     protected $description;
  73
  74     /**
  75      * @var string
  76      */
  77     protected $customMessage;
  78
  79     public function __construct($description, PHPUnit_Framework_ComparisonFailure $comparisonFailure = NULL, $message = '')
  80     {
  81         $this->description       = $description;
  82         $this->comparisonFailure = $comparisonFailure;
  83         $this->customMessage     = $message;
  84
  85         if (!empty($message)) {
  86             $description .= "\n" . $message;
  87         }
  88
  89         parent::__construct($description);
  90     }
  91
  92     /**
  93      * @return PHPUnit_Framework_ComparisonFailure
  94      */
  95     public function getComparisonFailure()
  96     {
  97         return $this->comparisonFailure;
  98     }
  99
 100     /**
 101      * @return string
 102      */
 103     public function getDescription()
 104     {
 105         return $this->description;
 106     }
 107
 108     /**
 109      * @return string
 110      */
 111     public function getCustomMessage()
 112     {
 113         return $this->customMessage;
 114     }
 115
 116     /**
 117      * @param string $customMessage
 118      * @since Method available since Release 3.4.0
 119      */
 120     public function setCustomMessage($customMessage)
 121     {
 122         $this->customMessage = $customMessage;
 123     }
 124 }