*
* @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, 2009 - 2011 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* ----------------------------------
+ * 1.3
+ * - Constructor is now empty and factory method 'createClassLoader' is created
+ * - renamed loadClasses to scanClassPath
+ * - Added initLoader(), $configInstance renamed to $configInstance
* 1.2
* - ClassLoader rewritten to PHP SPL's own RecursiveIteratorIterator class
* 1.1
/**
* Instance of this class
*/
- private static $selfInstance = null;
-
- /**
- * Configuration array
- */
- private $cfg = array();
+ private static $selfInstance = NULL;
/**
* Array with all classes
/**
* Suffix with extension for all class files
*/
- private $prefix = "class_";
+ private $prefix = 'class_';
/**
* Suffix with extension for all class files
*/
- private $suffix = ".php";
-
- /**
- * Length of the suffix. Will be overwritten later.
- */
- private $suffixLen = 0;
-
- /**
- * Length of the prefix. Will be overwritten later.
- */
- private $prefixLen = 0;
+ private $suffix = '.php';
/**
* A list for directory names (no leading/trailing slashes!) which not be scanned by the path scanner
/**
* Filename for the list cache
*/
- private $listCacheFQFN = "";
+ private $listCacheFQFN = '';
/**
* Cache for class content
*/
- private $classCacheFQFN = "";
+ private $classCacheFQFN = '';
/**
* Counter for loaded include files
private $total = 0;
/**
- * The *public* constructor
+ * The protected constructor. Please use the factory method below, or use
+ * getInstance() for singleton
*
- * @param $cfgInstance Configuration class instance
* @return void
*/
- public function __construct (FrameworkConfiguration $cfgInstance) {
+ protected function __construct () {
+ // Is Currently empty
+ }
+
+ /**
+ * The destructor makes it sure all caches got flushed
+ *
+ * @return void
+ */
+ public function __destruct () {
+ // Skip here if dev-mode
+ if (defined('DEVELOPER')) {
+ return;
+ } // END - if
+
+ // 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
+ }
+
+ /**
+ * Our renamed factory method
+ *
+ * @param $configInstance Configuration class instance
+ * @return void
+ */
+ public static final function createClassLoader (FrameworkConfiguration $configInstance) {
+ // Get a new instance
+ $loaderInstance = new ClassLoader();
+
+ // Init the instance
+ $loaderInstance->initLoader($configInstance);
+
+ // Return the prepared instance
+ return $loaderInstance;
+ }
+
+ /**
+ * Initializes our loader class
+ *
+ * @param $configInstance Configuration class instance
+ * @return void
+ */
+ protected function initLoader (FrameworkConfiguration $configInstance) {
// Set configuration instance
- $this->cfgInstance = $cfgInstance;
+ $this->configInstance = $configInstance;
// Construct the FQFN for the cache
if (!defined('DEVELOPER')) {
- $this->listCacheFQFN = $this->cfgInstance->readConfig('local_db_path') . "list-" . $this->cfgInstance->readConfig('app_name') . ".cache";
- $this->classCacheFQFN = $this->cfgInstance->readConfig('local_db_path') . "class-" . $this->cfgInstance->readConfig('app_name') . ".cache";
+ $this->listCacheFQFN = $this->configInstance->getConfigEntry('local_db_path') . 'list-' . $this->configInstance->getConfigEntry('app_name') . '.cache';
+ $this->classCacheFQFN = $this->configInstance->getConfigEntry('local_db_path') . 'class-' . $this->configInstance->getConfigEntry('app_name') . '.cache';
} // END - if
// Set suffix and prefix from configuration
- $this->suffix = $cfgInstance->readConfig('class_suffix');
- $this->prefix = $cfgInstance->readConfig('class_prefix');
-
- // Estimate length of prefix and suffix for substr() function (cache)
- $this->suffixLen = strlen($this->suffix);
- $this->prefixLen = strlen($this->prefix);
+ $this->suffix = $configInstance->getConfigEntry('class_suffix');
+ $this->prefix = $configInstance->getConfigEntry('class_prefix');
// Set own instance
self::$selfInstance = $this;
}
/**
- * The destructor makes it sure all caches got flushed
+ * Autoload-function
*
+ * @param $className Name of the class to load
* @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
+ public static function autoLoad ($className) {
+ // Try to include this class
+ self::getInstance()->includeClass($className);
}
/**
*
* @return $selfInstance An instance of this class
*/
- public final static function getInstance () {
+ public static final function getInstance () {
// Is the instance there?
if (is_null(self::$selfInstance)) {
// Get a new one
- self::$selfInstance = new ClassLoader(FrameworkConfiguration::getInstance());
+ self::$selfInstance = ClassLoader::createClassLoader(FrameworkConfiguration::getInstance());
} // END - if
// Return the instance
* Scans recursively a local path for class files which must have a prefix and a suffix as given by $this->suffix and $this->prefix
*
* @param $basePath The relative base path to 'base_path' constant for all classes
- * @param $ignoreList An optional list (array or string) of directory names which shall be ignored
+ * @param $ignoreList An optional list (array forced) of directory and file names which shall be ignored
* @return void
*/
- public function loadClasses ($basePath, $ignoreList = array() ) {
+ public function scanClassPath ($basePath, array $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);
+ } // END - if
// Directories which our class loader ignores by default while
- // deep-scanning the directory structure. See scanLocalPath() for
- // details.
- $ignoreList[] = ".";
- $ignoreList[] = "..";
- $ignoreList[] = ".htaccess";
- $ignoreList[] = ".svn";
+ // deep-scanning the directory structure.
+ $ignoreList[] = '.';
+ $ignoreList[] = '..';
+ $ignoreList[] = '.htaccess';
+ $ignoreList[] = '.svn';
// Keep it in class for later usage
$this->ignoreList = $ignoreList;
// If the basePath is false it is invalid
if ($basePath2 === false) {
/* @todo: Do not die here. */
- die("Cannot read {$basePath} !");
+ die('Cannot read ' . $basePath . ' !');
} else {
// Set base path
$basePath = $basePath2;
// Get filename from iterator
$fileName = $entry->getFileName();
+ // Get the FQFN and add it to our class list
+ $fqfn = $entry->getRealPath();
+
// Is this file wanted?
//* DEBUG: */ echo "FOUND:{$fileName}<br />\n";
- if ((!in_array($fileName, $this->ignoreList)) && (substr($fileName, 0, $this->prefixLen) == $this->prefix) && (substr($fileName, -$this->suffixLen, $this->suffixLen) == $this->suffix)) {
- // Get the FQFN and add it to our class list
- $fqfn = $entry->getRealPath();
+ if ((!in_array($fileName, $this->ignoreList)) && (filesize($fqfn) > 100) && (substr($fileName, 0, strlen($this->prefix)) == $this->prefix) && (substr($fileName, -strlen($this->suffix), strlen($this->suffix)) == $this->suffix)) {
//* DEBUG: */ echo "ADD: {$fileName}<br />\n";
+ // Add it to the list
$this->classes[$fileName] = $fqfn;
} // END - if
} // END - foreach
$oldPrefix = $this->prefix;
// Set new prefix (temporary!)
- $this->prefix = "config-";
- $this->prefixLen = strlen($this->prefix);
+ $this->prefix = 'config-';
// Set base directory
- $basePath = sprintf("%sinc/config/", $this->cfgInstance->readConfig('base_path'));
+ $basePath = $this->configInstance->getConfigEntry('base_path') . 'inc/config/';
// Load all classes from the config directory
- $this->loadClasses($basePath);
+ $this->scanClassPath($basePath);
// Include these extra configs now
$this->includeExtraConfigs();
// Set the prefix back
$this->prefix = $oldPrefix;
- $this->prefixLen = strlen($this->prefix);
-
}
/**
$fileName = $this->prefix . $className . $this->suffix;
// Now look it up in our index
- if (isset($this->classes[$fileName])) {
- // File is found so load it only once
+ if ((isset($this->classes[$fileName])) && (!in_array($this->classes[$fileName], $this->loadedClasses))) {
+ // File is found and not loaded so load it only once
//* DEBUG: */ echo "LOAD: ".$fileName." - Start<br />\n";
require($this->classes[$fileName]);
//* DEBUG: */ echo "LOAD: ".$fileName." - End<br />\n";
// Mark this class as loaded
$this->loadedClasses[] = $this->classes[$fileName];
+ // Remove it from classes list
+ unset($this->classes[$fileName]);
+
// Developer mode excludes caching (better debugging)
if (!defined('DEVELOPER')) {
// Reset cache
// 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) {
+ if (substr($fileName, 0, strlen($this->prefix)) == $this->prefix) {
// Then include it
require($fqfn);
*/
public function getPrintableIncludeList () {
// Prepare the list
- $includeList = "";
+ $includeList = '';
foreach ($this->loadedClasses as $classFile) {
$includeList .= basename($classFile)."<br />\n";
} // END - foreach
projects / core.git / blobdiff