inc/classes/main/compressor/class_NullCompressor.php

   1 <?php
   2 /**
   3  * Null compression and decompression class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.3.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.mxchange.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class NullCompressor extends BaseFrameworkSystem implements Compressor {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor!
  32                 parent::__construct(__CLASS__);
  33
  34                 // Debug message
  35                 if (((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
  36                         $this->__toString()
  37                 ));
  38
  39                 // Set description
  40                 $this->setObjectDescription("Null-Kompressor");
  41
  42                 // Create an unique ID
  43                 $this->createUniqueID();
  44         }
  45
  46         /**
  47          * Create a new compressor channel based a given compression handler
  48          *
  49          * @return      $cInstance      An instance of this class
  50          */
  51         public final static function createNullCompressor () {
  52                 // Get new instance
  53                 $cInstance = new NullCompressor();
  54
  55                 // Return the compressor instance
  56                 return $cInstance;
  57         }
  58
  59         /**
  60          * Null compression stream
  61          *
  62          * @param       $streamData             Mixed non-object stream data
  63          * @return      $streamData             The compressed stream data
  64          * @throws      InvalidObjectException  If the stream is an object
  65          */
  66         public function compressStream ($streamData) {
  67                 if (is_object($streamData)) {
  68                         // Throw an exception
  69                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
  70                 }
  71
  72                 // Return the compressed stream
  73                 return $streamData;
  74         }
  75
  76         /**
  77          * Null decompression stream
  78          *
  79          * @param       $streamData             Mixed non-object stream data
  80          * @return      $streamData             The decompressed stream data
  81          * @throws      InvalidObjectException  If the stream is an object
  82          */
  83         public function decompressStream ($streamData) {
  84                 if (is_object($streamData)) {
  85                         // Throw an exception
  86                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
  87                 }
  88
  89                 // Return the decompressed stream
  90                 return $streamData;
  91         }
  92
  93         /**
  94          * Getter for the file extension of this compressor
  95          *
  96          * @return      $string         Returns always "null"
  97          */
  98         public final function getCompressorExtension () {
  99                 if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Dateierweiterung angefordert.<br />\n",
 100                         $this->__toString()
 101                 ));
 102                 return "null";
 103         }
 104 }
 105
 106 // [EOF]
 107 ?>