X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Floader%2Fclass_ClassLoader.php;h=3c72647f852823f2c11eb5ebc7a5121cfc258cb7;hp=97a477e53abd917e4407e9f0b49a51f292f70da6;hb=c3021952494266e05bfa9046baf9bcd11bfe7d13;hpb=b9c18d6c24e3be4393bf41005aa4e428a0ea3218 diff --git a/inc/loader/class_ClassLoader.php b/inc/loader/class_ClassLoader.php index 97a477e5..3c72647f 100644 --- a/inc/loader/class_ClassLoader.php +++ b/inc/loader/class_ClassLoader.php @@ -2,11 +2,11 @@ /** * This class loads class include files with a specific prefix and suffix * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.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 @@ -22,10 +22,12 @@ * along with this program. If not, see . * * ---------------------------------- + * 1.4 + * - Some comments improved, other minor improvements * 1.3 * - Constructor is now empty and factory method 'createClassLoader' is created * - renamed loadClasses to scanClassPath - * - Added initLoader(), $configInstance renamed to $configInstance + * - Added initLoader() * 1.2 * - ClassLoader rewritten to PHP SPL's own RecursiveIteratorIterator class * 1.1 @@ -38,7 +40,7 @@ class ClassLoader { /** * Instance of this class */ - private static $selfInstance = null; + private static $selfInstance = NULL; /** * Array with all classes @@ -53,12 +55,12 @@ class ClassLoader { /** * Suffix with extension for all class files */ - private $prefix = "class_"; + private $prefix = 'class_'; /** * Suffix with extension for all class files */ - private $suffix = ".php"; + private $suffix = '.php'; /** * A list for directory names (no leading/trailing slashes!) which not be scanned by the path scanner @@ -67,19 +69,19 @@ class ClassLoader { private $ignoreList = array(); /** - * Debug this class loader? (true = yes, false = no) + * Debug this class loader? (TRUE = yes, FALSE = no) */ - private $debug = false; + private $debug = FALSE; /** - * Wether the file list is cached or not + * Whether the file list is cached */ - private $listCached = false; + private $listCached = FALSE; /** * Wethe class content has been cached */ - private $classesCached = false; + private $classesCached = FALSE; /** * Filename for the list cache @@ -96,23 +98,66 @@ class ClassLoader { */ private $total = 0; + /** + * Framework/application paths for classes, etc. + */ + private static $frameworkPaths = array( + 'exceptions', // Exceptions + 'interfaces', // Interfaces + 'main', // General main classes + 'middleware' // The middleware + ); + + /** * The protected constructor. Please use the factory method below, or use - * getInstance() for singleton + * getSelfInstance() for singleton * * @return void */ protected function __construct () { - // Is Currently empty + // Is currently empty } /** - * Our renamed factory method + * The destructor makes it sure all caches got flushed * - * @param $configInstance Configuration class instance * @return void */ - public final static function createClassLoader (FrameworkConfiguration $configInstance) { + 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 + } + + /** + * Creates an instance of this class loader for given configuration instance + * + * @param $configInstance Configuration class instance + * @return void + */ + public static final function createClassLoader (FrameworkConfiguration $configInstance) { // Get a new instance $loaderInstance = new ClassLoader(); @@ -123,6 +168,44 @@ class ClassLoader { return $loaderInstance; } + /** + * Scans for all framework classes, exceptions and interfaces. + * + * @return void + */ + public static function scanFrameworkClasses () { + // Cache loader instance + $loaderInstance = self::getSelfInstance(); + + // Load all classes + foreach (self::$frameworkPaths as $className) { + // Try to load the framework classes + $loaderInstance->scanClassPath('inc/classes/' . $className . '/'); + } // END - foreach + } + + /** + * Scans for application's classes, etc. + * + * @return void + */ + public static function scanApplicationClasses () { + // Get config instance + $cfg = FrameworkConfiguration::getSelfInstance(); + + // Load all classes for the application + foreach (self::$frameworkPaths as $class) { + // Create path name + $path = sprintf('%s/%s/%s', $cfg->getConfigEntry('application_path'), $cfg->getConfigEntry('app_name'), $class); + + // Is the path readable? + if (is_dir($path)) { + // Try to load the application classes + ClassLoader::getSelfInstance()->scanClassPath($path); + } // END - if + } // END - foreach + } + /** * Initializes our loader class * @@ -135,8 +218,8 @@ class ClassLoader { // Construct the FQFN for the cache if (!defined('DEVELOPER')) { - $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"; + $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 @@ -147,7 +230,9 @@ class ClassLoader { self::$selfInstance = $this; // Skip here if no dev-mode - if (defined('DEVELOPER')) return; + if (defined('DEVELOPER')) { + return; + } // END - if // IS the cache there? if (file_exists($this->listCacheFQFN)) { @@ -158,7 +243,7 @@ class ClassLoader { $this->classes = unserialize($cacheContent); // List has been restored from cache! - $this->listCached = true; + $this->listCached = TRUE; } // END - if // Does the class cache exist? @@ -167,7 +252,7 @@ class ClassLoader { require($this->classCacheFQFN); // Mark the class cache as loaded - $this->classesCached = true; + $this->classesCached = TRUE; } // END - if } @@ -179,72 +264,26 @@ class ClassLoader { */ public static function autoLoad ($className) { // Try to include this class - self::getInstance()->includeClass($className); + //* NOISY-DEBUG: */ printf('[%s:%d] className=%s' . PHP_EOL, __METHOD__, __LINE__, $className); + self::getSelfInstance()->includeClass($className); } /** - * Getter for an instance of this class + * Singleton getter for an instance of this class * - * @return $selfInstance An instance of this class + * @return $selfInstance A singleton instance of this class */ - public final static function getInstance () { + public static final function getSelfInstance () { // Is the instance there? if (is_null(self::$selfInstance)) { // Get a new one - self::$selfInstance = ClassLoader::createClassLoader(FrameworkConfiguration::getInstance()); + self::$selfInstance = ClassLoader::createClassLoader(FrameworkConfiguration::getSelfInstance()); } // END - if // Return the instance return self::$selfInstance; } - /** - * 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 - } - - /** - * Fall-back method. Please replace loadClasses() with scanClassPath() ! - * - * @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 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"; - - // Call our new method - $this->scanClassPath($basePath, $ignoreList); - } - /** * Scans recursively a local path for class files which must have a prefix and a suffix as given by $this->suffix and $this->prefix * @@ -254,52 +293,76 @@ class ClassLoader { */ public function scanClassPath ($basePath, array $ignoreList = array() ) { // Is a list has been restored from cache, don't read it again - if ($this->listCached === true) { + if ($this->listCached === TRUE) { // Abort here return; - } - - // Directories which our class loader ignores by default while - // deep-scanning the directory structure. - $ignoreList[] = '.'; - $ignoreList[] = '..'; - $ignoreList[] = '.htaccess'; - $ignoreList[] = '.svn'; + } // END - if // Keep it in class for later usage $this->ignoreList = $ignoreList; - // Set base directory which holds all our classes, we should use an - // absolute path here so is_dir(), is_file() and so on will always - // find the correct files and dirs. + /* + * Ignore .htaccess by default as it is for protection of directories + * on Apache servers. + */ + array_push($ignoreList, '.htaccess'); + + /* + * Set base directory which holds all our classes, an absolute path + * should be used here so is_dir(), is_file() and so on will always + * find the correct files and dirs. + */ $basePath2 = realpath($basePath); - // If the basePath is false it is invalid - if ($basePath2 === false) { - /* @todo: Do not die here. */ - die("Cannot read {$basePath} !"); + // If the basePath is FALSE it is invalid + if ($basePath2 === FALSE) { + /* @TODO: Do not exit here. */ + exit(__METHOD__ . ': Cannot read ' . $basePath . ' !' . PHP_EOL); } else { // Set base path $basePath = $basePath2; } // Get a new iterator - //* DEBUG: */ echo "Base path: {$basePath}
\n"; - $iterator = new RecursiveDirectoryIterator($basePath); - $recursive = new RecursiveIteratorIterator($iterator); - foreach ($recursive as $entry) { + //* NOISY-DEBUG: */ printf('[%s:%d] basePath=%s' . PHP_EOL, __METHOD__, __LINE__, $basePath); + $iteratorInstance = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($basePath), RecursiveIteratorIterator::CHILD_FIRST); + + // Load all entries + while ($iteratorInstance->valid()) { + // Get current entry + $currentEntry = $iteratorInstance->current(); + // Get filename from iterator - $fileName = $entry->getFileName(); + $fileName = $currentEntry->getFileName(); + + // Get the "FQFN" (path and file name) + $fqfn = $currentEntry->getRealPath(); + + // Current entry must be a file, not smaller than 100 bytes and not on ignore list + if ((!$currentEntry->isFile()) || (in_array($fileName, $this->ignoreList)) || (filesize($fqfn) < 100)) { + // Advance to next entry + $iteratorInstance->next(); + + // Skip non-file entries + //* NOISY-DEBUG: */ printf('[%s:%d] SKIP: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName); + continue; + } // END - if // Is this file wanted? - //* DEBUG: */ echo "FOUND:{$fileName}
\n"; - 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"; + //* NOISY-DEBUG: */ printf('[%s:%d] FOUND: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName); + if ((substr($fileName, 0, strlen($this->prefix)) == $this->prefix) && (substr($fileName, -strlen($this->suffix), strlen($this->suffix)) == $this->suffix)) { + // Add it to the list + //* NOISY-DEBUG: */ printf('[%s:%d] ADD: %s,fqfn=%s' . PHP_EOL, __METHOD__, __LINE__, $fileName, $fqfn); $this->classes[$fileName] = $fqfn; - } // END - if - } // END - foreach + } else { + // Not added + //* NOISY-DEBUG: */ printf('[%s:%d] NOT ADDED: %s,fqfn=%s' . PHP_EOL, __METHOD__, __LINE__, $fileName, $fqfn); + } + + // Advance to next entry + //* NOISY-DEBUG: */ printf('[%s:%d] NEXT: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName); + $iteratorInstance->next(); + } // END - while } /** @@ -323,7 +386,7 @@ class ClassLoader { // Include these extra configs now $this->includeExtraConfigs(); - // Set the prefix back + // Set back the old prefix $this->prefix = $oldPrefix; } @@ -332,7 +395,7 @@ class ClassLoader { * missing classes or interfaces. So if you use class_exists() this method * does not interrupt your program. * - * @param $className The class we shall load + * @param $className The class that shall be loaded * @return void */ public function includeClass ($className) { @@ -340,27 +403,33 @@ class ClassLoader { $fileName = $this->prefix . $className . $this->suffix; // Now look it up in our index + //* NOISY-DEBUG: */ printf('[%s:%d] ISSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName); 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"; + //* NOISY-DEBUG: */ printf('[%s:%d] LOAD: %s - START' . PHP_EOL, __METHOD__, __LINE__, $fileName); require($this->classes[$fileName]); - //* DEBUG: */ echo "LOAD: ".$fileName." - End
\n"; + //* NOISY-DEBUG: */ printf('[%s:%d] LOAD: %s - END' . PHP_EOL, __METHOD__, __LINE__, $fileName); - // Count this include + // Count this loaded class/interface/exception $this->total++; - // Mark this class as loaded - $this->loadedClasses[] = $this->classes[$fileName]; + // Mark this class as loaded for other purposes than loading it. + array_push($this->loadedClasses, $this->classes[$fileName]); - // Remove it from classes list + // Remove it from classes list so it won't be found twice. + //* NOISY-DEBUG: */ printf('[%s:%d] UNSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName); unset($this->classes[$fileName]); // Developer mode excludes caching (better debugging) if (!defined('DEVELOPER')) { // Reset cache - $this->classesCached = false; + //* NOISY-DEBUG: */ printf('[%s:%d] classesCached=FALSE' . PHP_EOL, __METHOD__, __LINE__); + $this->classesCached = FALSE; } // END - if - } // END - if + } else { + // Not found + //* NOISY-DEBUG: */ printf('[%s:%d] 404: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName); + } } /** @@ -377,6 +446,7 @@ class ClassLoader { require($fqfn); // Remove it from the list + //* NOISY-DEBUG: */ printf('[%s:%d] UNSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName); unset($this->classes[$fileName]); } // END - if } // END - foreach @@ -400,7 +470,7 @@ class ClassLoader { // Prepare the list $includeList = ''; foreach ($this->loadedClasses as $classFile) { - $includeList .= basename($classFile)."
\n"; + $includeList .= basename($classFile) . '
' . PHP_EOL; } // END - foreach // And return it