inc/main/classes/output/debug/web/class_DebugWebOutput.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Output\Debug;
   4
   5 // Import framework stuff
   6 use CoreFramework\Debug\Debugger;
   7 use CoreFramework\Output\Debug\BaseDebugOutput;
   8
   9 /**
  10  * A debug output class for the web browser
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class DebugWebOutput extends BaseDebugOutput implements Debugger, OutputStreamer {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Creates an instance of this class
  44          *
  45          * @return      $debugInstance  The prepared debug instance
  46          */
  47         public static final function createDebugWebOutput () {
  48                 // Get a new instance
  49                 $debugInstance = new DebugWebOutput();
  50
  51                 // Return it
  52                 return $debugInstance;
  53         }
  54
  55         /**
  56          * Outputs the given data directly, ignores $stripTags
  57          *
  58          * @param       $output         The HTML output
  59          * @param       $stripTags      Whether HTML tags shall be stripped out
  60          * @return      void
  61          */
  62         public final function outputStream ($output, $stripTags = FALSE) {
  63                 // Strip out <br />
  64                 $output = str_replace('<br />', '', $output);
  65                 print(stripslashes($output)."<br />\n");
  66         }
  67
  68         /**
  69          * Output the code
  70          *
  71          * @param       $outStream      Stream to output
  72          * @param       $stripTags      Whether HTML tags shall be stripped out
  73          * @return      void
  74          */
  75         public final function output ($outStream = FALSE, $stripTags = FALSE) {
  76                 // Empty output will be silently ignored
  77                 if ($outStream !== FALSE) {
  78                         $this->outputStream($outStream, $stripTags);
  79                 } // END - if
  80         }
  81
  82         /**
  83          * Streams the data and maybe does something to it
  84          *
  85          * @param       $data   The data (string mostly) to "stream"
  86          * @return      $data   The data (string mostly) to "stream"
  87          * @throws      UnsupportedOperationException   If this method is called
  88          */
  89         public function streamData ($data) {
  90                 self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
  91                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  92         }
  93
  94         /**
  95          * Determines seek position
  96          *
  97          * @return      $seekPosition   Current seek position
  98          * @throws      UnsupportedOperationException   If this method is called
  99          */
 100         public function determineSeekPosition () {
 101                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 102         }
 103
 104         /**
 105          * Seek to given offset (default) or other possibilities as fseek() gives.
 106          *
 107          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
 108          * @param       $whence         Added to offset (default: only use offset to seek to)
 109          * @return      $status         Status of file seek: 0 = success, -1 = failed
 110          * @throws      UnsupportedOperationException   If this method is called
 111          */
 112         public function seek ($offset, $whence = SEEK_SET) {
 113                 self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] offset=' . $offset . ',whence=' . $whence);
 114                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 115         }
 116
 117         /**
 118          * Size of file stack
 119          *
 120          * @return      $size   Size (in bytes) of file
 121          * @throws      UnsupportedOperationException   If this method is called
 122          */
 123         public function size () {
 124                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 125         }
 126
 127 }