inc/classes/main/debug/class_DebugErrorLogOutput.php

   1 <?php
   2 /**
   3  * A debug output class for PHP's error_log() command
   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 DebugErrorLogOutput 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 static final function createDebugErrorLogOutput () {
  41                 // Get a new instance
  42                 $debugInstance = new DebugErrorLogOutput();
  43
  44                 // Return it
  45                 return $debugInstance;
  46         }
  47
  48         /**
  49          * Outputs the given data without HTML tags, ignores $stripTags
  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                 // Split multiple lines into and array to put them out line-by-line
  57                 $errorLines = explode(chr(10), $output);
  58
  59                 // "Walk" through all lines
  60                 foreach ($errorLines as $err) {
  61                         // Trim any spaces, \n, \r etc. out
  62                         $err = trim($err);
  63
  64                         // Log only none-empty lines
  65                         if (!empty($err)) {
  66                                 // Log this line
  67                                 error_log(html_entity_decode(strip_tags($err)), 0);
  68                         } // END - if
  69                 } // END - foreach
  70         }
  71
  72         /**
  73          * Output the code
  74          *
  75          * @param       $outStream      Stream to output
  76          * @param       $stripTags      Whether HTML tags shall be stripped out
  77          * @return      void
  78          */
  79         public final function output ($outStream = FALSE, $stripTags = FALSE) {
  80                 // Empty output will be silently ignored
  81                 if ($outStream !== FALSE) {
  82                         $this->outputStream($outStream);
  83                 }
  84         }
  85
  86         /**
  87          * Streams the data and maybe does something to it
  88          *
  89          * @param       $data   The data (string mostly) to "stream"
  90          * @return      $data   The data (string mostly) to "stream"
  91          * @throws      UnsupportedOperationException   If this method is called
  92          */
  93         public function streamData ($data) {
  94                 self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
  95                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  96         }
  97 }
  98
  99 // [EOF]
 100 ?>