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