*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.ship-simu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* ----------------------------------
*/
class ClassLoader {
+ /**
+ * Instance of this class
+ */
+ private static $selfInstance = null;
+
/**
* Configuration array
*/
*/
private $classes = array();
+ /**
+ * List of loaded classes
+ */
+ private $loadedClasses = array();
+
/**
* Suffix with extension for all class files
*/
private $debug = false;
/**
- * Instance of this class
+ * Wether the file list is cached or not
*/
- private static $selfInstance = null;
+ private $listCached = false;
+
+ /**
+ * Wethe class content has been cached
+ */
+ private $classesCached = false;
+
+ /**
+ * Filename for the list cache
+ */
+ private $listCacheFQFN = "";
+
+ /**
+ * Cache for class content
+ */
+ private $classCacheFQFN = "";
+
+ /**
+ * Counter for loaded include files
+ */
+ private $total = 0;
/**
* The *public* constructor
* @return void
*/
public function __construct (FrameworkConfiguration $cfgInstance) {
+ // Set configuration instance
+ $this->cfgInstance = $cfgInstance;
+
+ // Construct the FQFN for the cache
+ if (!defined('DEVELOPER')) {
+ $this->listCacheFQFN = PATH . $this->cfgInstance->readConfig('local_db_path') . "list-" . $this->cfgInstance->readConfig('app_name') . ".cache";
+ $this->classCacheFQFN = PATH . $this->cfgInstance->readConfig('local_db_path') . "class-" . $this->cfgInstance->readConfig('app_name') . ".cache";
+ } // END - if
+
// Set suffix and prefix from configuration
$this->suffix = $cfgInstance->readConfig('class_suffix');
$this->prefix = $cfgInstance->readConfig('class_prefix');
$this->suffixLen = strlen($this->suffix);
$this->prefixLen = strlen($this->prefix);
- // Set configuration instance
- $this->cfgInstance = $cfgInstance;
-
// Set own instance
self::$selfInstance = $this;
+
+ // Skip here if no dev-mode
+ if (defined('DEVELOPER')) return;
+
+ // IS the cache there?
+ if (file_exists($this->listCacheFQFN)) {
+ // Get content
+ $cacheContent = file_get_contents($this->listCacheFQFN);
+
+ // And convert it
+ $this->classes = unserialize($cacheContent);
+
+ // List has been restored from cache!
+ $this->listCached = true;
+ } // END - if
+
+ // Does the class cache exist?
+ if (file_exists($this->classCacheFQFN)) {
+ // Then include it
+ require($this->classCacheFQFN);
+
+ // Mark the class cache as loaded
+ $this->classesCached = true;
+ } // END - if
+ }
+
+ /**
+ * The destructor makes it sure all caches got flushed
+ *
+ * @return void
+ */
+ public function __destruct () {
+ // Skip here if dev-mode
+ if (defined('DEVELOPER')) return;
+
+ // Skip here if already cached
+ if ($this->listCached === false) {
+ // Writes the cache file of our list away
+ $cacheContent = serialize($this->classes);
+ file_put_contents($this->listCacheFQFN, $cacheContent);
+ } // END - if
+
+ // Skip here if already cached
+ if ($this->classesCached === false) {
+ // Generate a full-cache of all classes
+ $cacheContent = "";
+ foreach ($this->loadedClasses as $fqfn) {
+ // Load the file
+ $cacheContent .= file_get_contents($fqfn);
+ } // END - foreach
+
+ // And write it away
+ file_put_contents($this->classCacheFQFN, $cacheContent);
+ } // END - if
}
/**
* @return void
*/
public function loadClasses ($basePath, $ignoreList = array() ) {
+ // Is a list has been restored from cache, don't read it again
+ if ($this->listCached === true) {
+ // Abort here
+ return;
+ }
+
// Convert string to array
if (!is_array($ignoreList)) $ignoreList = array($ignoreList);
// If the basePath is false it is invalid
if ($basePath2 === false) {
- // TODO: Do not die here.
+ /* @todo: Do not die here. */
die("Cannot read {$basePath} !");
} else {
// Set base path
$fqfn = $entry->getRealPath();
//* DEBUG: */ echo "ADD: {$fileName}<br />\n";
$this->classes[$fileName] = $fqfn;
- }
- }
+ } // END - if
+ } // END - foreach
}
/**
// Load all classes from the config directory
$this->loadClasses($basePath);
+ // Include these extra configs now
+ $this->includeExtraConfigs();
+
// Set the prefix back
$this->prefix = $oldPrefix;
$this->prefixLen = strlen($this->prefix);
+
}
/**
// Now look it up in our index
if (isset($this->classes[$fileName])) {
- if ($this->classes[$fileName] != "loaded") {
- // File is found so load it only once
- require($this->classes[$fileName]);
+ // File is found so load it only once
+ //* DEBUG: */ echo "LOAD: ".$fileName." - Start<br />\n";
+ require($this->classes[$fileName]);
+ //* DEBUG: */ echo "LOAD: ".$fileName." - End<br />\n";
+
+ // Count this include
+ $this->total++;
+
+ // Mark this class as loaded
+ $this->loadedClasses[] = $this->classes[$fileName];
- // Mark it as loaded
- $this->classes[$fileName] = "loaded";
+ // Developer mode excludes caching (better debugging)
+ if (!defined('DEVELOPER')) {
+ // Reset cache
+ $this->classesCached = false;
} // END - if
} // END - if
}
+
+ /**
+ * Includes all extra config files
+ *
+ * @return void
+ */
+ private function includeExtraConfigs () {
+ // Run through all class names (should not be much)
+ foreach ($this->classes as $fileName=>$fqfn) {
+ // Is this a config?
+ if (substr($fileName, 0, $this->prefixLen) == $this->prefix) {
+ // Then include it
+ require($fqfn);
+
+ // Remove it from the list
+ unset($this->classes[$fileName]);
+ } // END - if
+ } // END - foreach
+ }
+
+ /**
+ * Getter for total include counter
+ *
+ * @return $total Total loaded include files
+ */
+ public final function getTotal () {
+ return $this->total;
+ }
+
+ /**
+ * Getter for a printable list of included classes/interfaces/exceptions
+ *
+ * @param $includeList A printable include list
+ */
+ public function getPrintableIncludeList () {
+ // Prepare the list
+ $includeList = "";
+ foreach ($this->loadedClasses as $classFile) {
+ $includeList .= basename($classFile)."<br />\n";
+ } // END - foreach
+
+ // And return it
+ return $includeList;
+ }
}
// [EOF]
projects / shipsimu.git / blobdiff