inc/main/classes/compressor/class_ZlibCompressor.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Compressor;
   4
   5 // Import framework stuff
   6 use CoreFramework\Object\BaseFrameworkSystem;
   7
   8 /**
   9  * ZLIB compression and decompression class
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 class ZlibCompressor extends BaseFrameworkSystem implements Compressor {
  31         /**
  32          * Protected constructor
  33          *
  34          * @return      void
  35          */
  36         protected function __construct () {
  37                 // Call parent constructor!
  38                 parent::__construct(__CLASS__);
  39         }
  40
  41         /**
  42          * Create a new compressor channel based a given compression handler or NULL if the required PHP functions are not found.
  43          *
  44          * @return      $compressorInstance             An instance of this class or NULL if the required PHP functions are not found.
  45          */
  46         public static final function createZlibCompressor () {
  47                 // Routines not found by default
  48                 $compressorInstance = NULL;
  49
  50                 // Get new instance
  51                 if ((function_exists('gzcompress')) && (function_exists('gzuncompress'))) {
  52                         // Compressor can maybe be used
  53                         $compressorInstance = new ZlibCompressor();
  54                 } // END - if
  55
  56                 // Return the compressor instance
  57                 return $compressorInstance;
  58         }
  59
  60         /**
  61          * ZLIB compression stream
  62          *
  63          * @param       $streamData             Mixed non-object stream data
  64          * @return      $streamData             The compressed stream data
  65          * @throws      InvalidObjectException  If the stream is an object
  66          */
  67         public function compressStream ($streamData) {
  68                 if (is_object($streamData)) {
  69                         // Throw an exception
  70                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
  71                 } // END - if
  72
  73                 // Return the compressed stream
  74                 return gzcompress($streamData, 1);
  75         }
  76
  77         /**
  78          * ZLIB decompression stream
  79          *
  80          * @param       $streamData             Mixed non-object stream data
  81          * @return      $streamData             The decompressed stream data
  82          * @throws      InvalidObjectException  If the stream is an object
  83          */
  84         public function decompressStream ($streamData) {
  85                 if (is_object($streamData)) {
  86                         // Throw an exception
  87                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
  88                 } // END - if
  89
  90                 // Return the decompressed stream
  91                 return gzuncompress($streamData);
  92         }
  93
  94         /**
  95          * Getter for the file extension of this compressor
  96          *
  97          * @return      $string         Returns always 'z'
  98          */
  99         public final function getCompressorExtension () {
 100                 return 'z';
 101         }
 102
 103 }