Introduced initWebOutputInstance() which will initialize a web output instance.
[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@shipsimu.org>
7  * @version             0.0.0
8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.shipsimu.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       $applicationInstance    An instance of a ManageableApplication class
45          * @return      $debugInstance                  An instance of this middleware class
46          */
47         public static final function createWebOutput (ManageableApplication $applicationInstance) {
48                 // Is the self-instance already set?
49                 if (is_null(self::$webInstance)) {
50                         // Get a new instance and set it
51                         self::$webInstance = new WebOutput();
52
53                         // Get the content type
54                         $contentType = self::$webInstance->getConfigInstance()->getConfigEntry('web_content_type');
55
56                         // Set the content type
57                         if (!empty($contentType)) {
58                                 // Set the header
59                                 $applicationInstance->getResponseInstance()->addHeader('Content-type', $contentType);
60                         } // END - if
61                 } // END - if
62
63                 // Return instance
64                 return self::$webInstance;
65         }
66
67         /**
68          * Output the code
69          *
70          * @param       $outStream      Stream to output
71          * @param       $stripTags      Whether HTML tags shall be stripped out
72          * @return      void
73          */
74         public final function output ($outStream = FALSE, $stripTags = FALSE) {
75                 print(stripslashes($outStream));
76         }
77
78         /**
79          * Determines seek position
80          *
81          * @return      $seekPosition   Current seek position
82          * @throws      UnsupportedOperationException   If this method is called
83          */
84         public function determineSeekPosition () {
85                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
86         }
87
88         /**
89          * Seek to given offset (default) or other possibilities as fseek() gives.
90          *
91          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
92          * @param       $whence         Added to offset (default: only use offset to seek to)
93          * @return      $status         Status of file seek: 0 = success, -1 = failed
94          * @throws      UnsupportedOperationException   If this method is called
95          */
96         public function seek ($offset, $whence = SEEK_SET) {
97                 self::createDebugInstance(__CLASS__)->debugOutput('offset=' . $offset . ',whence=' . $whence);
98                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
99         }
100
101         /**
102          * Size of file stack
103          *
104          * @return      $size   Size (in bytes) of file
105          * @throws      UnsupportedOperationException   If this method is called
106          */
107         public function size () {
108                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
109         }
110 }
111
112 // [EOF]
113 ?>