Changeset 3204 for trunk/lib/Doctrine.php

Timestamp:

11/22/07 13:40:22 (14 months ago)

Author:

wernerm

Message:

Added isValidModelClass() static method and fixed getLoadedModels() in order to resort back to the (classical) approach of class inclusion as a fallback when record classes have different names than their file names. The fallback behaviour of getLoadedModels() is now similar to what is was before the changes introduced in rev 3002.

Files:

• trunk/lib/Doctrine.php (modified) (40 diffs)

trunk/lib/Doctrine.php

@@ -38 +38 @@
      */
     const VERSION                   = '0.1.0';
-    
+
     /**
      * ERROR CONSTANTS
@@ -362 +362 @@
      */
     const HYDRATE_ARRAY             = 3;
-    
+
     /**
      * HYDRATE_NONE
@@ -436 +436 @@
      */
     private static $_debug = false;
-    
+
     /**
      * _loadedModels
-     * 
+     *
      * Array of all the loaded models and the path to each one for autoloading
      *
@@ -445 +445 @@
      */
     private static $_loadedModels = array();
-    
+
     /**
      * _validators
@@ -468 +468 @@
      * debug
      *
-     * @param string $bool 
+     * @param string $bool
      * @return void
      */
@@ -476 +476 @@
             self::$_debug = (bool) $bool;
         }
-        
+
         return self::$_debug;
     }
@@ -491 +491 @@
             self::$_path = dirname(__FILE__);
         }
-        
+
         return self::$_path;
     }
@@ -499 +499 @@
      *
      * Recursively load all models from a directory or array of directories
-     * 
-     * @param string $directory Path to directory of models or array of directory paths
+     *
+     * @param string $directory    Path to directory of models or array of directory paths
      * @return array $loadedModels
      */
@@ -507 +507 @@
         if ($directory !== null) {
             $manager = Doctrine_Manager::getInstance();
-            
+
             foreach ((array) $directory as $dir) {
                 $it = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir),
                                                         RecursiveIteratorIterator::LEAVES_ONLY);
-
                 foreach ($it as $file) {
                     $e = explode('.', $file->getFileName());
@@ -528 +527 @@
      *
      * Get all the loaded models, you can provide an array of classes or it will use get_declared_classes()
-     * 
+     *
      * Will filter through an array of classes and return the Doctrine_Records out of them.
      * If you do not specify $classes it will return all of the currently loaded Doctrine_Records
      *
-     * @param $classes Array of classes to filter through, otherwise uses get_declared_classes()
-     * @return array $loadedModels
+     * @param classes  Array of classes to filter through, otherwise uses get_declared_classes()
+     * @return array   $loadedModels
      */
     public static function getLoadedModels($classes = null)
@@ -541 +540 @@
             $classes = array_merge($classes, array_keys(self::$_loadedModels));
         }
-        
-        $parent = new ReflectionClass('Doctrine_Record');
-        
+
         $loadedModels = array();
-        
+
         foreach ((array) $classes as $name) {
-            $class = new ReflectionClass($name);
-            
+
+            try {
+                $class = new ReflectionClass($name);
+                if (self::isValidModelClass($class)) {
+                    $loadedModels[] = $name;
+                }
+            } catch (Exception $e) {
+                // Determine class names by the actual inclusion of the model file
+                // The possibility exists that the class name(s) contained in the model
+                // file is not the same as the actual model file name itself
+                if (isset(self::$_loadedModels[$name])) {
+                    $declaredBefore = get_declared_classes();
+                    try {
+                        require_once self::$_loadedModels[$name];
+                        $declaredAfter = get_declared_classes();
+                        // Using array_slice since array_diff is broken is some versions
+                        $foundClasses = array_slice($declaredAfter, count($declaredBefore)-1);
+                        if ($foundClasses) {
+                            foreach ($foundClasses as $name) {
+                                $class = new ReflectionClass($name);
+                                if (self::isValidModelClass($class)) {
+                                    $loadedModels[] = $name;
+                                }
+                            }
+                        }
+                    } catch (Exception $e) {
+                        continue;
+                    }
+                }
+            }
+
+        }
+
+        return $loadedModels;
+    }
+
+
+    /**
+     * isValidModelClass
+     *
+     * Checks whether a reflection class is a valid Doctrine model class
+     *
+     * @param class  A reflection class to validate
+     * @return boolean
+     */
+    public static function isValidModelClass($class)
+    {
+        if ($class instanceof ReflectionClass) {
             // Skip the following classes
             // - abstract classes
-            // - not a subclass of Doctrine_Record 
+            // - not a subclass of Doctrine_Record
             // - don't have a setTableDefinition method
-            if ($class->isAbstract() || 
-                !$class->isSubClassOf($parent) || 
-                !$class->hasMethod('setTableDefinition')) {
-                continue;
+            if (!$class->isAbstract() &&
+                $class->isSubClassOf('Doctrine_Record') &&
+                $class->hasMethod('setTableDefinition')) {
+                return true;
             }
-            
-            $loadedModels[] = $name;
-        }
-        
-        return $loadedModels;
-    }
+        }
+        return false;
+    }
+
 
     /**
@@ -569 +610 @@
      *
      * Get the connection object for a table by the actual table name
-     * 
-     * @param string $tableName 
+     *
+     * @param string $tableName
      * @return object Doctrine_Connection
      */
