X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Floader%2Fclass_ClassLoader.php;h=7b551d8747c95ab9f3acea3b2040a8ea150c8155;hp=dbba1ff1139e9ad37d73e6decba8faa95a5c63e2;hb=3107989f93cfb5808ce9d75f1c7d2b7ee3d83d18;hpb=055cdee905b52916539aed45a2f9c51f63b4a4ff diff --git a/inc/loader/class_ClassLoader.php b/inc/loader/class_ClassLoader.php index dbba1ff1..7b551d87 100644 --- a/inc/loader/class_ClassLoader.php +++ b/inc/loader/class_ClassLoader.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software + * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -22,6 +22,10 @@ * along with this program. If not, see . * * ---------------------------------- + * 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 @@ -36,11 +40,6 @@ class ClassLoader { */ private static $selfInstance = null; - /** - * Configuration array - */ - private $cfg = array(); - /** * Array with all classes */ @@ -61,16 +60,6 @@ class ClassLoader { */ 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; - /** * A list for directory names (no leading/trailing slashes!) which not be scanned by the path scanner * @see scanLocalPath @@ -95,12 +84,12 @@ class ClassLoader { /** * Filename for the list cache */ - private $listCacheFQFN = ""; + private $listCacheFQFN = ''; /** * Cache for class content */ - private $classCacheFQFN = ""; + private $classCacheFQFN = ''; /** * Counter for loaded include files @@ -108,28 +97,51 @@ class ClassLoader { private $total = 0; /** - * The *public* constructor + * The protected constructor. Please use the factory method below, or use + * getInstance() for singleton + * + * @return void + */ + protected function __construct () { + // Is Currently empty + } + + /** + * Our renamed factory method * - * @param $cfgInstance Configuration class instance + * @param $configInstance Configuration class instance * @return void */ - public function __construct (FrameworkConfiguration $cfgInstance) { + public final static 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->readConfig('local_db_path') . "list-" . $this->configInstance->readConfig('app_name') . ".cache"; + $this->classCacheFQFN = $this->configInstance->readConfig('local_db_path') . "class-" . $this->configInstance->readConfig('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->readConfig('class_suffix'); + $this->prefix = $configInstance->readConfig('class_prefix'); // Set own instance self::$selfInstance = $this; @@ -159,6 +171,33 @@ class ClassLoader { } // END - if } + /** + * Autoload-function + * + * @param $className Name of the class to load + * @return void + */ + public static function autoLoad ($className) { + // Try to include this class + self::getInstance()->includeClass($className); + } + + /** + * Getter for an instance of this class + * + * @return $selfInstance An instance of this class + */ + public final static function getInstance () { + // Is the instance there? + if (is_null(self::$selfInstance)) { + // Get a new one + self::$selfInstance = ClassLoader::createClassLoader(FrameworkConfiguration::getInstance()); + } // END - if + + // Return the instance + return self::$selfInstance; + } + /** * The destructor makes it sure all caches got flushed * @@ -178,7 +217,7 @@ class ClassLoader { // Skip here if already cached if ($this->classesCached === false) { // Generate a full-cache of all classes - $cacheContent = ""; + $cacheContent = ''; foreach ($this->loadedClasses as $fqfn) { // Load the file $cacheContent .= file_get_contents($fqfn); @@ -190,19 +229,20 @@ class ClassLoader { } /** - * Getter for an instance of this class + * Fall-back method. Please replace loadClasses() with scanClassPath() ! * - * @return $selfInstance An instance of this class + * @param $basePath The relative base path to 'base_path' constant for all classes + * @param $ignoreList An optional list (array forced) of directory and file names which shall be ignored + * @return void + * @deprecated + * @todo Rewrite your apps to scanClassPath() */ - public final static function getInstance () { - // Is the instance there? - if (is_null(self::$selfInstance)) { - // Get a new one - self::$selfInstance = new ClassLoader(FrameworkConfiguration::getInstance()); - } // END - if + public function loadClasses ($basePath, array $ignoreList = array() ) { + // This outputs an ugly message because you need to change to scanClassPath + print __METHOD__." is deprecated. Use scanClassPath() to make this warning go away.
\n"; - // Return the instance - return self::$selfInstance; + // Call our new method + $this->scanClassPath($basePath, $ignoreList); } /** @@ -212,7 +252,7 @@ class ClassLoader { * @param $ignoreList An optional list (array forced) of directory and file names which shall be ignored * @return void */ - public function loadClasses ($basePath, array $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 @@ -253,7 +293,7 @@ class ClassLoader { // Is this file wanted? //* DEBUG: */ echo "FOUND:{$fileName}
\n"; - if ((!in_array($fileName, $this->ignoreList)) && (substr($fileName, 0, $this->prefixLen) == $this->prefix) && (substr($fileName, -$this->suffixLen, $this->suffixLen) == $this->suffix)) { + if ((!in_array($fileName, $this->ignoreList)) && (substr($fileName, 0, strlen($this->prefix)) == $this->prefix) && (substr($fileName, -strlen($this->suffix), strlen($this->suffix)) == $this->suffix)) { // Get the FQFN and add it to our class list $fqfn = $entry->getRealPath(); //* DEBUG: */ echo "ADD: {$fileName}
\n"; @@ -273,21 +313,18 @@ class ClassLoader { // Set new prefix (temporary!) $this->prefix = "config-"; - $this->prefixLen = strlen($this->prefix); // Set base directory - $basePath = sprintf("%sinc/config/", $this->cfgInstance->readConfig('base_path')); + $basePath = sprintf("%sinc/config/", $this->configInstance->readConfig('base_path')); // 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); - } /** @@ -303,8 +340,8 @@ class ClassLoader { $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
\n"; require($this->classes[$fileName]); //* DEBUG: */ echo "LOAD: ".$fileName." - End
\n"; @@ -315,6 +352,9 @@ class ClassLoader { // 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 @@ -332,7 +372,7 @@ class ClassLoader { // 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); @@ -358,7 +398,7 @@ class ClassLoader { */ public function getPrintableIncludeList () { // Prepare the list - $includeList = ""; + $includeList = ''; foreach ($this->loadedClasses as $classFile) { $includeList .= basename($classFile)."
\n"; } // END - foreach