Continued:
[core.git] / framework / loader / class_ClassLoader.php
index 9f78f969e5290aac1190fbbd873c367b22b08c17..5035d3f83cce41ea94ec6edf90f4a824a67f15e6 100644 (file)
@@ -1,15 +1,16 @@
 <?php
 // Own namespace
-namespace CoreFramework\Loader;
+namespace Org\Mxchange\CoreFramework\Loader;
 
 // Import framework stuff
-use CoreFramework\Bootstrap\FrameworkBootstrap;
-use CoreFramework\Configuration\FrameworkConfiguration;
+use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
+use Org\Mxchange\CoreFramework\Configuration\FrameworkConfiguration;
 
 // Import SPL stuff
 use \InvalidArgumentException;
 use \RecursiveDirectoryIterator;
 use \RecursiveIteratorIterator;
+use \SplFileInfo;
 
 /**
  * This class loads class include files with a specific prefix and suffix
@@ -100,14 +101,14 @@ class ClassLoader {
        private $classesCached = false;
 
        /**
-        * Filename for the list cache
+        * SplFileInfo for the list cache
         */
-       private $listCacheFQFN = '';
+       private $listCacheFile = NULL;
 
        /**
-        * Cache for class content
+        * SplFileInfo for class content
         */
-       private $classCacheFQFN = '';
+       private $classCacheFile = NULL;
 
        /**
         * Counter for loaded include files
@@ -160,20 +161,32 @@ class ClassLoader {
                if ($this->listCached === false) {
                        // Writes the cache file of our list away
                        $cacheContent = json_encode($this->foundClasses);
-                       file_put_contents($this->listCacheFQFN, $cacheContent);
+
+                       // Open cache instance
+                       $fileObject = $this->listCacheFile->openFile('w');
+
+                       // And write whole list
+                       $fileObject->fwrite($cacheContent);
                } // END - if
 
                // Skip here if already cached
                if ($this->classesCached === false) {
                        // Generate a full-cache of all classes
                        $cacheContent = '';
-                       foreach (array_keys($this->loadedClasses) as $fqfn) {
+                       foreach (array_keys($this->loadedClasses) as $fileInstance) {
+                               // Open file
+                               $fileObject = $fileInstance->openFile('r');
+
                                // Load the file
-                               $cacheContent .= file_get_contents($fqfn);
+                               // @TODO Add some uglifying code (compress) here
+                               $cacheContent .= $fileObject->fread($fileInstance->getSize());
                        } // END - foreach
 
+                       // Open file
+                       $fileObject = $this->classCacheFile->openFile('w');
+
                        // And write it away
-                       file_put_contents($this->classCacheFQFN, $cacheContent);
+                       $fileObject->fwrite($cacheContent);
                } // END - if
        }
 
@@ -207,7 +220,7 @@ class ClassLoader {
                $loaderInstance = self::getSelfInstance();
 
                // Get config instance
-               $configInstance = FrameworkConfiguration::getSelfInstance();
+               $configInstance = FrameworkBootstrap::getConfigurationInstance();
 
                // Load all classes
                foreach (self::$frameworkPaths as $shortPath) {
@@ -256,7 +269,7 @@ class ClassLoader {
                $loaderInstance = self::getSelfInstance();
 
                // Get config instance
-               $configInstance = FrameworkConfiguration::getSelfInstance();
+               $configInstance = FrameworkBootstrap::getConfigurationInstance();
 
                // Load all classes for the application
                foreach (self::$frameworkPaths as $shortPath) {
@@ -297,7 +310,7 @@ class ClassLoader {
                //* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);
 
                // Get config instance
-               $configInstance = FrameworkConfiguration::getSelfInstance();
+               $configInstance = FrameworkBootstrap::getConfigurationInstance();
 
                // Load all classes for the application
                foreach (self::$testPaths as $shortPath) {
@@ -386,7 +399,7 @@ class ClassLoader {
                // Is the instance there?
                if (is_null(self::$selfInstance)) {
                        // Get a new one
-                       self::$selfInstance = ClassLoader::createClassLoader(FrameworkConfiguration::getSelfInstance());
+                       self::$selfInstance = ClassLoader::createClassLoader(FrameworkBootstrap::getConfigurationInstance());
                } // END - if
 
                // Return the instance
@@ -442,13 +455,10 @@ class ClassLoader {
                        $currentEntry = $iteratorInstance->current();
 
                        // Get filename from iterator which is the class' name (according naming-convention)
-                       $fileName = $currentEntry->getFileName();
-
-                       // Get the "FQFN" (path and file name)
-                       $fqfn = $currentEntry->getRealPath();
+                       $fileName = $currentEntry->getFilename();
 
                        // 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)) {
+                       if ((!$currentEntry->isFile()) || (in_array($fileName, $this->ignoreList)) || ($currentEntry->getSize() < 100)) {
                                // Advance to next entry
                                $iteratorInstance->next();
 
@@ -461,11 +471,11 @@ class ClassLoader {
                        //* 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->foundClasses[$fileName] = $fqfn;
+                               //* NOISY-DEBUG: */ printf('[%s:%d] ADD: %s,currentEntry=%s' . PHP_EOL, __METHOD__, __LINE__, $fileName, $currentEntry);
+                               $this->foundClasses[$fileName] = $currentEntry;
                        } else {
                                // Not added
-                               //* NOISY-DEBUG: */ printf('[%s:%d] NOT ADDED: %s,fqfn=%s' . PHP_EOL, __METHOD__, __LINE__, $fileName, $fqfn);
+                               //* NOISY-DEBUG: */ printf('[%s:%d] NOT ADDED: %s,currentEntry=%s' . PHP_EOL, __METHOD__, __LINE__, $fileName, $currentEntry);
                        }
 
                        // Advance to next entry