@@ -576 +617 @@
     {
         $loadedModels = self::getLoadedModels();
-        
+
         foreach ($loadedModels as $name) {
             $model = new $name();
             $table = $model->getTable();
-            
+
             if ($table->getTableName() == $tableName) {
-               return $table->getConnection(); 
+               return $table->getConnection();
             }
         }
-        
+
         return Doctrine_Manager::connection();
     }
@@ -620 +661 @@
 
         $export = new Doctrine_Export_Schema();
-        
+
         $result = $export->exportSchema($yamlPath, 'yml', $directory);
-        
+
         exec('rm -rf ' . $directory);
-        
+
         return $result;
     }
@@ -642 +683 @@
         $import = new Doctrine_Import_Schema();
         $import->setOptions($options);
-        
+
         return $import->importSchema($yamlPath, 'yml', $directory);
     }
@@ -675 +716 @@
      * generateSqlFromModels
      *
-     * @param string $directory 
+     * @param string $directory
      * @return string $build  String of sql queries. One query per line
      */
@@ -681 +722 @@
     {
         $sql = Doctrine_Manager::connection()->export->exportSql($directory);
-        
+
         $build = '';
         foreach ($sql as $query) {
             $build .= $query.";\n";
         }
-        
+
         return $build;
     }
@@ -702 +743 @@
     {
         $export = new Doctrine_Export_Schema();
-        
+
         return $export->exportSchema($yamlPath, 'yml', $directory);
     }
@@ -719 +760 @@
             $specifiedConnections = (array) $specifiedConnections;
         }
-        
+
         $manager = Doctrine_Manager::getInstance();
         $connections = $manager->getConnections();
-        
+
         $results = array();
-        
+
         foreach ($connections as $name => $connection) {
             if ( ! empty($specifiedConnections) && !in_array($name, $specifiedConnections)) {
                 continue;
             }
-            
+
             $info = $manager->parsePdoDsn($connection->getOption('dsn'));
             $username = $connection->getOption('username');
             $password = $connection->getOption('password');
-            
+
             // Make connection without database specified so we can create it
             $connect = $manager->openConnection(new PDO($info['scheme'] . ':host=' . $info['host'], $username, $password), 'tmp_connection', false);
-            
+
             try {
                 // Create database
                 $connect->export->createDatabase($name);
-                
+
                 // Close the tmp connection with no database
                 $manager->closeConnection($connect);
-                
+
                 // Close original connection
                 $manager->closeConnection($connection);
-                
+
                 // Reopen original connection with newly created database
                 $manager->openConnection(new PDO($info['dsn'], $username, $password), $name, true);
-                
+
                 $results[$name] = true;
             } catch (Exception $e) {
@@ -755 +796 @@
             }
         }
-        
+
         return $results;
     }
@@ -772 +813 @@
             $specifiedConnections = (array) $specifiedConnections;
         }
-        
+
         $manager = Doctrine_Manager::getInstance();
-        
+
         $connections = $manager->getConnections();
-        
+
         $results = array();
-        
+
         foreach ($connections as $name => $connection) {
             if ( ! empty($specifiedConnections) && !in_array($name, $specifiedConnections)) {
                 continue;
             }
-            
+
             try {
                 $connection->export->dropDatabase($name);
-                
+
                 $results[$name] = true;
             } catch (Exception $e) {
@@ -792 +833 @@
             }
         }
-        
+
         return $results;
     }
