]> git.mxchange.org Git - core.git/blob - inc/classes/middleware/compressor/class_CompressorChannel.php
Copyright year updated, converted double->single quotes
[core.git] / inc / classes / middleware / compressor / class_CompressorChannel.php
1 <?php
2 /**
3  * Middleware class for selecting the right compressor channel
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 CompressorChannel extends BaseMiddleware implements Registerable {
25         /**
26          * Real compressor instance
27          */
28         private $compressor = NULL;
29
30         /**
31          * Protected constructor
32          *
33          * @return      void
34          */
35         protected function __construct () {
36                 // Call parent constructor!
37                 parent::__construct(__CLASS__);
38         }
39
40         /**
41          * Create a new compressor channel.
42          *
43          * @return      $compressorInstance             A prepared instance of this class
44          */
45         public static final function createCompressorChannel () {
46                 // Get new instance
47                 $compressorInstance = new CompressorChannel();
48
49                 // Is the compressor handler set?
50                 if (
51                            (is_null($compressorInstance->getCompressor()))
52                         || (!$compressorInstance->getCompressor() instanceof Compressor)
53                 ) {
54                         // Init base directory
55                         $baseDir =
56                                 $compressorInstance->getConfigInstance()->getConfigEntry('base_path') .
57                                 $compressorInstance->getConfigInstance()->getConfigEntry('compressor_base_path');
58
59                         // Get a directory pointer
60                         $dirPointer = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($baseDir);
61
62                         // Read all directories but no sub directories
63                         while ($directoryEntry = $dirPointer->readDirectoryExcept(array('..', '.', '.htaccess', '.svn', 'class_NullCompressor.php'))) {
64                                 // Is this a class file?
65                                 if ((substr($directoryEntry, 0, 6) == 'class_') && (substr($directoryEntry, -4, 4) == '.php')) {
66                                         /* Get the compressor's name. That's why you must name
67                                          * your files like your classes and also that's why you
68                                          * must keep on class in one file.
69                                          */
70                                         $className = substr($directoryEntry, 6, -4);
71
72                                         // Get an instance from our object factory
73                                         $tempInstance = ObjectFactory::createObjectByName($className);
74
75                                         // Is it null?
76                                         if (is_null($tempInstance)) {
77                                                 // Then skip to the next one
78                                                 continue;
79                                         } // END - if
80
81                                         // Set the compressor
82                                         $compressorInstance->setCompressor($tempInstance);
83
84                                         // No more searches required because we have found a valid compressor stream
85                                         break;
86                                 } // END - if
87                         } // END - while
88
89                         // Close the directory
90                         $dirPointer->closeDirectory();
91                 } // END - if
92
93                 // Check again if there is a compressor
94                 if (
95                            (is_null($compressorInstance->getCompressor()))
96                         || (!is_object($compressorInstance->getCompressor()))
97                         || (!$compressorInstance instanceof Compressor)
98                 ) {
99                         // Set the null compressor handler. This should not be configureable!
100                         // @TODO Is there a configurable fall-back compressor needed, or is NullCompressor okay?
101                         $compressorInstance->setCompressor(ObjectFactory::createObjectByName('NullCompressor'));
102                 } // END - if
103
104                 // Return the compressor instance
105                 return $compressorInstance;
106         }
107
108         /**
109          * Getter for compressor instance
110          *
111          * @return      $compressor     The compressor instance
112          */
113         public final function getCompressor () {
114                 return $this->compressor;
115         }
116
117         /**
118          * Setter for compressor
119          *
120          * @param               $compressorInstance     The compressor instance we shall use
121          * @return      void
122          */
123         public final function setCompressor (Compressor $compressorInstance = NULL) {
124                 $this->compressor = $compressorInstance;
125         }
126
127         /**
128          * Getter for the file extension of the current compressor
129          */
130         public final function getCompressorExtension () {
131                 // Get compressor extension from current compressor
132                 return $this->getCompressor()->getCompressorExtension();
133         }
134 }
135
136 // [EOF]
137 ?>