]> git.mxchange.org Git - core.git/blobdiff - inc/classes/main/compressor/class_NullCompressor.php
Opps, forgot this.
[core.git] / inc / classes / main / compressor / class_NullCompressor.php
index c50a51a8cf50d160816118fdbc370858320d0830..52fbd03d7e9628d984b8b0142dfb48c8b192e7cd 100644 (file)
@@ -2,11 +2,11 @@
 /**
  * Null compression and decompression class
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.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
@@ -35,28 +35,28 @@ class NullCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * Create a new compressor channel based a given compression handler
         *
-        * @return      $cInstance      An instance of this class
+        * @return      $compressorInstance             An instance of this class
         */
-       public final static function createNullCompressor () {
+       public static final function createNullCompressor () {
                // Get new instance
-               $cInstance = new NullCompressor();
+               $compressorInstance = new NullCompressor();
 
                // Return the compressor instance
-               return $cInstance;
+               return $compressorInstance;
        }
 
        /**
         * Null compression stream
         *
         * @param       $streamData             Mixed non-object stream data
-        * @return      $streamData             The compressed stream data      
+        * @return      $streamData             The compressed stream data
         * @throws      InvalidObjectException  If the stream is an object
         */
        public function compressStream ($streamData) {
                if (is_object($streamData)) {
                        // Throw an exception
                        throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
-               }
+               } // END - if
 
                // Return the compressed stream
                return $streamData;
@@ -66,14 +66,14 @@ class NullCompressor extends BaseFrameworkSystem implements Compressor {
         * Null decompression stream
         *
         * @param       $streamData             Mixed non-object stream data
-        * @return      $streamData             The decompressed stream data    
+        * @return      $streamData             The decompressed stream data
         * @throws      InvalidObjectException  If the stream is an object
         */
        public function decompressStream ($streamData) {
                if (is_object($streamData)) {
                        // Throw an exception
                        throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
-               }
+               } // END - if
 
                // Return the decompressed stream
                return $streamData;
@@ -82,10 +82,10 @@ class NullCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * Getter for the file extension of this compressor
         *
-        * @return      $string         Returns always "null"
+        * @return      $string         Returns always 'null'
         */
        public final function getCompressorExtension () {
-               return "null";
+               return 'null';
        }
 }