@@ -808 +849 @@
     {
         $data = new Doctrine_Data();
-        
+
         return $data->exportData($yamlPath, 'yml', array(), $individualFiles);
     }
@@ -825 +866 @@
     {
         $data = new Doctrine_Data();
-        
+
         if ( ! $append) {
             $data->purge();
         }
-        
+
         return $data->importData($yamlPath, 'yml');
     }
@@ -835 +876 @@
     /**
      * migrate
-     * 
+     *
      * Migrate database to specified $to version. Migrates from current to latest if you do not specify.
      *
@@ -846 +887 @@
     {
         $migration = new Doctrine_Migration($migrationsPath);
-        
+
         return $migration->migrate($to);
     }
@@ -861 +902 @@
     {
         $builder = new Doctrine_Migration_Builder($migrationsPath);
-        
+
         return $builder->generateMigrationClass($className);
     }
@@ -868 +909 @@
      * generateMigrationsFromDb
      *
-     * @param string $migrationsPath 
+     * @param string $migrationsPath
      * @return void
      * @throws new Doctrine_Migration_Exception
@@ -875 +916 @@
     {
         $builder = new Doctrine_Migration_Builder($migrationsPath);
-        
+
         return $builder->generateMigrationsFromDb();
     }
@@ -882 +923 @@
      * generateMigrationsFromModels
      *
-     * @param string $migrationsPath 
-     * @param string $modelsPath 
+     * @param string $migrationsPath
+     * @param string $modelsPath
      * @return void
      */
@@ -889 +930 @@
     {
         $builder = new Doctrine_Migration_Builder($migrationsPath);
-        
+
         return $builder->generateMigrationsFromModels($modelsPath);
     }
@@ -896 +937 @@
      * getTable
      *
-     * @param string $tableName 
+     * @param string $tableName
      * @return void
      */
@@ -907 +948 @@
      * fileFinder
      *
-     * @param string $type 
+     * @param string $type
      * @return void
      */
@@ -946 +987 @@
             return false;
         }
-        
+
         if ( ! self::$_path) {
             self::$_path = dirname(__FILE__);
         }
-        
+
         $class = self::$_path . DIRECTORY_SEPARATOR . str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
 
         if (file_exists($class)) {
             require_once($class);
-            
+
             return true;
         }
-        
+
         $loadedModels = self::$_loadedModels;
-        
+
         if (isset($loadedModels[$className]) && file_exists($loadedModels[$className])) {
             require_once($loadedModels[$className]);
-            
+
             return true;
         }
@@ -988 +1029 @@
                 $indent .= "    ";
                 foreach ($var as $k => $v) {
-                    
+
                     $ret[] = $indent . $k . ' : ' . self::dump($v, false, $indent);
                 }
@@ -1035 +1076 @@
      * classifyCallback
      *
-     * Callback function to classify a classname properly. 
+     * Callback function to classify a classname properly.
      *
      * @param array $matches An array of matches from a pcre_replace call
-     * @return string A string with matches 1 and mathces 3 in upper case. 
+     * @return string A string with matches 1 and mathces 3 in upper case.
      */
     public static function classifyCallback($matches)
@@ -1061 +1102 @@
         return true;
     }
-    
+
     /**
      * makeDirectories
-     * 
+     *
      * Makes the directories for a path recursively
      *
-     * @param string $path 
+     * @param string $path
      * @return void
      */
@@ -1075 +1116 @@
           return false;
         }
-        
+
         if (is_dir($path) || is_file($path)) {
           return true;
         }
 
-        return mkdir($path, $mode, true); 
-    }
-    
+        return mkdir($path, $mode, true);
+    }
+
     /**
      * removeDirectories
      *
-     * @param string $folderPath 
+     * @param string $folderPath
      * @return void
      */
@@ -1112 +1153 @@
         }
     }
-    
+
     /**
      * getValidators
@@ -1124 +1165 @@
         if (empty(self::$_validators)) {
             $dir = Doctrine::getPath() . DIRECTORY_SEPARATOR . 'Doctrine' . DIRECTORY_SEPARATOR . 'Validator';
-        
+
             $files = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir), RecursiveIteratorIterator::LEAVES_ONLY);
             foreach ($files as $file) {
                 $e = explode('.', $file->getFileName());
-                
+
                 if (end($e) == 'php') {
                     $name = strtolower($e[0]);
-                    
+
                     self::$_validators[$name] = $name;
                 }
             }
         }
-        
+
         return self::$_validators;
     }