Registration stub added, naming convention applied, support for PHP code (keep it...

[shipsimu.git] / inc / classes / main / compressor / class_GzipCompressor.php

diff --git a/inc/classes/main/compressor/class_GzipCompressor.php b/inc/classes/main/compressor/class_GzipCompressor.php
index f00b2d03252ceec0a07d9b7629965a69c185bb87..4e95f801f95ef6214b85777c0396e438d6a6e919 100644 (file)
--- a/inc/classes/main/compressor/class_GzipCompressor.php
+++ b/inc/classes/main/compressor/class_GzipCompressor.php
@@ -3,9 +3,10 @@
  * GZIP compression and decompression class
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
- * @version            0.0
+ * @version            0.0.0
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.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
@@ -18,25 +19,20 @@
  * 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/>.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class GzipCompressor extends BaseFrameworkSystem implements Compressor {
        /**
-        * Private constructor
+        * Protected constructor
         *
         * @return      void
         */
-       private function __construct () {
+       protected function __construct () {
                // Call parent constructor!
-               parent::constructor(__CLASS__);
-
-               // Debug message
-               if (((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
-                       $this->__toString()
-               ));
+               parent::__construct(__CLASS__);
 
                // Set description
-               $this->setPartDescr("GZIP-Kompressor");
+               $this->setObjectDescription("GZIP-Kompressor");
 
                // Create an unique ID
                $this->createUniqueID();
@@ -52,19 +48,9 @@ class GzipCompressor extends BaseFrameworkSystem implements Compressor {
                if ((function_exists('gzcompress')) && (function_exists('gzuncompress'))) {
                        // Compressor can maybe be used
                        $cInstance = new GzipCompressor();
-
-                       // Debug message
-                       if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $cInstance->getDebugInstance()->output(sprintf("[%s:] GZIP-Kompression wird verwendet.<br />\n",
-                               $cInstance->__toString()
-                       ));
                } else {
                        // Routines not found!
                        $cInstance = null;
-
-                       // Debug message
-                       if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $cInstance->getDebugInstance()->output(sprintf("[%s:] GZIP-Kompressionsroutinen <strong>nicht</strong> gefunden.<br />\n",
-                               $cInstance->__toString()
-                       ));
                }
 
                // Return the compressor instance
@@ -74,8 +60,8 @@ class GzipCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * GZIP compression stream
         *
-        * @param               $streamData                     Mixed non-object stream data
-        * @return      $streamData                     The compressed stream data      
+        * @param       $streamData             Mixed non-object stream data
+        * @return      $streamData             The compressed stream data      
         * @throws      InvalidObjectException  If the stream is an object
         */
        public function compressStream ($streamData) {
@@ -91,8 +77,8 @@ class GzipCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * GZIP decompression stream
         *
-        * @param               $streamData                     Mixed non-object stream data
-        * @return      $streamData                     The decompressed stream data    
+        * @param       $streamData             Mixed non-object stream data
+        * @return      $streamData             The decompressed stream data    
         * @throws      InvalidObjectException  If the stream is an object
         */
        public function decompressStream ($streamData) {
@@ -111,9 +97,6 @@ class GzipCompressor extends BaseFrameworkSystem implements Compressor {
         * @return      $string Returns always "gz"
         */
        public final function getCompressorExtension () {
-               if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Dateierweiterung angefordert.<br />\n",
-                       $this->__toString()
-               ));
                return "gz";
        }
 }