inc/main/classes/compressor/class_NullCompressor.php

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