inc/classes/main/debug/class_DebugWebOutput.php

   1 <?php
   2 /**
   3  * A debug output class for the web browser
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class DebugWebOutput extends BaseFrameworkSystem implements Debugger, OutputStreamer {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $debugInstance          The prepared debug instance
  39          */
  40         public final static function createDebugWebOutput () {
  41                 // Get a new instance
  42                 $debugInstance = new DebugWebOutput();
  43
  44                 // Return it
  45                 return $debugInstance;
  46         }
  47
  48         /**
  49          * Outputs the given data directly
  50          *
  51          * @param               $output The HTML output
  52          * @return      void
  53          */
  54         public final function outputStream ($output) {
  55                 // Strip out <br />
  56                 $output = str_replace("<br />", "", $output);
  57                 print(stripslashes($output)."<br />\n");
  58         }
  59
  60         /**
  61          * Assigns a variable for output
  62          *
  63          * @param               $var            The variable we shall assign
  64          * @param               $value  The value to store in the variable
  65          * @return      void
  66          */
  67         public final function assignVariable ($var, $value) {
  68                 // Empty stub!
  69                 trigger_error(__METHOD__.": Stub!");
  70         }
  71
  72         /**
  73          * Output the code
  74          *
  75          * @return      void
  76          */
  77         public final function output ($outStream=false) {
  78                 // Empty output will be silently ignored
  79                 if ($outStream !== false) {
  80                         $this->outputStream($outStream);
  81                 }
  82         }
  83 }
  84
  85 // [EOF]
  86 ?>