tests/PHPUnit/PHPUnit/Util/TestDox/ResultPrinter/HTML.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 Util_TestDox
  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.3.0
  44  */
  45
  46 /**
  47  * Prints TestDox documentation in HTML format.
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Util_TestDox
  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.14
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 2.1.0
  57  */
  58 class PHPUnit_Util_TestDox_ResultPrinter_HTML extends PHPUnit_Util_TestDox_ResultPrinter
  59 {
  60     /**
  61      * @var    boolean
  62      */
  63     protected $printsHTML = TRUE;
  64
  65     /**
  66      * Handler for 'start run' event.
  67      *
  68      */
  69     protected function startRun()
  70     {
  71         $this->write('<html ' . get_language_header() . '><body>');
  72     }
  73
  74     /**
  75      * Handler for 'start class' event.
  76      *
  77      * @param  string $name
  78      */
  79     protected function startClass($name)
  80     {
  81         $this->write(
  82           '<h2 id="' . $name . '">' . $this->currentTestClassPrettified .
  83           '</h2><ul>'
  84         );
  85     }
  86
  87     /**
  88      * Handler for 'on test' event.
  89      *
  90      * @param  string  $name
  91      * @param  boolean $success
  92      */
  93     protected function onTest($name, $success = TRUE)
  94     {
  95         if (!$success) {
  96             $strikeOpen  = '<strike>';
  97             $strikeClose = '</strike>';
  98         } else {
  99             $strikeOpen  = '';
 100             $strikeClose = '';
 101         }
 102
 103         $this->write('<li>' . $strikeOpen . $name . $strikeClose . '</li>');
 104     }
 105
 106     /**
 107      * Handler for 'end class' event.
 108      *
 109      * @param  string $name
 110      */
 111     protected function endClass($name)
 112     {
 113         $this->write('</ul>');
 114     }
 115
 116     /**
 117      * Handler for 'end run' event.
 118      *
 119      */
 120     protected function endRun()
 121     {
 122         $this->write('</body></html>');
 123     }
 124 }