X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Floader%2Fclass_ClassLoader.php;h=4b46ffa801f5e09e629cba3453051b23dcbc0300;hp=775abf6b947e81693c57af3a872c648185480c8c;hb=886541aecfdee3aa7cc62c14f3e8aaca0b52fff4;hpb=2d739818a3217d1e685b2464a7faf08659b0c86f diff --git a/inc/loader/class_ClassLoader.php b/inc/loader/class_ClassLoader.php index 775abf6b..4b46ffa8 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 - 2009 Roland Haeder, this is free software + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -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(), $cfgInstance renamed to $configInstance + * - Added initLoader() * 1.2 * - ClassLoader rewritten to PHP SPL's own RecursiveIteratorIterator class * 1.1 @@ -38,12 +40,7 @@ class ClassLoader { /** * Instance of this class */ - private static $selfInstance = null; - - /** - * Configuration array - */ - private $cfg = array(); + private static $selfInstance = NULL; /** * Array with all classes @@ -58,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 @@ -77,7 +74,7 @@ class ClassLoader { private $debug = false; /** - * Wether the file list is cached or not + * Whether the file list is cached */ private $listCached = false; @@ -89,12 +86,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 @@ -103,21 +100,53 @@ class ClassLoader { /** * 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(); @@ -136,23 +165,25 @@ class ClassLoader { */ protected function initLoader (FrameworkConfiguration $configInstance) { // Set configuration instance - $this->cfgInstance = $configInstance; + $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 = $configInstance->readConfig('class_suffix'); - $this->prefix = $configInstance->readConfig('class_prefix'); + $this->suffix = $configInstance->getConfigEntry('class_suffix'); + $this->prefix = $configInstance->getConfigEntry('class_prefix'); // Set own instance 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)) { @@ -184,72 +215,25 @@ class ClassLoader { */ public static function autoLoad ($className) { // Try to include this class - self::getInstance()->includeClass($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 * @@ -262,27 +246,32 @@ class ClassLoader { if ($this->listCached === true) { // Abort here return; - } + } // END - if - // Directories which our class loader ignores by default while - // deep-scanning the directory structure. - $ignoreList[] = "."; - $ignoreList[] = ".."; - $ignoreList[] = ".htaccess"; - $ignoreList[] = ".svn"; + /* + * Directories which this class loader ignores by default while + * scanning the whole directory structure starting from given base + * path. + */ + $ignoreList[] = '.'; + $ignoreList[] = '..'; + $ignoreList[] = '.htaccess'; + $ignoreList[] = '.svn'; // 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. + /* + * 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. + */ $basePath2 = realpath($basePath); // If the basePath is false it is invalid if ($basePath2 === false) { /* @todo: Do not die here. */ - die("Cannot read {$basePath} !"); + die(__METHOD__ . ':Cannot read ' . $basePath . ' !'); } else { // Set base path $basePath = $basePath2; @@ -296,12 +285,14 @@ class ClassLoader { // 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}
\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(); + 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}
\n"; + // Add it to the list $this->classes[$fileName] = $fqfn; } // END - if } // END - foreach @@ -317,10 +308,10 @@ class ClassLoader { $oldPrefix = $this->prefix; // Set new prefix (temporary!) - $this->prefix = "config-"; + $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->scanClassPath($basePath); @@ -328,7 +319,7 @@ class ClassLoader { // Include these extra configs now $this->includeExtraConfigs(); - // Set the prefix back + // Set back the old prefix $this->prefix = $oldPrefix; } @@ -403,7 +394,7 @@ class ClassLoader { */ public function getPrintableIncludeList () { // Prepare the list - $includeList = ""; + $includeList = ''; foreach ($this->loadedClasses as $classFile) { $includeList .= basename($classFile)."
\n"; } // END - foreach