]> git.mxchange.org Git - core.git/blob - framework/main/classes/output/class_
Some updates:
[core.git] / framework / main / classes / output / class_
1 <?php
2 // Own namespace
3 namespace CoreFramework\Output\;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
8
9 /**
10  * A ??? output class
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14 <<<<<<< HEAD:framework/main/classes/output/class_
15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 =======
17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
18 >>>>>>> Some updates::inc/main/classes/output/class_
19  * @license             GNU GPL 3.0 or any newer version
20  * @link                http://www.shipsimu.org
21  *
22  * This program is free software: you can redistribute it and/or modify
23  * it under the terms of the GNU General Public License as published by
24  * the Free Software Foundation, either version 3 of the License, or
25  * (at your option) any later version.
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  * GNU General Public License for more details.
31  *
32  * You should have received a copy of the GNU General Public License
33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
34  */
35 class ???Output extends BaseOutput implements OutputStreamer, Registerable {
36         /**
37          * The instance for the singleton design pattern
38          */
39         private static $!!!Instance = NULL;
40
41         /**
42          * Protected constructor
43          *
44          * @return      void
45          */
46         protected function __construct () {
47                 // Call parent constructor
48                 parent::__construct(__CLASS__);
49         }
50
51         /**
52          * Create a new !!! output system and set the content type
53          *
54          * @param       $applicationInstance    An instance of a ManageableApplication class
55          * @return      $debugInstance                  An instance of this middleware class
56          */
57         public static final function createWebOutput (ManageableApplication $applicationInstance) {
58                 // Is the self-instance already set?
59                 if (is_null(self::$!!!Instance)) {
60                         // Get a new instance and set it
61                         self::$!!!Instance = new WebOutput();
62
63                         // Get the content type
64                         $contentType = self::$!!!Instance->getConfigInstance()->getConfigEntry('!!!_content_type');
65
66                         // Set the content type
67                         if (!empty($contentType)) {
68                                 // Set the header
69                                 FrameworkBootstrap::getResponseInstance()->addHeader('Content-type', $contentType);
70                         } // END - if
71                 } // END - if
72
73                 // Return instance
74                 return self::$!!!Instance;
75         }
76
77         /**
78          * Output the code
79          *
80          * @param       $outStream      Stream to output
81          * @param       $stripTags      Whether HTML tags shall be stripped out
82          * @return      void
83          * @todo        0% done
84          */
85         public final function output ($outStream = false, $stripTags = false) {
86                 $this->partialStub('Please implement this method. outStream()=' . strlen($outStream) . ',stripTags=' . intval($stripTags));
87         }
88
89         /**
90          * Determines seek position
91          *
92          * @return      $seekPosition   Current seek position
93          * @throws      UnsupportedOperationException   If this method is called
94          */
95         public function determineSeekPosition () {
96                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
97         }
98
99         /**
100          * Seek to given offset (default) or other possibilities as fseek() gives.
101          *
102          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
103          * @param       $whence         Added to offset (default: only use offset to seek to)
104          * @return      $status         Status of file seek: 0 = success, -1 = failed
105          * @throws      UnsupportedOperationException   If this method is called
106          */
107         public function seek ($offset, $whence = SEEK_SET) {
108                 self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] offset=' . $offset . ',whence=' . $whence);
109                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
110         }
111
112         /**
113          * Size of file stack
114          *
115          * @return      $size   Size (in bytes) of file
116          * @throws      UnsupportedOperationException   If this method is called
117          */
118         public function size () {
119                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
120         }
121
122 }