3 * This class loads class include files with a specific prefix and suffix
5 * @author Roland Haeder <webmaster@mxchange.org>
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.ship-simu.org
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.
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.
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/>.
24 * ----------------------------------
26 * - loadClasses rewritten to fix some notices
29 * ----------------------------------
35 private $cfg = array();
38 * An ArrayObject for found classes
40 private $classes = null;
43 * Suffix with extension for all class files
45 private $prefix = "class_";
48 * Suffix with extension for all class files
50 private $suffix = ".php";
53 * Length of the suffix. Will be overwritten later.
58 * Length of the prefix. Will be overwritten later.
63 * A list for directory names (no leading/trailing slashes!) which not be scanned by the path scanner
66 private $ignoreList = array();
69 * An ArrayList object for include directories
71 private $dirList = null;
74 * Debug this class loader? (true = yes, false = no)
76 private $debug = false;
79 * Counter for scanned directories (debug output)
84 * Counter for loaded classes (debug output)
86 private $classCnt = 0;
89 * Instance of this class
91 private static $thisInstance = null;
94 * The *public* constructor
96 * @param $cfgInstance Configuration class instance
99 public function __construct (FrameworkConfiguration $cfgInstance) {
100 // Init the array list
101 $this->dirList = new ArrayObject();
103 // Set suffix and prefix from configuration
104 $this->suffix = $cfgInstance->readConfig('class_suffix');
105 $this->prefix = $cfgInstance->readConfig('class_prefix');
107 // Estimate length of prefix and suffix for substr() function (cache)
108 $this->sufLen = strlen($this->suffix);
109 $this->preLen = strlen($this->prefix);
111 // Set configuration instance
112 $this->cfgInstance = $cfgInstance;
114 // Initialize the classes list
115 $this->classes = new ArrayObject();
118 self::$thisInstance = $this;
122 * Getter for an instance of this class
124 * @return $thisInstance An instance of this class
126 public final static function getInstance () {
127 return self::$thisInstance;
131 * Scans recursively a local path for class files which must have a prefix and a suffix as given by $this->suffix and $this->prefix
133 * @param $basePath The relative base path to PATH constant for all classes
134 * @param $ignoreList An optional list (array or string) of directory names which shall be ignored
137 public function loadClasses ($basePath, $ignoreList = array() ) {
138 // Convert string to array
139 if (!is_array($ignoreList)) $ignoreList = array($ignoreList);
141 // Directories which our class loader ignores by default while
142 // deep-scanning the directory structure. See scanLocalPath() for
145 $ignoreList[] = "..";
146 $ignoreList[] = ".htaccess";
148 // Keep it in class for later usage
149 $this->ignoreList = $ignoreList;
151 // Set base directory which holds all our classes, we should use an
152 // absolute path here so is_dir(), is_file() and so on will always
153 // find the correct files and dirs.
154 $basePath2 = realpath($basePath);
156 // If the basePath is false it is invalid
157 if ($basePath2 === false) {
158 // TODO: Do not die here.
159 die("Cannot read {$basePath} !");
162 $basePath = $basePath2;
165 // Load all super classes (backward, why ever this name... :-? )
166 // We don't support sub directories here...
167 $this->scanLocalPath($basePath);
169 // While there are directories in our list scan them for classes
171 while ($cnt != $this->dirList->count()) {
172 for ($idx = $this->dirList->getIterator(); $idx->valid(); $idx->next()) {
174 $currPath = $idx->current();
176 // Remove the current entry or else this will lead into a infinite loop
177 $this->dirList->offsetSet($idx->key(), "");
179 // Scan the directory
180 $this->scanLocalPath($currPath);
183 // Check if we can leave
185 for ($idx = $this->dirList->getIterator(); $idx->valid(); $idx->next()) {
186 if ($idx->current() == "") $cnt++;
192 * The local path scanner. A found class will be loaded immediately
193 * @param $localPath The local path which shall be recursively scanned for include files
196 private function scanLocalPath ($localPath) {
197 // Empty path names will be silently ignored
198 if (empty($localPath)) return;
200 // TODO: No dies here, mayybe this should be rewritten to throw an exception?
201 $dirInstance = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($localPath);
202 while ($dirClass = $dirInstance->readDirectoryExcept($this->ignoreList)) {
203 // We need the relative dir name as an array index some lines below
204 $dirClass2 = $dirClass;
206 // A nice replacement for a simple dot ;)
207 $dirClass = sprintf("%s/%s", $localPath, $dirClass);
209 // Is a readable file with configured prefix and suffix? All other
210 // files will silently be ignored!
211 //* DEBUG: */ print "Prefix=".$this->prefix."(".substr($dirClass2, 0 , $this->preLen).")\n";
212 //* DEBUG: */ print "Suffix=".$this->suffix."(".substr($dirClass2, -$this->sufLen, $this->sufLen).")\n";
213 //* DEBUG: */ print "ENTRY={$dirClass}\n";
216 && (is_readable($dirClass))
217 && (substr($dirClass2, 0 , $this->preLen) == $this->prefix)
218 && (substr($dirClass2, -$this->sufLen, $this->sufLen) == $this->suffix)
220 // Class found so load it instantly
221 //* DEBUG: */ print "CLASS={$dirClass}\n";
222 $this->classes->append($dirClass);
224 } elseif (is_dir($dirClass) && !in_array($dirClass2, $this->ignoreList)) {
225 // Directory found and added to list
226 //* DEBUG: */ print "DIR={$dirClass}\n";
227 if ($dirClass2 == "interfaces") {
228 $this->scanLocalPath($dirClass);
230 $this->dirList->append($dirClass);
234 //* DEBUG: */ print "LOOP!\n";
237 // Close directory handler
238 $dirInstance->closeDirectory();
240 // Output counter in debug mode
241 if (defined('DEBUG_MODE')) print(sprintf("[%s:] <strong>%d</strong> Klassendateien in <strong>%d</strong> Verzeichnissen gefunden und geladen.<br />\n",
249 * Includes all found classes
252 public function includeAllClasses () {
253 if (is_object($this->classes)) {
255 for ($idx = $this->classes->getIterator(); $idx->valid(); $idx->next()) {
256 // Load current class
257 //* DEBUG: */ print "Class=".$idx->current()."\n";
258 require_once($idx->current());
261 // Re-initialize the classes list
262 $this->classes = new ArrayObject();
267 * Load extra config files
271 public function loadExtraConfigs () {
273 $oldPrefix = $this->prefix;
275 // Set new prefix (temporary!)
276 $this->prefix = "config-";
277 $this->preLen = strlen($this->prefix);
279 // Set base directory
280 $basePath = sprintf("%sinc/config/", PATH);
282 // Load all classes from the config directory
283 $this->loadClasses($basePath);
285 // Set the prefix back
286 $this->prefix = $oldPrefix;
287 $this->preLen = strlen($this->prefix);
291 // Initial load of core classes and the FrameworkDirectoryPointer class
292 require_once(sprintf("%sinc/classes/interfaces/class_FrameworkInterface%s", PATH, FrameworkConfiguration::getInstance()->readConfig('php_extension')));
293 require_once(sprintf("%sinc/classes/main/class_BaseFrameworkSystem%s", PATH, FrameworkConfiguration::getInstance()->readConfig('php_extension')));
294 require_once(sprintf("%sinc/classes/main/io/class_FrameworkDirectoryPointer%s", PATH, FrameworkConfiguration::getInstance()->readConfig('php_extension')));
296 // Initialize the class loader
297 $loader = new ClassLoader(FrameworkConfiguration::getInstance());