1f6c6b35df6c55633f5941213d0706c5ca1b44a1
[core.git] / 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@shipsimu.org>
8  * @version             0.0.0
9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
10  * @license             GNU GPL 3.0 or any newer version
11  * @link                http://www.shipsimu.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 $selfInstance = 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::$selfInstance = $this;
48
49                 // Set it so all can use it
50                 $this->setDebugInstance($this);
51         }
52
53         /**
54          * Create a new debug output system.
55          * If no output is given this class is currently being used for back-fall.
56          * This fall-back mechanism will become deprecated very soon.
57          *
58          * @param       $outputClass    The class name which we shall use for
59          *                                                      registering the *real* debug output
60          * @param       $className              Class where a output should be created and
61          *                                                      configured for
62          * @return      $debugInstance  An instance of this middleware class
63          */
64         public static final function createDebugMiddleware ($outputClass, $className) {
65                 die(__METHOD__.': outputClass=' . $outputClass . ',className=' . $className);
66                 // Create an instance if this middleware
67                 $debugInstance = new DebugMiddleware();
68
69                 // Default is that $outputClass may be invalid
70                 $isInitialized = FALSE;
71
72                 // Is there a valid output instance provided?
73                 if ((!is_null($outputClass)) && (is_object($outputClass)) && ($outputClass instanceof OutputStreamer)) {
74                         // Use the given output instance
75                         $debugInstance->setOutputInstance($outputClass);
76
77                         // All fine
78                         $isInitialized = TRUE;
79                 } elseif ((!is_null($outputClass)) && (is_string($outputClass)) && (class_exists($outputClass))) {
80                         // A name for a debug output class has been provided so we try to get it
81                         $outputInstance = ObjectFactory::createObjectByName($outputClass);
82
83                         // Set this as output class
84                         $debugInstance->setOutputInstance($outputInstance);
85
86                         // All fine
87                         $isInitialized = TRUE;
88                 }
89
90                 // Is the output class initialized?
91                 if ($isInitialized === TRUE) {
92                         // Then set class name
93                         $debugInstance->getOutputInstance()->setLoggerClassName($className);
94                 } // END - if
95
96                 // Return instance
97                 return $debugInstance;
98         }
99
100         /**
101          * Getter for an instance of this class
102          *
103          * @return      $selfInstance           An instance of this class
104          */
105         public static final function getSelfInstance() {
106                 return self::$selfInstance;
107         }
108
109         /**
110          * Setter for output instance
111          *
112          * @param       $outputInstance The debug output instance
113          * @return      void
114          */
115         public final function setOutputInstance (OutputStreamer $outputInstance) {
116                 $this->outputInstance = $outputInstance;
117         }
118
119         /**
120          * This method shall send debug output which can be HTML code for the
121          * browser or debug lines for a log file, etc. to the registered debug
122          * output instance.
123          *
124          * @param       $outStream      Data we shall 'stream' out to the world
125          * @param       $stripTags      Whether HTML tags shall be stripped out
126          * @return      void
127          */
128         public final function output ($outStream, $stripTags = FALSE) {
129                 // Is the output stream set
130                 if (empty($outStream)) {
131                         // @TODO Initialization phase
132                         return;
133                 } // END - if
134
135                 // Use the output instance
136                 $this->outputInstance->outputStream($outStream, $stripTags);
137         }
138 }
139
140 // [EOF]
141 ?>