Continued with loader and file i/o stuff:
[core.git] / inc / loader / class_ClassLoader.php
index 4b46ffa801f5e09e629cba3453051b23dcbc0300..af4d8d336c3ff9e89c61582814428ea57ec86505 100644 (file)
@@ -2,11 +2,11 @@
 /**
  * This class loads class include files with a specific prefix and suffix
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -69,19 +69,19 @@ class ClassLoader {
        private $ignoreList = array();
 
        /**
-        * Debug this class loader? (true = yes, false = no)
+        * Debug this class loader? (TRUE = yes, FALSE = no)
         */
-       private $debug = false;
+       private $debug = FALSE;
 
        /**
         * Whether the file list is cached
         */
-       private $listCached = false;
+       private $listCached = FALSE;
 
        /**
         * Wethe class content has been cached
         */
-       private $classesCached = false;
+       private $classesCached = FALSE;
 
        /**
         * Filename for the list cache
@@ -98,6 +98,17 @@ class ClassLoader {
         */
        private $total = 0;
 
+       /**
+        * Framework/application paths for classes, etc.
+        */
+       private static $frameworkPaths = array(
+               'exceptions', // Exceptions
+               'interfaces', // Interfaces
+               'main',       // General main classes
+               'middleware'  // The middleware
+       );
+
+
        /**
         * The protected constructor. Please use the factory method below, or use
         * getSelfInstance() for singleton
@@ -120,14 +131,14 @@ class ClassLoader {
                } // END - if
 
                // Skip here if already cached
-               if ($this->listCached === false) {
+               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) {
+               if ($this->classesCached === FALSE) {
                        // Generate a full-cache of all classes
                        $cacheContent = '';
                        foreach ($this->loadedClasses as $fqfn) {
@@ -157,6 +168,44 @@ class ClassLoader {
                return $loaderInstance;
        }
 
+       /**
+        * Scans for all framework classes, exceptions and interfaces.
+        *
+        * @return      void
+        */
+       public static function scanFrameworkClasses () {
+               // Cache loader instance
+               $loaderInstance = self::getSelfInstance();
+
+               // Load all classes
+               foreach (self::$frameworkPaths as $className) {
+                       // Try to load the framework classes
+                       $loaderInstance->scanClassPath('inc/classes/' . $className . '/');
+               } // END - foreach
+       }
+
+       /**
+        * Scans for application's classes, etc.
+        *
+        * @return      void
+        */
+       public static function scanApplicationClasses () {
+               // Get config instance
+               $cfg = FrameworkConfiguration::getSelfInstance();
+
+               // Load all classes for the application
+               foreach (self::$frameworkPaths as $class) {
+                       // Create path name
+                       $path = sprintf('%s/%s/%s', $cfg->getConfigEntry('application_path'), $cfg->getConfigEntry('app_name'), $class);
+
+                       // Is the path readable?
+                       if (is_dir($path)) {
+                               // Try to load the application classes
+                               ClassLoader::getSelfInstance()->scanClassPath($path);
+                       } // END - if
+               } // END - foreach
+       }
+
        /**
         * Initializes our loader class
         *
@@ -194,7 +243,7 @@ class ClassLoader {
                        $this->classes = unserialize($cacheContent);
 
                        // List has been restored from cache!
-                       $this->listCached = true;
+                       $this->listCached = TRUE;
                } // END - if
 
                // Does the class cache exist?
@@ -203,7 +252,7 @@ class ClassLoader {
                        require($this->classCacheFQFN);
 
                        // Mark the class cache as loaded
-                       $this->classesCached = true;
+                       $this->classesCached = TRUE;
                } // END - if
        }
 
@@ -243,7 +292,7 @@ class ClassLoader {
         */
        public function scanClassPath ($basePath, array $ignoreList = array() ) {
                // Is a list has been restored from cache, don't read it again
-               if ($this->listCached === true) {
+               if ($this->listCached === TRUE) {
                        // Abort here
                        return;
                } // END - if
@@ -253,10 +302,9 @@ class ClassLoader {
                 * scanning the whole directory structure starting from given base
                 * path.
                 */
-               $ignoreList[] = '.';
-               $ignoreList[] = '..';
-               $ignoreList[] = '.htaccess';
-               $ignoreList[] = '.svn';
+               array_push($ignoreList, '.');
+               array_push($ignoreList, '..');
+               array_push($ignoreList, '.htaccess');
 
                // Keep it in class for later usage
                $this->ignoreList = $ignoreList;
@@ -268,10 +316,10 @@ class ClassLoader {
                 */
                $basePath2 = realpath($basePath);
 
-               // If the basePath is false it is invalid
-               if ($basePath2 === false) {
+               // If the basePath is FALSE it is invalid
+               if ($basePath2 === FALSE) {
                        /* @todo: Do not die here. */
-                       die(__METHOD__ . ':Cannot read ' . $basePath . ' !');
+                       exit(__METHOD__ . ':Cannot read ' . $basePath . ' !' . PHP_EOL);
                } else {
                        // Set base path
                        $basePath = $basePath2;
@@ -279,9 +327,9 @@ class ClassLoader {
 
                // Get a new iterator
                //* DEBUG: */ echo "<strong>Base path: {$basePath}</strong><br />\n";
-               $iterator = new RecursiveDirectoryIterator($basePath);
-               $recursive = new RecursiveIteratorIterator($iterator);
-               foreach ($recursive as $entry) {
+               $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($basePath));
+
+               foreach ($iterator as $entry) {
                        // Get filename from iterator
                        $fileName = $entry->getFileName();
 
@@ -346,7 +394,7 @@ class ClassLoader {
                        $this->total++;
 
                        // Mark this class as loaded
-                       $this->loadedClasses[] = $this->classes[$fileName];
+                       array_push($this->loadedClasses, $this->classes[$fileName]);
 
                        // Remove it from classes list
                        unset($this->classes[$fileName]);
@@ -354,7 +402,7 @@ class ClassLoader {
                        // Developer mode excludes caching (better debugging)
                        if (!defined('DEVELOPER')) {
                                // Reset cache
-                               $this->classesCached = false;
+                               $this->classesCached = FALSE;
                        } // END - if
                } // END - if
        }
@@ -396,7 +444,7 @@ class ClassLoader {
                // Prepare the list
                $includeList = '';
                foreach ($this->loadedClasses as $classFile) {
-                       $includeList .= basename($classFile)."<br />\n";
+                       $includeList .= basename($classFile) . '<br />' . PHP_EOL;
                } // END - foreach
 
                // And return it