Introduced initWebOutputInstance() which will initialize a web output instance.
[core.git] / inc / classes / main / output / class_WebOutput.php
index 14b828334b11f6cf214faddd7a5beca134768f06..c000ebcc4df0789d83b2096084439a5a80509d64 100644 (file)
@@ -3,11 +3,11 @@
  * This class simply puts HTML code / JavaScript code or CSS code out to the
  * 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, 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,7 +26,7 @@ class WebOutput extends BaseFrameworkSystem implements OutputStreamer, Registera
        /**
         * The instance for the singleton design pattern
         */
-       private static $webInstance = null;
+       private static $webInstance = NULL;
 
        /**
         * Protected constructor
@@ -41,26 +41,23 @@ class WebOutput extends BaseFrameworkSystem implements OutputStreamer, Registera
        /**
         * Create a new web output system and set the content type
         *
-        * @param               $contentType            A valid content-type
-        * @return      $debugInstance          An instance of this middleware class
+        * @param       $applicationInstance    An instance of a ManageableApplication class
+        * @return      $debugInstance                  An instance of this middleware class
         */
-       public final static function createWebOutput ($contentType) {
-               // Is there no instance?
+       public static final function createWebOutput (ManageableApplication $applicationInstance) {
+               // Is the self-instance already set?
                if (is_null(self::$webInstance)) {
-                       // Cast the content-type to string and trim it
-                       $contentType = (string) $contentType;
-                       $contentType = trim($contentType);
+                       // Get a new instance and set it
+                       self::$webInstance = new WebOutput();
+
+                       // Get the content type
+                       $contentType = self::$webInstance->getConfigInstance()->getConfigEntry('web_content_type');
 
                        // Set the content type
-                       // @TODO Need to rewrite this to $requestInstance->addHeader()
                        if (!empty($contentType)) {
-                               @header(sprintf("Content-type: %s",
-                                       $contentType
-                               ));
+                               // Set the header
+                               $applicationInstance->getResponseInstance()->addHeader('Content-type', $contentType);
                        } // END - if
-
-                       // Get a new instance and set it
-                       self::$webInstance = new WebOutput();
                } // END - if
 
                // Return instance
@@ -68,24 +65,47 @@ class WebOutput extends BaseFrameworkSystem implements OutputStreamer, Registera
        }
 
        /**
-        * 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 function assignVariable($var, $value) {
-               // Stub message because we don't have it here
-               trigger_error(__METHOD__.": Stub!");
+       public final function output ($outStream = FALSE, $stripTags = FALSE) {
+               print(stripslashes($outStream));
        }
 
        /**
-        * Output the code
+        * Determines seek position
         *
-        * @return      void
+        * @return      $seekPosition   Current seek position
+        * @throws      UnsupportedOperationException   If this method is called
         */
-       public final function output ($outStream = false) {
-               print(stripslashes($outStream));
+       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);
        }
 }