3 namespace Org\Mxchange\CoreFramework\Output;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
8 use Org\Mxchange\CoreFramework\Output\BaseOutput;
9 use Org\Mxchange\CoreFramework\Stream\Output\OutputStreamer;
12 * This class simply puts text without any HTML code out. This class is suiable
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 <<<<<<< HEAD:framework/main/classes/output/console/class_ConsoleOutput.php
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
21 >>>>>>> Some updates::inc/main/classes/output/console/class_ConsoleOutput.php
22 * @license GNU GPL 3.0 or any newer version
23 * @link http://www.shipsimu.org
25 * This program is free software: you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation, either version 3 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 class ConsoleOutput extends BaseOutput implements OutputStreamer {
40 * The instance for the singleton design pattern
42 private static $consoleInstance = NULL;
45 * Protected constructor
49 protected function __construct () {
50 // Call parent constructor
51 parent::__construct(__CLASS__);
55 * Create a new web output system and set the content type
57 * @param $contentType A valid content-type
58 * @return $debugInstance An instance of this middleware class
60 public static final function createConsoleOutput ($contentType) {
61 // Cast the content-type to string
62 $contentType = (string) $contentType;
63 $contentType = trim($contentType);
66 self::$consoleInstance = new ConsoleOutput();
68 // Set the content type
69 // @TODO Need to rewrite this to $requestInstance->addHeader()
70 if (!empty($contentType)) {
71 @header(sprintf('Content-type: %s',
77 return self::$consoleInstance;
81 * Getter for an instance of this class
83 * @return $consoleInstance An instance of this class
85 public static final function getInstance() {
86 // Is the self-instance already set?
87 if (is_null(self::$consoleInstance)) {
88 $contentType = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('web_content_type');
89 self::$consoleInstance = ConsoleOutput::createConsoleOutput($contentType);
92 // Return the instance
93 return self::$consoleInstance;
99 * @param $outStream Something we shall sent to the console
100 * @param $stripTags Whether HTML tags shall be stripped out
103 public final function output ($outStream = false, $stripTags = false) {
104 print trim($outStream) . PHP_EOL;
108 * Determines seek position
110 * @return $seekPosition Current seek position
111 * @throws UnsupportedOperationException If this method is called
113 public function determineSeekPosition () {
114 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
118 * Seek to given offset (default) or other possibilities as fseek() gives.
120 * @param $offset Offset to seek to (or used as "base" for other seeks)
121 * @param $whence Added to offset (default: only use offset to seek to)
122 * @return $status Status of file seek: 0 = success, -1 = failed
123 * @throws UnsupportedOperationException If this method is called
125 public function seek ($offset, $whence = SEEK_SET) {
126 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] offset=' . $offset . ',whence=' . $whence);
127 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
133 * @return $size Size (in bytes) of file
134 * @throws UnsupportedOperationException If this method is called
136 public function size () {
137 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);