3 * A debug output class for the web browser
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class DebugWebOutput extends BaseFrameworkSystem implements Debugger, OutputStreamer {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $debugInstance The prepared debug instance
40 public static final function createDebugWebOutput () {
42 $debugInstance = new DebugWebOutput();
45 return $debugInstance;
49 * Outputs the given data directly, ignores $stripTags
51 * @param $output The HTML output
52 * @param $stripTags Whether HTML tags shall be stripped out
55 public final function outputStream ($output, $stripTags = FALSE) {
57 $output = str_replace('<br />', '', $output);
58 print(stripslashes($output)."<br />\n");
64 * @param $outStream Stream to output
65 * @param $stripTags Whether HTML tags shall be stripped out
68 public final function output ($outStream = FALSE, $stripTags = FALSE) {
69 // Empty output will be silently ignored
70 if ($outStream !== FALSE) {
71 $this->outputStream($outStream, $stripTags);
76 * Streams the data and maybe does something to it
78 * @param $data The data (string mostly) to "stream"
79 * @return $data The data (string mostly) to "stream"
80 * @throws UnsupportedOperationException If this method is called
82 public function streamData ($data) {
83 self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
84 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
88 * Determines seek position
90 * @return $seekPosition Current seek position
91 * @throws UnsupportedOperationException If this method is called
93 public function determineSeekPosition () {
94 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
98 * Seek to given offset (default) or other possibilities as fseek() gives.
100 * @param $offset Offset to seek to (or used as "base" for other seeks)
101 * @param $whence Added to offset (default: only use offset to seek to)
102 * @return $status Status of file seek: 0 = success, -1 = failed
103 * @throws UnsupportedOperationException If this method is called
105 public function seek ($offset, $whence = SEEK_SET) {
106 self::createDebugInstance(__CLASS__)->debugOutput('offset=' . $offset . ',whence=' . $whence);
107 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
113 * @return $size Size (in bytes) of file
114 * @throws UnsupportedOperationException If this method is called
116 public function size () {
117 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);