Continued:
[core.git] / framework / main / classes / output / debug / console / class_DebugConsoleOutput.php
index 113428a409b2af933b98191c03d703b8c5a07904..140365da8eaf583512d146aff1fdf5a7e27b443f 100644 (file)
@@ -5,6 +5,7 @@ namespace Org\Mxchange\CoreFramework\Debug\Output;
 // Import framework stuff
 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
 use Org\Mxchange\CoreFramework\Debug\Debugger;
+use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
 use Org\Mxchange\CoreFramework\Output\Debug\BaseDebugOutput;
 use Org\Mxchange\CoreFramework\Registry\Registerable;
@@ -15,7 +16,7 @@ use Org\Mxchange\CoreFramework\Stream\Output\OutputStreamer;
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -33,14 +34,22 @@ use Org\Mxchange\CoreFramework\Stream\Output\OutputStreamer;
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class DebugConsoleOutput extends BaseDebugOutput implements Debugger, OutputStreamer, Registerable {
+       /**
+        * Cached configuration entry 'debug_*_output_timings'
+        */
+       private $isDebugOutputTimingsEnabled = FALSE;
+
        /**
         * Protected constructor
         *
         * @return      void
         */
-       protected function __construct () {
-               // Call parent constructor
+       private function __construct () {
+               // Call parent constructor first
                parent::__construct(__CLASS__);
+
+               // Cache configuration entry
+               $this->isDebugOutputTimingsEnabled = FrameworkBootstrap::getConfigurationInstance()->isEnabled('debug_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_output_timings');
        }
 
        /**
@@ -63,18 +72,18 @@ class DebugConsoleOutput extends BaseDebugOutput implements Debugger, OutputStre
         * @param       $stripTags      Whether HTML tags shall be stripped out
         * @return      void
         */
-       public final function outputStream ($output, $stripTags = false) {
+       public final function outputStream (string $output, bool $stripTags = false) {
                // Strip HTML tags out?
                if ($stripTags === true) {
                        // Prepare the output without HTML tags
                        $output = trim(html_entity_decode(strip_tags(stripslashes($output))));
-               } // END - if
+               }
 
                // Are debug times enabled?
-               if ($this->getConfigInstance()->getConfigEntry('debug_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_output_timings') == 'Y') {
+               if ($this->isDebugOutputTimingsEnabled) {
                        // Output it first
                        $output = $this->getPrintableExecutionTime() . $output;
-               } // END - if
+               }
 
                // And print it out...
                printf('%s%s', str_replace('-&gt;', '->', $output), PHP_EOL);
@@ -87,11 +96,11 @@ class DebugConsoleOutput extends BaseDebugOutput implements Debugger, OutputStre
         * @param       $stripTags      Whether HTML tags shall be stripped out
         * @return      void
         */
-       public final function output ($outStream = false, $stripTags = false) {
+       public final function output (string $outStream = '', bool $stripTags = false) {
                // Empty output will be silently ignored
-               if ($outStream !== false) {
+               if (!empty($outStream)) {
                        $this->outputStream($outStream, $stripTags);
-               } // END - if
+               }
        }
 
        /**
@@ -101,42 +110,9 @@ class DebugConsoleOutput extends BaseDebugOutput implements Debugger, OutputStre
         * @return      $data   The data (string mostly) to "stream"
         * @throws      UnsupportedOperationException   If this method is called
         */
-       public function streamData ($data) {
+       public function streamData (string $data) {
                self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
-               throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
-       }
-
-       /**
-        * 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__, __LINE__)->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);
+               throw new UnsupportedOperationException([$this, __FUNCTION__], FrameworkInterface::EXCEPTION_UNSPPORTED_OPERATION);
        }
 
 }