@@ -474,6 +484,31 @@ class ClassLoader {
                } // END - while
        }
 
+       /**
+        * Getter for total include counter
+        *
+        * @return      $total  Total loaded include files
+        */
+       public final function getTotal () {
+               return $this->total;
+       }
+
+       /**
+        * Getter for a printable list of included main/interfaces/exceptions
+        *
+        * @param       $includeList    A printable include list
+        */
+       public function getPrintableIncludeList () {
+               // Prepare the list
+               $includeList = '';
+               foreach ($this->loadedClasses as $classFile) {
+                       $includeList .= basename($classFile) . '<br />' . PHP_EOL;
+               } // END - foreach
+
+               // And return it
+               return $includeList;
+       }
+
        /**
         * Initializes our loader class
         *
@@ -486,8 +521,8 @@ class ClassLoader {
 
                // Construct the FQFN for the cache
                if (!defined('DEVELOPER')) {
-                       $this->listCacheFQFN  = $this->configInstance->getConfigEntry('local_database_path') . 'list-' . $this->configInstance->getConfigEntry('detected_app_name') . '.cache';
-                       $this->classCacheFQFN = $this->configInstance->getConfigEntry('local_database_path') . 'class-' . $this->configInstance->getConfigEntry('detected_app_name') . '.cache';
+                       $this->listCacheFile  = new SplFileInfo($this->configInstance->getConfigEntry('local_database_path') . 'list-' . $this->configInstance->getConfigEntry('detected_app_name') . '.cache');
+                       $this->classCacheFile = new SplFileInfo($this->configInstance->getConfigEntry('local_database_path') . 'class-' . $this->configInstance->getConfigEntry('detected_app_name') . '.cache');
                } // END - if
 
                // Set suffix and prefix from configuration
@@ -502,19 +537,19 @@ class ClassLoader {
                        return;
                } // END - if
 
-               // IS the cache there?
-               if (FrameworkBootstrap::isReadableFile($this->listCacheFQFN)) {
+               // Is the cache there?
+               if (FrameworkBootstrap::isReadableFile($this->listCacheFile)) {
                        // Load and convert it
-                       $this->foundClasses = json_decode(file_get_contents($this->listCacheFQFN));
+                       $this->foundClasses = json_decode(file_get_contents($this->listCacheFile->getPathname()));
 
                        // List has been restored from cache!
                        $this->listCached = true;
                } // END - if
 
                // Does the class cache exist?
-               if (FrameworkBootstrap::isReadableFile($this->listCacheFQFN)) {
+               if (FrameworkBootstrap::isReadableFile($this->classCacheFile)) {
                        // Then include it
-                       FrameworkBootstrap::loadInclude($this->classCacheFQFN);
+                       FrameworkBootstrap::loadInclude($this->classCacheFile);
 
                        // Mark the class cache as loaded
                        $this->classesCached = true;
@@ -538,20 +573,20 @@ class ClassLoader {
                $classNameParts = explode("\\", $className);
 
                // At least 3 parts should be there
-               if ((self::$strictNamingConvention === true) && (count($classNameParts) < 3)) {
+               if ((self::$strictNamingConvention === true) && (count($classNameParts) < 5)) {
                        // Namespace scheme is: Project\Package[\SubPackage...]
-                       throw new InvalidArgumentException(sprintf('Class name "%s" is not conform to naming-convention: Project\Package[\SubPackage...]\SomeFooBar', $className));
+                       throw new InvalidArgumentException(sprintf('Class name "%s" is not conform to naming-convention: Tld\Domain\Project\Package[\SubPackage...]\SomeFooBar', $className));
                } // END - if
 
                // Get last element
                $shortClassName = array_pop($classNameParts);
 
                // Create a name with prefix and suffix
-               $fileName = $this->prefix . $shortClassName . $this->suffix;
+               $fileName = sprintf('%s%s%s', $this->prefix, $shortClassName, $this->suffix);
 
                // Now look it up in our index
                //* NOISY-DEBUG: */ printf('[%s:%d] ISSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
-               if ((isset($this->foundClasses[$fileName])) && (!isset($this->loadedClasses[$this->foundClasses[$fileName]]))) {
+               if ((isset($this->foundClasses[$fileName])) && (!isset($this->loadedClasses[$this->foundClasses[$fileName]->getPathname()]))) {
                        // File is found and not loaded so load it only once
                        //* NOISY-DEBUG: */ printf('[%s:%d] LOAD: %s - START' . PHP_EOL, __METHOD__, __LINE__, $fileName);
                        FrameworkBootstrap::loadInclude($this->foundClasses[$fileName]);
@@ -561,7 +596,7 @@ class ClassLoader {
                        $this->total++;
 
                        // Mark this class as loaded for other purposes than loading it.
-                       $this->loadedClasses[$this->foundClasses[$fileName]] = true;
+                       $this->loadedClasses[$this->foundClasses[$fileName]->getPathname()] = true;
 
                        // Remove it from classes list so it won't be found twice.
                        //* NOISY-DEBUG: */ printf('[%s:%d] UNSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
@@ -579,29 +614,4 @@ class ClassLoader {
                }
        }
 
-       /**
-        * Getter for total include counter
-        *
-        * @return      $total  Total loaded include files
-        */
-       public final function getTotal () {
-               return $this->total;
-       }
-
-       /**
-        * Getter for a printable list of included main/interfaces/exceptions
-        *
-        * @param       $includeList    A printable include list
-        */
-       public function getPrintableIncludeList () {
-               // Prepare the list
-               $includeList = '';
-               foreach ($this->loadedClasses as $classFile) {
-                       $includeList .= basename($classFile) . '<br />' . PHP_EOL;
-               } // END - foreach
-
-               // And return it
-               return $includeList;
-       }
-
 }