]> git.mxchange.org Git - core.git/blob - inc/classes/main/compressor/class_NullCompressor.php
Rewrote core:
[core.git] / 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.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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
35         /**
36          * Create a new compressor channel based a given compression handler
37          *
38          * @return      $compressorInstance             An instance of this class
39          */
40         public static final function createNullCompressor () {
41                 // Get new instance
42                 $compressorInstance = new NullCompressor();
43
44                 // Return the compressor instance
45                 return $compressorInstance;
46         }
47
48         /**
49          * Null compression stream
50          *
51          * @param       $streamData             Mixed non-object stream data
52          * @return      $streamData             The compressed stream data
53          * @throws      InvalidObjectException  If the stream is an object
54          */
55         public function compressStream ($streamData) {
56                 if (is_object($streamData)) {
57                         // Throw an exception
58                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
59                 } // END - if
60
61                 // Return the compressed stream
62                 return $streamData;
63         }
64
65         /**
66          * Null decompression stream
67          *
68          * @param       $streamData             Mixed non-object stream data
69          * @return      $streamData             The decompressed stream data
70          * @throws      InvalidObjectException  If the stream is an object
71          */
72         public function decompressStream ($streamData) {
73                 if (is_object($streamData)) {
74                         // Throw an exception
75                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
76                 } // END - if
77
78                 // Return the decompressed stream
79                 return $streamData;
80         }
81
82         /**
83          * Getter for the file extension of this compressor
84          *
85          * @return      $string         Returns always "null"
86          */
87         public final function getCompressorExtension () {
88                 return 'null';
89         }
90 }
91
92 // [EOF]
93 ?>