e9be4a5910b617e06daa63f632f94a8614829f6b
[mailer.git] / inc / classes / main / debug / class_DebugConsoleOutput.php
1 <?php
2 /**
3  * A debug output class for the console (e.g. hub software)
4  *
5  * @author              Roland Haeder <webmaster@mxchange.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 DebugConsoleOutput 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 for the console");
36
37                 // Create an unique ID
38                 $this->createUniqueID();
39         }
40
41         /**
42          * Creates an instance of this class
43          *
44          * @return      $debugInstance          The prepared debug instance
45          */
46         public final static function createDebugConsoleOutput () {
47                 // Get a new instance
48                 $debugInstance = new DebugConsoleOutput();
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                 print html_entity_decode(strip_tags($output));
62         }
63
64         /**
65          * Assigns a variable for output
66          *
67          * @param               $var            The variable we shall assign
68          * @param               $value  The value to store in the variable
69          * @return      void
70          */
71         public final function assignVariable ($var, $value) {
72                 // Empty stub!
73                 trigger_error(__METHOD__.": Stub!");
74         }
75
76         /**
77          * Output the code
78          *
79          * @return      void
80          */
81         public final function output ($outStream=false) {
82                 // Empty output will be silently ignored
83                 if ($outStream !== false) {
84                         $this->outputStream($outStream);
85                 }
86         }
87 }
88
89 // [EOF]
90 ?>