framework/main/classes/compressor/class_NullCompressor.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Compressor\Null;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Compressor\Compressor;
   7 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
   8
   9 /**
  10  * Null 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 - 2019 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 NullCompressor extends BaseFrameworkSystem implements Compressor {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor!
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Create a new compressor channel based a given compression handler
  44          *
  45          * @return      $compressorInstance             An instance of this class
  46          */
  47         public static final function createNullCompressor () {
  48                 // Get new instance
  49                 $compressorInstance = new NullCompressor();
  50
  51                 // Return the compressor instance
  52                 return $compressorInstance;
  53         }
  54
  55         /**
  56          * Null compression stream
  57          *
  58          * @param       $streamData             Mixed non-object stream data
  59          * @return      $streamData             The compressed stream data
  60          * @throws      InvalidObjectException  If the stream is an object
  61          */
  62         public function compressStream ($streamData) {
  63                 if (is_object($streamData)) {
  64                         // Throw an exception
  65                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
  66                 } // END - if
  67
  68                 // Return the compressed stream
  69                 return $streamData;
  70         }
  71
  72         /**
  73          * Null decompression stream
  74          *
  75          * @param       $streamData             Mixed non-object stream data
  76          * @return      $streamData             The decompressed stream data
  77          * @throws      InvalidObjectException  If the stream is an object
  78          */
  79         public function decompressStream ($streamData) {
  80                 if (is_object($streamData)) {
  81                         // Throw an exception
  82                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
  83                 } // END - if
  84
  85                 // Return the decompressed stream
  86                 return $streamData;
  87         }
  88
  89         /**
  90          * Getter for the file extension of this compressor
  91          *
  92          * @return      $string         Returns always 'null'
  93          */
  94         public final function getCompressorExtension () {
  95                 return 'null';
  96         }
  97
  98 }