/**
* A debug output class for the web browser
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
/**
* Creates an instance of this class
*
- * @return $debugInstance The prepared debug instance
+ * @return $debugInstance The prepared debug instance
*/
- public final static function createDebugWebOutput () {
+ public static final function createDebugWebOutput () {
// Get a new instance
$debugInstance = new DebugWebOutput();
}
/**
- * Outputs the given data directly
+ * Outputs the given data directly, ignores $stripTags
*
- * @param $output The HTML output
+ * @param $output The HTML output
+ * @param $stripTags Whether HTML tags shall be stripped out
* @return void
*/
- public final function outputStream ($output) {
+ public final function outputStream ($output, $stripTags = FALSE) {
// Strip out <br />
- $output = str_replace("<br />", "", $output);
+ $output = str_replace('<br />', '', $output);
print(stripslashes($output)."<br />\n");
}
/**
- * Assigns a variable for output
+ * Output the code
*
- * @param $var The variable we shall assign
- * @param $value The value to store in the variable
+ * @param $outStream Stream to output
+ * @param $stripTags Whether HTML tags shall be stripped out
* @return void
*/
- public final function assignVariable ($var, $value) {
- // Empty stub!
- trigger_error(__METHOD__.": Stub!");
+ public final function output ($outStream = FALSE, $stripTags = FALSE) {
+ // Empty output will be silently ignored
+ if ($outStream !== FALSE) {
+ $this->outputStream($outStream, $stripTags);
+ } // END - if
}
/**
- * Output the code
+ * Streams the data and maybe does something to it
*
- * @return void
+ * @param $data The data (string mostly) to "stream"
+ * @return $data The data (string mostly) to "stream"
+ * @throws UnsupportedOperationException If this method is called
*/
- public final function output ($outStream=false) {
- // Empty output will be silently ignored
- if ($outStream !== false) {
- $this->outputStream($outStream);
- }
+ public function streamData ($data) {
+ self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Determines seek position
+ *
+ * @return $seekPosition Current seek position
+ * @throws UnsupportedOperationException If this method is called
+ */
+ public function determineSeekPosition () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Seek to given offset (default) or other possibilities as fseek() gives.
+ *
+ * @param $offset Offset to seek to (or used as "base" for other seeks)
+ * @param $whence Added to offset (default: only use offset to seek to)
+ * @return $status Status of file seek: 0 = success, -1 = failed
+ * @throws UnsupportedOperationException If this method is called
+ */
+ public function seek ($offset, $whence = SEEK_SET) {
+ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] offset=' . $offset . ',whence=' . $whence);
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Size of file stack
+ *
+ * @return $size Size (in bytes) of file
+ * @throws UnsupportedOperationException If this method is called
+ */
+ public function size () {
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
}
}