tests/PHPUnit/PHPUnit/Framework/Warning.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 2.0.0
  44  */
  45
  46 /**
  47  * A warning.
  48  *
  49  * @package    PHPUnit
  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
  57  */
  58 class PHPUnit_Framework_Warning extends PHPUnit_Framework_TestCase
  59 {
  60     /**
  61      * @var string
  62      */
  63     protected $message = '';
  64
  65     /**
  66      * @var boolean
  67      */
  68     protected $backupGlobals = FALSE;
  69
  70     /**
  71      * @var boolean
  72      */
  73     protected $backupStaticAttributes = FALSE;
  74
  75     /**
  76      * @var boolean
  77      */
  78     protected $runTestInSeparateProcess = FALSE;
  79
  80     /**
  81      * @var boolean
  82      */
  83     protected $useErrorHandler = FALSE;
  84
  85     /**
  86      * @var boolean
  87      */
  88     protected $useOutputBuffering = FALSE;
  89
  90     /**
  91      * @param string $message
  92      */
  93     public function __construct($message = '')
  94     {
  95         $this->message = $message;
  96         parent::__construct('Warning');
  97     }
  98
  99     /**
 100      * @throws RuntimeException
 101      */
 102     protected function runTest()
 103     {
 104         $this->fail($this->message);
 105     }
 106
 107     /**
 108      * @return string
 109      * @since  Method available since Release 3.0.0
 110      */
 111     public function getMessage()
 112     {
 113         return $this->message;
 114     }
 115
 116     /**
 117      * Returns a string representation of the test case.
 118      *
 119      * @return string
 120      * @since  Method available since Release 3.4.0
 121      */
 122     public function toString()
 123     {
 124         return 'Warning';
 125     }
 126 }