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