X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Floader%2Fclass_ClassLoader.php;h=4b46ffa801f5e09e629cba3453051b23dcbc0300;hp=3645bf171cc850569d641b0eb04e938e68c4c57f;hb=886541aecfdee3aa7cc62c14f3e8aaca0b52fff4;hpb=3e1fbf30a631cf1cd64562b69228452c49e0033f diff --git a/inc/loader/class_ClassLoader.php b/inc/loader/class_ClassLoader.php index 3645bf17..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, 2008 Roland Haeder, 2009 - 2011 Core Developer Team + * @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(), $configInstance renamed to $configInstance + * - Added initLoader() * 1.2 * - ClassLoader rewritten to PHP SPL's own RecursiveIteratorIterator class * 1.1 @@ -72,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; @@ -98,18 +100,50 @@ 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 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) { @@ -147,7 +181,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)) { @@ -179,57 +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 static final 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; - } // 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 - } - /** * Scans recursively a local path for class files which must have a prefix and a suffix as given by $this->suffix and $this->prefix * @@ -244,8 +248,11 @@ class ClassLoader { return; } // END - if - // Directories which our class loader ignores by default while - // deep-scanning the directory structure. + /* + * Directories which this class loader ignores by default while + * scanning the whole directory structure starting from given base + * path. + */ $ignoreList[] = '.'; $ignoreList[] = '..'; $ignoreList[] = '.htaccess'; @@ -254,15 +261,17 @@ class ClassLoader { // 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; @@ -310,7 +319,7 @@ class ClassLoader { // Include these extra configs now $this->includeExtraConfigs(); - // Set the prefix back + // Set back the old prefix $this->prefix = $oldPrefix; }