framework/main/classes/compressor/class_ZlibCompressor.php

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