Renamed classes/main/ to main/classes/ + added FuseFeature, an upcoming feature

[core.git] / inc / main / classes / output / console / class_ConsoleOutput.php

diff --git a/inc/main/classes/output/console/class_ConsoleOutput.php b/inc/main/classes/output/console/class_ConsoleOutput.php
new file mode 100644 (file)
index 0000000..7d93422
--- /dev/null
+++ b/inc/main/classes/output/console/class_ConsoleOutput.php
@@ -0,0 +1,129 @@
+<?php
+/**
+ * This class simply puts text without any HTML code out. This class is suiable
+ * for console output
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class ConsoleOutput extends BaseOutput implements OutputStreamer {
+       /**
+        * The instance for the singleton design pattern
+        */
+       private static $consoleInstance = NULL;
+
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+       }
+
+       /**
+        * 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
+        */
+       public static final function createConsoleOutput ($contentType) {
+               // Cast the content-type to string
+               $contentType = (string) $contentType;
+               $contentType = trim($contentType);
+
+               // Get instance
+               self::$consoleInstance = new ConsoleOutput();
+
+               // Set the content type
+               // @TODO Need to rewrite this to $requestInstance->addHeader()
+               if (!empty($contentType)) {
+                       @header(sprintf('Content-type: %s',
+                               $contentType
+                       ));
+               } // END - if
+
+               // Return instance
+               return self::$consoleInstance;
+       }
+
+       /**
+        * Getter for an instance of this class
+        *
+        * @return      $consoleInstance        An instance of this class
+        */
+       public static final function getInstance() {
+               // Is the self-instance already set?
+               if (is_null(self::$consoleInstance)) {
+                       $contentType = FrameworkConfiguration::getSelfInstance()->getConfigEntry('web_content_type');
+                       self::$consoleInstance = ConsoleOutput::createConsoleOutput($contentType);
+               } // END - if
+
+               // Return the instance
+               return self::$consoleInstance;
+       }
+
+       /**
+        * 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, $stripTags = FALSE) {
+               print trim($outStream) . PHP_EOL;
+       }
+
+       /**
+        * 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);
+       }
+}
+
+// [EOF]
+?>