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, 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 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                 // Set description
  35                 $this->setObjectDescription("Debug output to error_log()");
  36
  37                 // Create an unique ID
  38                 $this->generateUniqueId();
  39         }
  40
  41         /**
  42          * Creates an instance of this class
  43          *
  44          * @return      $debugInstance          The prepared debug instance
  45          */
  46         public final static function createDebugErrorLogOutput () {
  47                 // Get a new instance
  48                 $debugInstance = new DebugErrorLogOutput();
  49
  50                 // Return it
  51                 return $debugInstance;
  52         }
  53
  54         /**
  55          * Outputs the given data without HTML tags
  56          *
  57          * @param               $output The HTML'ed output
  58          * @return      void
  59          */
  60         public final function outputStream ($output) {
  61                 // Split multiple lines into and array to put them out line-by-line
  62                 $errorLines = explode("\n", $output);
  63                 foreach ($errorLines as $err) {
  64                         $err = trim($err);
  65                         // Log only none-empty lines
  66                         if (!empty($err)) {
  67                                 // Log this line
  68                                 error_log(html_entity_decode(strip_tags($err)), 0);
  69                         }
  70                 }
  71         }
  72
  73         /**
  74          * Assigns a variable for output
  75          *
  76          * @param               $var            The variable we shall assign
  77          * @param               $value  The value to store in the variable
  78          * @return      void
  79          */
  80         public final function assignVariable ($var, $value) {
  81                 // Empty stub!
  82                 trigger_error(__METHOD__.": Stub!");
  83         }
  84
  85         /**
  86          * Output the code
  87          *
  88          * @return      void
  89          */
  90         public final function output ($outStream=false) {
  91                 // Empty output will be silently ignored
  92                 if ($outStream !== false) {
  93                         $this->outputStream($outStream);
  94                 }
  95         }
  96 }
  97
  98 // [EOF]
  99 ?>