tests/PHPUnit/Util/TestDox/ResultPrinter/HTML.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 2.3.0
  45  */
  46
  47 require_once 'PHPUnit/Util/Filter.php';
  48 require_once 'PHPUnit/Util/TestDox/ResultPrinter.php';
  49
  50 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  51
  52 /**
  53  * Prints TestDox documentation in HTML format.
  54  *
  55  * @category   Testing
  56  * @package    PHPUnit
  57  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  58  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  59  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  60  * @version    Release: 3.3.17
  61  * @link       http://www.phpunit.de/
  62  * @since      Class available since Release 2.1.0
  63  */
  64 class PHPUnit_Util_TestDox_ResultPrinter_HTML extends PHPUnit_Util_TestDox_ResultPrinter
  65 {
  66     /**
  67      * @var    boolean
  68      */
  69     protected $printsHTML = TRUE;
  70
  71     /**
  72      * Handler for 'start run' event.
  73      *
  74      */
  75     protected function startRun()
  76     {
  77         $this->write('<html><body>');
  78     }
  79
  80     /**
  81      * Handler for 'start class' event.
  82      *
  83      * @param  string $name
  84      */
  85     protected function startClass($name)
  86     {
  87         $this->write('<h2 id="' . $name . '">' . $this->currentTestClassPrettified . '</h2><ul>');
  88     }
  89
  90     /**
  91      * Handler for 'on test' event.
  92      *
  93      * @param  string  $name
  94      * @param  boolean $success
  95      */
  96     protected function onTest($name, $success = TRUE)
  97     {
  98         if (!$success) {
  99             $strikeOpen  = '<strike>';
 100             $strikeClose = '</strike>';
 101         } else {
 102             $strikeOpen  = '';
 103             $strikeClose = '';
 104         }
 105
 106         $this->write('<li>' . $strikeOpen . $name . $strikeClose . '</li>');
 107     }
 108
 109     /**
 110      * Handler for 'end class' event.
 111      *
 112      * @param  string $name
 113      */
 114     protected function endClass($name)
 115     {
 116         $this->write('</ul>');
 117     }
 118
 119     /**
 120      * Handler for 'end run' event.
 121      *
 122      */
 123     protected function endRun()
 124     {
 125         $this->write('</body></html>');
 126     }
 127 }
 128 ?>