Copyright updated, interface RenderableMenu added
[core.git] / inc / classes / main / output / class_WebOutput.php
1 <?php
2 /**
3  * This class simply puts HTML code / JavaScript code or CSS code out to the
4  * browser
5  *
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
24  */
25 class WebOutput extends BaseFrameworkSystem implements OutputStreamer, Registerable {
26         /**
27          * The instance for the singleton design pattern
28          */
29         private static $webInstance = null;
30
31         /**
32          * Protected constructor
33          *
34          * @return      void
35          */
36         protected function __construct () {
37                 // Call parent constructor
38                 parent::__construct(__CLASS__);
39         }
40
41         /**
42          * Create a new web output system and set the content type
43          *
44          * @param               $contentType            A valid content-type
45          * @return      $debugInstance          An instance of this middleware class
46          */
47         public final static function createWebOutput ($contentType) {
48                 // Is there no instance?
49                 if (is_null(self::$webInstance)) {
50                         // Cast the content-type to string and trim it
51                         $contentType = (string) $contentType;
52                         $contentType = trim($contentType);
53
54                         // Set the content type
55                         // @TODO Need to rewrite this to $requestInstance->addHeader()
56                         if (!empty($contentType)) {
57                                 @header(sprintf("Content-type: %s",
58                                         $contentType
59                                 ));
60                         } // END - if
61
62                         // Get a new instance and set it
63                         self::$webInstance = new WebOutput();
64                 } // END - if
65
66                 // Return instance
67                 return self::$webInstance;
68         }
69
70         /**
71          * Assigns a variable for output
72          *
73          * @param               $var            The variable we shall assign
74          * @param               $value  The value to store in the variable
75          * @return      void
76          */
77         public function assignVariable($var, $value) {
78                 // Stub message because we don't have it here
79                 trigger_error(__METHOD__.": Stub!");
80         }
81
82         /**
83          * Output the code
84          *
85          * @return      void
86          */
87         public final function output ($outStream = false) {
88                 print(stripslashes($outStream));
89         }
90 }
91
92 // [EOF]
93 ?>