Renamed one getSeekPosition() to determineSeekPosition().
[core.git] / inc / classes / main / debug / class_DebugConsoleOutput.php
index 16e8dfa80435ad8ec351be442f000f655b5d5706..401dc9df905d8f865715fa04bc5224cac5ae6551 100644 (file)
@@ -2,11 +2,11 @@
 /**
  * A debug output class for the console (e.g. hub software)
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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
@@ -52,9 +52,9 @@ class DebugConsoleOutput extends BaseFrameworkSystem implements Debugger, Output
         * @param       $stripTags      Whether HTML tags shall be stripped out
         * @return      void
         */
-       public final function outputStream ($output, $stripTags = false) {
+       public final function outputStream ($output, $stripTags = FALSE) {
                // Strip HTML tags out?
-               if ($stripTags === true) {
+               if ($stripTags === TRUE) {
                        // Prepare the output without HTML tags
                        $output = trim(html_entity_decode(strip_tags(stripslashes($output))));
                } else {
@@ -79,9 +79,9 @@ class DebugConsoleOutput extends BaseFrameworkSystem implements Debugger, Output
         * @param       $stripTags      Whether HTML tags shall be stripped out
         * @return      void
         */
-       public final function output ($outStream = false, $stripTags = false) {
+       public final function output ($outStream = FALSE, $stripTags = FALSE) {
                // Empty output will be silently ignored
-               if ($outStream !== false) {
+               if ($outStream !== FALSE) {
                        $this->outputStream($outStream, $stripTags);
                } // END - if
        }
@@ -94,7 +94,40 @@ class DebugConsoleOutput extends BaseFrameworkSystem implements Debugger, Output
         * @throws      UnsupportedOperationException   If this method is called
         */
        public function streamData ($data) {
-               $this->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
+               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('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);
        }
 }