inc/classes/middleware/debug/class_DebugMiddleware.php

   1 <?php
   2 /**
   3  * The middlware debug output system. A *real* or concrete output class shall
   4  * become registered with this middleware because the back-fall class will
   5  * become deprecated soon.
   6  *
   7  * @author              Roland Haeder <webmaster@ship-simu.org>
   8  * @version             0.0.0
   9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  10  * @license             GNU GPL 3.0 or any newer version
  11  * @link                http://www.ship-simu.org
  12  *
  13  * This program is free software: you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation, either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  25  */
  26 class DebugMiddleware extends BaseMiddleware implements Registerable {
  27         /**
  28          * The concrete output instance
  29          */
  30         private $outputInstance = null;
  31
  32         /**
  33          * An instance of this class
  34          */
  35         private static $thisInstance = null;
  36
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45
  46                 // Set own instance
  47                 self::$thisInstance = $this;
  48         }
  49
  50         /**
  51          * Create a new debug output system.
  52          * If no output is given this class is currently being used for back-fall.
  53          * This fall-back mechanism will become deprecated very soon.
  54          *
  55          * @param       $debuggerClass  The class name which we shall use for
  56          *                                                      registering the *real* debug output
  57          * @return      $debugInstance  An instance of this middleware class
  58          */
  59         public final static function createDebugMiddleware ($debuggerClass) {
  60                 // Create an instance if this middleware
  61                 $debugInstance = new DebugMiddleware();
  62
  63                 // Is there a valid output instance provided?
  64                 if ((!is_null($debuggerClass)) && (is_object($debuggerClass)) && ($debuggerClass instanceof OutputStreamer)) {
  65                         // Use the given output instance
  66                         $debugInstance->setOutputInstance($debuggerClass);
  67                 } elseif ((!is_null($debuggerClass)) && (is_string($debuggerClass)) && (class_exists($debuggerClass))) {
  68                         // A name for a debug output class has been provided so we try to get it
  69                         $debuggerInstance = ObjectFactory::createObjectByName($debuggerClass);
  70
  71                         // Set this as output class
  72                         $debugInstance->setOutputInstance($debuggerInstance);
  73                 }
  74
  75                 // Return instance
  76                 return $debugInstance;
  77         }
  78
  79         /**
  80          * Getter for an instance of this class
  81          *
  82          * @return      $thisInstance           An instance of this class
  83          */
  84         public final static function getInstance() {
  85                 return self::$thisInstance;
  86         }
  87
  88         /**
  89          * Setter for output instance
  90          *
  91          * @param       $outputInstance The debug output instance
  92          * @return      void
  93          */
  94         public final function setOutputInstance (OutputStreamer $outputInstance) {
  95                 $this->outputInstance = $outputInstance;
  96         }
  97
  98         /**
  99          * This method shall send debug output which can be HTML code for the
 100          * browser or debug lines for a log file, etc. to the registered debug
 101          * output instance.
 102          *
 103          * @param       $outStream      Data we shall 'stream' out to the world
 104          * @return      void
 105          */
 106         public final function output ($outStream) {
 107                 // Is the output stream set
 108                 if (empty($outStream)) {
 109                         // @TODO Initialization phase
 110                         return;
 111                 } // END - if
 112
 113                 // Use the output instance
 114                 $this->outputInstance->outputStream($outStream);
 115         }
 116 }
 117
 118 // [EOF]
 119 ?>