ship-simu/inc/classes/main/debug/class_DebugConsoleOutput.php

   1 <?php
   2 /**
   3  * A debug output class for the console (e.g. hub software)
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             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  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23 class DebugConsoleOutput extends BaseFrameworkSystem implements Debugger, OutputStreamer {
  24         /**
  25          * Private constructor
  26          *
  27          * @return      void
  28          */
  29         private function __construct () {
  30                 // Call parent constructor
  31                 parent::constructor(__CLASS__);
  32
  33                 // Set description
  34                 $this->setPartDescr("Debug-Ausgabe auf Konsole");
  35
  36                 // Create an unique ID
  37                 $this->createUniqueID();
  38         }
  39
  40         /**
  41          * Creates an instance of this class
  42          *
  43          * @return      $debugInstance          The prepared debug instance
  44          */
  45         public final static function createDebugConsoleOutput () {
  46                 // Get a new instance
  47                 $debugInstance = new DebugConsoleOutput();
  48
  49                 // Return it
  50                 return $debugInstance;
  51         }
  52
  53         /**
  54          * Outputs the given data without HTML tags
  55          *
  56          * @param               $output The HTML'ed output
  57          * @return      void
  58          */
  59         public final function outputStream ($output) {
  60                 print html_entity_decode(strip_tags($output));
  61         }
  62
  63         /**
  64          * Outputs the given data without HTML tags
  65          *
  66          * @param               $output The HTML'ed output
  67          * @return      void
  68          */
  69         public final function output ($outStream=false) {
  70                 // false will be silently ignored
  71                 if ($outStream !== false) {
  72                         $this->outputStream($outStream);
  73                 }
  74         }
  75
  76         /**
  77          * Assigns a variable for output
  78          *
  79          * @param               $var            The variable we shall assign
  80          * @param               $value  The value to store in the variable
  81          * @return      void
  82          */
  83         public final function assignVariable ($var, $value) {
  84                 trigger_error(__METHOD__.": Stub!");
  85         }
  86 }
  87
  88 //
  89 ?>