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.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
   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 DebugConsoleOutput extends BaseFrameworkSystem implements Debugger, OutputStreamer, Registerable {
  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 static final function createDebugConsoleOutput () {
  41                 // Get a new instance
  42                 $debugInstance = new DebugConsoleOutput();
  43
  44                 // Return it
  45                 return $debugInstance;
  46         }
  47
  48         /**
  49          * Outputs the given data without HTML tags
  50          *
  51          * @param       $output         The HTML'ed output
  52          * @param       $stripTags      Whether HTML tags shall be stripped out
  53          * @return      void
  54          */
  55         public final function outputStream ($output, $stripTags = false) {
  56                 // Strip HTML tags out?
  57                 if ($stripTags === true) {
  58                         // Prepare the output without HTML tags
  59                         $output = trim(html_entity_decode(strip_tags(stripslashes($output))));
  60                 } else {
  61                         // Prepare the output with HTML tags
  62                         $output = trim(stripslashes($output));
  63                 }
  64
  65                 // Are debug times enabled?
  66                 if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') {
  67                         // Output it first
  68                         $output = $this->getPrintableExecutionTime() . $output;
  69                 } // END - if
  70
  71                 // And print it out...
  72                 printf('%s%s', $output, chr(10));
  73         }
  74
  75         /**
  76          * Output the code
  77          *
  78          * @param       $outStream      Stream to output
  79          * @param       $stripTags      Whether HTML tags shall be stripped out
  80          * @return      void
  81          */
  82         public final function output ($outStream = false, $stripTags = false) {
  83                 // Empty output will be silently ignored
  84                 if ($outStream !== false) {
  85                         $this->outputStream($outStream, $stripTags);
  86                 } // END - if
  87         }
  88
  89         /**
  90          * Streams the data and maybe does something to it
  91          *
  92          * @param       $data   The data (string mostly) to "stream"
  93          * @return      $data   The data (string mostly) to "stream"
  94          * @throws      UnsupportedOperationException   If this method is called
  95          */
  96         public function streamData ($data) {
  97                 self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
  98                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  99         }
 100 }
 101
 102 // [EOF]
 103 ?>