3 namespace CoreFramework\Output;
5 // Import framework stuff
6 use CoreFramework\Manager\ManageableApplication;
7 use CoreFramework\Registry\Registerable;
10 * This class simply puts HTML code / JavaScript code or CSS code out to the
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 class WebOutput extends BaseOutput implements OutputStreamer, Registerable {
34 * The instance for the singleton design pattern
36 private static $webInstance = NULL;
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Create a new web output system and set the content type
51 * @param $applicationInstance An instance of a ManageableApplication class
52 * @return $debugInstance An instance of this middleware class
54 public static final function createWebOutput (ManageableApplication $applicationInstance) {
55 // Is the self-instance already set?
56 if (is_null(self::$webInstance)) {
57 // Get a new instance and set it
58 self::$webInstance = new WebOutput();
60 // Get the content type
61 $contentType = self::$webInstance->getConfigInstance()->getConfigEntry('web_content_type');
63 // Set the content type
64 if (!empty($contentType)) {
66 $applicationInstance->getResponseInstance()->addHeader('Content-type', $contentType);
71 return self::$webInstance;
77 * @param $outStream Stream to output
78 * @param $stripTags Whether HTML tags shall be stripped out
81 public final function output ($outStream = FALSE, $stripTags = FALSE) {
82 print(stripslashes($outStream));
86 * Determines seek position
88 * @return $seekPosition Current seek position
89 * @throws UnsupportedOperationException If this method is called
91 public function determineSeekPosition () {
92 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
96 * Seek to given offset (default) or other possibilities as fseek() gives.
98 * @param $offset Offset to seek to (or used as "base" for other seeks)
99 * @param $whence Added to offset (default: only use offset to seek to)
100 * @return $status Status of file seek: 0 = success, -1 = failed
101 * @throws UnsupportedOperationException If this method is called
103 public function seek ($offset, $whence = SEEK_SET) {
104 self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] offset=' . $offset . ',whence=' . $whence);
105 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
111 * @return $size Size (in bytes) of file
112 * @throws UnsupportedOperationException If this method is called
114 public function size () {
115 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);