More class descriptions translated, generic user class added

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

diff --git a/inc/classes/main/compressor/class_NullCompressor.php b/inc/classes/main/compressor/class_NullCompressor.php
index b4a1236379201f39ffe079c2ae66bff633a80dd9..157dc1a9ea41d0c270adcae6552bed674ca35a2e 100644 (file)
--- a/inc/classes/main/compressor/class_NullCompressor.php
+++ b/inc/classes/main/compressor/class_NullCompressor.php
@@ -3,9 +3,10 @@
  * Null 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 NullCompressor 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("Null-Kompressor");
+               $this->setObjectDescription("Null compressor");
 
                // Create an unique ID
                $this->createUniqueID();
@@ -58,8 +54,8 @@ class NullCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * Null 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) {
@@ -75,8 +71,8 @@ class NullCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * Null 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) {
@@ -92,12 +88,9 @@ class NullCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * Getter for the file extension of this compressor
         *
-        * @return      $string Returns always "bz2"
+        * @return      $string         Returns always "null"
         */
        public final function getCompressorExtension () {
-               if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Dateierweiterung angefordert.<br />\n",
-                       $this->__toString()
-               ));
                return "null";
        }
 }