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.
7 * @author Roland Haeder <webmaster@ship-simu.org>
9 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.ship-simu.org
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.
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.
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/>.
26 class DebugMiddleware extends BaseMiddleware implements Registerable {
28 * The concrete output instance
30 private $outputInstance = null;
33 * An instance of this class
35 private static $thisInstance = null;
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
47 self::$thisInstance = $this;
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.
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
59 public final static function createDebugMiddleware ($debuggerClass) {
60 // Create an instance if this middleware
61 $debugInstance = new DebugMiddleware();
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);
71 // Set this as output class
72 $debugInstance->setOutputInstance($debuggerInstance);
76 return $debugInstance;
80 * Getter for an instance of this class
82 * @return $thisInstance An instance of this class
84 public final static function getInstance() {
85 return self::$thisInstance;
89 * Setter for output instance
91 * @param $outputInstance The debug output instance
94 public final function setOutputInstance (OutputStreamer $outputInstance) {
95 $this->outputInstance = $outputInstance;
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
103 * @param $outStream Data we shall "stream" out to the world
106 public final function output ($outStream) {
107 // Is the output stream set
108 if (empty($outStream)) {
109 // Initialization phase
113 // Use the output instance
114 $this->outputInstance->outputStream($outStream);