]> git.mxchange.org Git - core.git/blobdiff - inc/classes/main/compressor/class_ZlibCompressor.php
Updated copyright:
[core.git] / inc / classes / main / compressor / class_ZlibCompressor.php
index 742d5ccada114b6a9bcd0254281c06edd5c58011..1816a40befb4c07f4926d96342fcdcdb7095ef55 100644 (file)
@@ -2,11 +2,11 @@
 /**
  * ZLIB 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, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @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
@@ -33,9 +33,9 @@ class ZlibCompressor extends BaseFrameworkSystem implements Compressor {
        }
 
        /**
-        * Create a new compressor channel based a given compression handler
+        * Create a new compressor channel based a given compression handler or NULL if the required PHP functions are not found.
         *
-        * @return      $compressorInstance             An instance of this class
+        * @return      $compressorInstance             An instance of this class or NULL if the required PHP functions are not found.
         */
        public static final function createZlibCompressor () {
                // Routines not found by default
@@ -55,7 +55,7 @@ class ZlibCompressor extends BaseFrameworkSystem implements Compressor {
         * ZLIB 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) {
@@ -72,7 +72,7 @@ class ZlibCompressor extends BaseFrameworkSystem implements Compressor {
         * ZLIB 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) {
@@ -88,7 +88,7 @@ class ZlibCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * Getter for the file extension of this compressor
         *
-        * @return      $string         Returns always 'gz'
+        * @return      $string         Returns always 'z'
         */
        public final function getCompressorExtension () {
                return 'z';