Introduced initWebOutputInstance() which will initialize a web output instance.
[core.git] / inc / classes / main / output / class_ConsoleOutput.php
index a8b8155e76eb7c2919b3513b6ebaeb49f0ef64cf..c2ff3d4f4c521c3e3c660a488edd83b89aefd425 100644 (file)
@@ -3,11 +3,11 @@
  * This class simply puts text without any HTML code out. This class is suiable
  * for console output
  *
- * @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 Core Developer Team
+ * @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
@@ -26,12 +26,7 @@ class ConsoleOutput extends BaseFrameworkSystem implements OutputStreamer {
        /**
         * The instance for the singleton design pattern
         */
-       private static $consoleInstance = null;
-
-       /**
-        * Assigned variables
-        */
-       private $vars = array();
+       private static $consoleInstance = NULL;
 
        /**
         * Protected constructor
@@ -49,7 +44,7 @@ class ConsoleOutput extends BaseFrameworkSystem implements OutputStreamer {
         * @param       $contentType    A valid content-type
         * @return      $debugInstance  An instance of this middleware class
         */
-       public final static function createConsoleOutput ($contentType) {
+       public static final function createConsoleOutput ($contentType) {
                // Cast the content-type to string
                $contentType = (string) $contentType;
                $contentType = trim($contentType);
@@ -60,7 +55,7 @@ class ConsoleOutput extends BaseFrameworkSystem implements OutputStreamer {
                // Set the content type
                // @TODO Need to rewrite this to $requestInstance->addHeader()
                if (!empty($contentType)) {
-                       @header(sprintf("Content-type: %s",
+                       @header(sprintf('Content-type: %s',
                                $contentType
                        ));
                } // END - if
@@ -74,11 +69,14 @@ class ConsoleOutput extends BaseFrameworkSystem implements OutputStreamer {
         *
         * @return      $consoleInstance        An instance of this class
         */
-       public final static function getInstance() {
+       public static final function getInstance() {
+               // Is the self-instance already set?
                if (is_null(self::$consoleInstance)) {
-                       $contentType = FrameworkConfiguration::getInstance()->readConfig('web_content_type');
+                       $contentType = FrameworkConfiguration::getSelfInstance()->getConfigEntry('web_content_type');
                        self::$consoleInstance = ConsoleOutput::createConsoleOutput($contentType);
-               }
+               } // END - if
+
+               // Return the instance
                return self::$consoleInstance;
        }
 
@@ -86,29 +84,44 @@ class ConsoleOutput extends BaseFrameworkSystem implements OutputStreamer {
         * Output the code
         *
         * @param       $outStream      Something we shall sent to the console
+        * @param       $stripTags      Whether HTML tags shall be stripped out
         * @return      void
         */
-       public final function output ($outStream = false) {
-               if ($outStream === false) {
-                       // Output something here...
-                       foreach ($this->vars as $var => $value) {
-                               $this->output("var=".$var.", value=".$value.'');
-                       }
-               } else {
-                       // Output it to the console
-                       printf("%s\n", trim(html_entity_decode(strip_tags(stripslashes($outStream)))));
-               }
+       public final function output ($outStream = FALSE, $stripTags = FALSE) {
+               print trim($outStream) . PHP_EOL;
        }
 
        /**
-        * Assigns a variable for output
+        * Determines seek position
         *
-        * @param       $var    The variable we shall assign
-        * @param       $value  The value to store in the variable
-        * @return      void
+        * @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 assignVariable ($var, $value) {
-               $this->vars[$var] = $value;
+       public function size () {
+               throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
        }
 }