X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Floader%2Fclass_ClassLoader.php;h=775abf6b947e81693c57af3a872c648185480c8c;hp=e15f52d4b65f6eb79fa2b60a6762404e7ff4b7e2;hb=2d739818a3217d1e685b2464a7faf08659b0c86f;hpb=361e6320e50a8bb1a3ccb675388b8042361669ae
diff --git a/inc/loader/class_ClassLoader.php b/inc/loader/class_ClassLoader.php
index e15f52d4..775abf6b 100644
--- a/inc/loader/class_ClassLoader.php
+++ b/inc/loader/class_ClassLoader.php
@@ -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(), $cfgInstance renamed to $configInstance
* 1.2
* - ClassLoader rewritten to PHP SPL's own RecursiveIteratorIterator class
* 1.1
@@ -61,16 +65,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
@@ -108,14 +102,41 @@ class ClassLoader {
private $total = 0;
/**
- * The *public* constructor
+ * The protected constructor. Please use the factory method below, or use
+ * getInstance() for singleton
*
- * @param $cfgInstance Configuration class instance
* @return void
*/
- public function __construct (FrameworkConfiguration $cfgInstance) {
+ protected function __construct () {
+ // Is Currently empty
+ }
+
+ /**
+ * Our renamed factory method
+ *
+ * @param $configInstance Configuration class instance
+ * @return void
+ */
+ 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->cfgInstance = $configInstance;
// Construct the FQFN for the cache
if (!defined('DEVELOPER')) {
@@ -124,12 +145,8 @@ class ClassLoader {
} // 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 +176,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
*
@@ -190,19 +234,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 +257,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 +298,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 +318,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'));
// 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 +377,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);