Used exit() (also app_die()->app_exit()) because die() is an alias of exit nowadays
[core.git] / inc / loader / class_ClassLoader.php
index c8b3e6ca5a4d3daa950c3e8c6a9b6bce12a60142..2de06ca2fc86abfaf9fa964aa453598b4bc84039 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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
  *
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  * ----------------------------------
+ * 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
@@ -38,7 +40,7 @@ class ClassLoader {
        /**
         * Instance of this class
         */
-       private static $selfInstance = null;
+       private static $selfInstance = NULL;
 
        /**
         * Array with all classes
@@ -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,55 +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;
-
-               // 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
         *
@@ -240,10 +246,13 @@ class ClassLoader {
                if ($this->listCached === true) {
                        // Abort here
                        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';
@@ -252,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 . ' !');
+                       exit(__METHOD__ . ':Cannot read ' . $basePath . ' !');
                } else {
                        // Set base path
                        $basePath = $basePath2;
@@ -274,12 +285,14 @@ class ClassLoader {
                        // Get filename from iterator
                        $fileName = $entry->getFileName();
 
+                       // Get the FQFN and add it to our class list
+                       $fqfn = $entry->getRealPath();
+
                        // Is this file wanted?
                        //* DEBUG: */ echo "FOUND:{$fileName}<br />\n";
-                       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();
+                       if ((!in_array($fileName, $this->ignoreList)) && (filesize($fqfn) > 100) && (substr($fileName, 0, strlen($this->prefix)) == $this->prefix) && (substr($fileName, -strlen($this->suffix), strlen($this->suffix)) == $this->suffix)) {
                                //* DEBUG: */ echo "ADD: {$fileName}<br />\n";
+                               // Add it to the list
                                $this->classes[$fileName] = $fqfn;
                        } // END - if
                } // END - foreach
@@ -306,7 +319,7 @@ class ClassLoader {
                // Include these extra configs now
                $this->includeExtraConfigs();
 
-               // Set the prefix back
+               // Set back the old prefix
                $this->prefix = $oldPrefix;
        }