X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Floader%2Fclass_ClassLoader.php;h=79768fff9b3f196bc9df9b5ac8136a2611e3e25e;hp=e15f52d4b65f6eb79fa2b60a6762404e7ff4b7e2;hb=fffe0ef5a4c39831127b1afed64d8ea0e077b09e;hpb=361e6320e50a8bb1a3ccb675388b8042361669ae diff --git a/inc/loader/class_ClassLoader.php b/inc/loader/class_ClassLoader.php index e15f52d4..79768fff 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, 2010 Core Developer Team * @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 */ @@ -54,22 +53,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"; - - /** - * 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 @@ -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->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; @@ -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); @@ -189,22 +228,6 @@ class ClassLoader { } // END - if } - /** - * 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 = new ClassLoader(FrameworkConfiguration::getInstance()); - } // END - if - - // Return the instance - return self::$selfInstance; - } - /** * Scans recursively a local path for class files which must have a prefix and a suffix as given by $this->suffix and $this->prefix * @@ -212,7 +235,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 @@ -221,10 +244,10 @@ class ClassLoader { // Directories which our class loader ignores by default while // deep-scanning the directory structure. - $ignoreList[] = "."; - $ignoreList[] = ".."; - $ignoreList[] = ".htaccess"; - $ignoreList[] = ".svn"; + $ignoreList[] = '.'; + $ignoreList[] = '..'; + $ignoreList[] = '.htaccess'; + $ignoreList[] = '.svn'; // Keep it in class for later usage $this->ignoreList = $ignoreList; @@ -237,7 +260,7 @@ class ClassLoader { // 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; @@ -253,7 +276,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"; @@ -272,22 +295,19 @@ class ClassLoader { $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); - } /** @@ -335,7 +355,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); @@ -361,7 +381,7 @@ class ClassLoader { */ public function getPrintableIncludeList () { // Prepare the list - $includeList = ""; + $includeList = ''; foreach ($this->loadedClasses as $classFile) { $includeList .= basename($classFile)."
\n"; } // END - foreach