Doctrine

Timestamp:

03/10/08 06:41:15 (16 months ago)

Author:

jwage

Message:

fixes #796 fixes #797

Location:

branches/0.10

Files:

• lib/Doctrine/Import/Builder.php (modified) (5 diffs)
• lib/Doctrine/Import/Schema.php (modified) (6 diffs)
• tests/Import/BuilderTestCase.php (modified) (2 diffs)
• tests/Import/SchemaTestCase.php (modified) (1 diff)
• tests/schema.yml (modified) (1 diff)

branches/0.10/lib/Doctrine/Import/Builder.php

@@ -312 +312 @@
     public function buildTableDefinition(array $definition)
     {
+        if (isset($definition['inheritance']['type']) && $definition['inheritance']['type'] == 'simple') {
+            return;
+        }
+        
         $ret = array();
         
         $i = 0;
         
-        if (isset($definition['inheritance']['extends']) && ! (isset($definition['override_parent']) && $definition['override_parent'] == true)) {
+        if (isset($definition['inheritance']['type']) && $definition['inheritance']['type'] == 'concrete') {
             $ret[$i] = "    parent::setTableDefinition();";
             $i++;
@@ -323 +327 @@
         if (isset($definition['tableName']) && !empty($definition['tableName'])) {
             $ret[$i] = "    ".'$this->setTableName(\''. $definition['tableName'].'\');';
-            
             $i++;
         }
@@ -344 +347 @@
         if (isset($definition['options']) && is_array($definition['options']) && !empty($definition['options'])) {
             $ret[$i] = $this->buildOptions($definition['options']);
+            $i++;
+        }
+        
+        if (isset($definition['inheritance']['subclasses']) && ! empty($definition['inheritance']['subclasses'])) {
+            $ret[$i] = "    ".'$this->setSubClasses('. $this->varExport($definition['inheritance']['subclasses']).');';
             $i++;
         }
@@ -364 +372 @@
      */
     public function buildSetUp(array $definition)
-    {   
+    {
+        if (isset($definition['inheritance']['type']) && ($definition['inheritance']['type'] == 'simple' || $definition['inheritance']['type'] == 'column_aggregation')) {
+            return;
+        }
+
         $ret = array();
         $i = 0;
         
-        if (isset($definition['inheritance']['extends']) && ! (isset($definition['override_parent']) && $definition['override_parent'] == true)) {
+        if (isset($definition['inheritance']['type']) && $definition['inheritance']['type'] == 'concrete') {
             $ret[$i] = "    parent::setUp();";
             $i++;
@@ -428 +440 @@
                 $i++;
             }
-        }
-
-        if (isset($definition['inheritance']['keyField']) && isset($definition['inheritance']['keyValue'])) {
-            $i++;
-            $ret[$i] = "    ".'$this->setInheritanceMap(array(\''.$definition['inheritance']['keyField'].'\' => \''.$definition['inheritance']['keyValue'].'\'));';
         }
 

branches/0.10/lib/Doctrine/Import/Schema.php

@@ -130 +130 @@
 
         $array = $this->_buildRelationships($array);
+        $array = $this->_processInheritance($array);
 
         return $array;
@@ -225 +226 @@
             $className = isset($table['className']) ? (string) $table['className']:(string) $className;
 
+            if (isset($table['inheritance']['keyField']) || isset($table['inheritance']['keyValue'])) {
+                $table['inheritance']['type'] = 'column_aggregation';
+            }
+
             if (isset($table['tableName']) && $table['tableName']) {
                 $tableName = $table['tableName'];
             } else {
-                if (isset($table['inheritance']['extends'])) {
+                if (isset($table['inheritance']['type']) && ($table['inheritance']['type'] == 'column_aggregation')) {
                     $tableName = null;
                 } else {
@@ -282 +287 @@
             // Apply the default values
             foreach ($defaults as $key => $defaultValue) {
-                if (isset($table[$key]) && !isset($build[$className][$key])) {
+                if (isset($table[$key]) && ! isset($build[$className][$key])) {
                     $build[$className][$key] = $table[$key];
                 } else {
@@ -288 +293 @@
                 }
             }
-
+            
             $build[$className]['className'] = $className;
             $build[$className]['tableName'] = $tableName;
             $build[$className]['columns'] = $columns;
-
+            
             // Make sure that anything else that is specified in the schema makes it to the final array
             $build[$className] = Doctrine_Lib::arrayDeepMerge($table, $build[$className]);
@@ -301 +306 @@
 
         return $build;
+    }
+
+    /**
+     * _processInheritance
+     * 
+     * Perform some processing on inheritance.
+     *
+     * @param string $array 
+     * @return void
+     */
+    protected function _processInheritance($array)
+    {
+        // Apply default inheritance configuration
+        foreach ($array as $className => $definition) {
+            if ( ! empty($array[$className]['inheritance'])) {
+                // Default inheritance to concrete inheritance                
+                if ( ! isset($array[$className]['inheritance']['type'])) {
+                    $array[$className]['inheritance']['type'] = 'class_table';
+                }
+
+                // Some magic for setting up the keyField and keyValue column aggregation options
+                // Adds keyField to the parent class automatically
+                if ($array[$className]['inheritance']['type'] == 'column_aggregation') {
+                    // Set the keyField to 'type' by default
+                    if ( ! isset($array[$className]['inheritance']['keyField'])) {
+                        $array[$className]['inheritance']['keyField'] = 'type';                        
+                    }
+                    
+                    // Set the keyValue to the name of the child class if it does not exist
+                    if ( ! isset($array[$className]['inheritance']['keyValue'])) {
+                        $array[$className]['inheritance']['keyValue'] = $className;
+                    }
+                    
+                    // Add the keyType column to the parent if a definition does not already exist
+                    if ( ! isset($array[$array[$className]['inheritance']['extends']]['columns']['type'])) {
+                        $array[$definition['inheritance']['extends']]['columns']['type'] = array('name' => 'type', 'type' => 'string', 'length' => 255);
+                    }
+                }
+            }
+        }
+
+        // Array of the array keys to move to the parent, and the value to default the child definition to
+        // after moving it
+        $moves = array('columns' => array(), 'relations' => array());
+        
+        foreach ($array as $className => $definition) {    
+            // Move any definitions on the schema to the parent
+            // Currently only columns and relations are moved. What else should we move?
+            if (isset($definition['inheritance']['extends']) && isset($definition['inheritance']['type']) && ($definition['inheritance']['type'] == 'simple' || $definition['inheritance']['type'] == 'column_aggregation')) {
+                $extends = $definition['inheritance']['extends'];
+
+                foreach ($moves as $move => $resetValue) {
+                    $array[$extends][$move] = Doctrine_Lib::arrayDeepMerge($array[$extends][$move], $definition[$move]);
+                    $array[$definition['className']][$move] = $resetValue;
+                }
+
+                if ($definition['inheritance']['type'] == 'column_aggregation') {
+                    $array[$extends]['inheritance']['subclasses'][$definition['className']] = array($definition['inheritance']['keyField'] => $definition['inheritance']['keyValue']);
+                }
+            }
+        }
+
+        return $array;
     }
 
@@ -317 +385 @@
         // User.contact_id will automatically create User hasOne Contact local => contact_id, foreign => id
         foreach ($array as $className => $properties) {
-            if (isset($properties['columns']) && !empty($properties['columns']) && isset($properties['detect_relations']) && $properties['detect_relations']) {
+            if (isset($properties['columns']) && ! empty($properties['columns']) && isset($properties['detect_relations']) && $properties['detect_relations']) {
                 foreach ($properties['columns'] as $column) {
                     if (strpos($column['name'], '_id')) {

branches/0.10/tests/Import/BuilderTestCase.php

@@ -35 +35 @@
     public function testInheritanceGeneration()
     {
-        $path = realpath(dirname(__FILE__) . '/../..') . '/models/test_generated';
+        $path = dirname(__FILE__) . '/import_builder_test';
 
         $import = new Doctrine_Import_Schema();
@@ -74 +74 @@
         $this->assertTrue($schemaTestInheritanceChild2Table->isSubClassOf('PackageSchemaTestInheritanceChild1Table'));
 
+        # Simple Inheritance
+        $schemaTestSimpleInheritanceParent = new ReflectionClass('SchemaTestSimpleInheritanceParent');
+        $schemaTestSimpleInheritanceChild = new ReflectionClass('SchemaTestSimpleInheritanceChild');
+
+        $this->assertTrue($schemaTestSimpleInheritanceParent->hasMethod('setTableDefinition'));
+        $this->assertTrue($schemaTestSimpleInheritanceChild->isSubClassOf('SchemaTestSimpleInheritanceParent'));
+
+        # Class Table Inheritance
+        $schemaTestClassTableInheritanceParent = new ReflectionClass('SchemaTestClassTableInheritanceParent');
+        $schemaTestClassTableInheritanceChild = new ReflectionClass('SchemaTestClassTableInheritanceChild');
+
+        # Concrete Inheritance
+        $schemaTestConcreteInheritanceParent = new ReflectionClass('SchemaTestConcreteInheritanceParent');
+        $schemaTestConcreteInheritanceChild = new ReflectionClass('SchemaTestConcreteInheritanceChild');
+
+        # Column Aggregation Inheritance
+        $schemaTestColumnAggregationInheritanceParent = new ReflectionClass('SchemaTestColumnAggregationInheritanceParent');
+        $schemaTestColumnAggregationInheritanceChild = new ReflectionClass('SchemaTestColumnAggregationInheritanceChild');
+
+        $sql = Doctrine::generateSqlFromArray(array('SchemaTestSimpleInheritanceParent', 'SchemaTestSimpleInheritanceChild'));
+        $this->assertEqual(count($sql), 1);
+        $this->assertEqual($sql[0], 'CREATE TABLE schema_test_simple_inheritance_parent (id INTEGER PRIMARY KEY AUTOINCREMENT, name VARCHAR(255), description VARCHAR(255))');
+
+        $sql = Doctrine::generateSqlFromArray(array('SchemaTestClassTableInheritanceParent', 'SchemaTestClassTableInheritanceChild'));
+        $this->assertEqual(count($sql), 2);
+        $this->assertEqual($sql[0], 'CREATE TABLE schema_test_class_table_inheritance_parent (id INTEGER PRIMARY KEY AUTOINCREMENT, name VARCHAR(255))');
+        $this->assertEqual($sql[1], 'CREATE TABLE schema_test_class_table_inheritance_child (id INTEGER, title VARCHAR(255), description VARCHAR(255), PRIMARY KEY(id))');
+
+        $sql = Doctrine::generateSqlFromArray(array('SchemaTestConcreteInheritanceParent', 'SchemaTestConcreteInheritanceChild'));
+        $this->assertEqual(count($sql), 2);
+        $this->assertEqual($sql[0], 'CREATE TABLE schema_test_concrete_inheritance_parent (id INTEGER PRIMARY KEY AUTOINCREMENT, name VARCHAR(255))');
+        $this->assertEqual($sql[1], 'CREATE TABLE schema_test_concrete_inheritance_child (id INTEGER PRIMARY KEY AUTOINCREMENT, name VARCHAR(255), title VARCHAR(255), description VARCHAR(255))');
+
+        $sql = Doctrine::generateSqlFromArray(array('SchemaTestColumnAggregationInheritanceParent', 'SchemaTestColumnAggregationInheritanceChild'));
+        $this->assertEqual(count($sql), 1);
+        $this->assertEqual($sql[0], 'CREATE TABLE schema_test_column_aggregation_inheritance_parent (id INTEGER PRIMARY KEY AUTOINCREMENT, name VARCHAR(255), type VARCHAR(255), title VARCHAR(255), description VARCHAR(255))');
+
         Doctrine_Lib::removeDirectories($path);
     }

branches/0.10/tests/Import/SchemaTestCase.php

@@ -38 +38 @@
     public function testYmlImport()
     {
-        $path = realpath(dirname(__FILE__) . '/../..') . '/models/test_generated';
+        $path = dirname(__FILE__) . '/import_builder_test';
         
         $import = new Doctrine_Import_Schema();

branches/0.10/tests/schema.yml

@@ -85 +85 @@
     keyField: type
     keyValue: child2
+
+# Simple Inheritance
+# All children share the columns of the parent
+SchemaTestSimpleInheritanceParent:
+  columns:
+    name: string(255)
+
+SchemaTestSimpleInheritanceChild:
+  inheritance:
+    type: simple
+    extends: SchemaTestSimpleInheritanceParent
+  columns:
+    description: string(255)
+
+# Class Table Inheritance
+# Individual tables, each model has its own columns, and they share id primary keys
+SchemaTestClassTableInheritanceParent:
+  columns:
+    name: string(255)
+
+SchemaTestClassTableInheritanceChild:
+  inheritance:
+    type: class_table
+    extends: SchemaTestClassTableInheritanceParent
+  columns:
+    title: string(255)
+    description: string(255)
+
+# Concrete Inheritance
+# Individual tables, all children share the columns of its parents
+SchemaTestConcreteInheritanceParent:
+  columns:
+    name: string(255)
+
+SchemaTestConcreteInheritanceChild:
+  inheritance:
+    type: concrete
+    extends: SchemaTestClassTableInheritanceParent
+  columns:
+    title: string(255)
+    description: string(255)
+
+# Column Aggregation Inheritance
+# Single table, all children columns are stored in the parent, parent class has a type method
+# Which is used to determine which child the record in the db belonds to
+SchemaTestColumnAggregationInheritanceParent:
+  columns:
+    name: string(255)
+    type: string(255)
+
+SchemaTestColumnAggregationInheritanceChild:
+  inheritance:
+    type: column_aggregation
+    keyField: type
+    keyValue: SchemaTestColumnAggregationInheritanceChild
+    extends: SchemaTestColumnAggregationInheritanceParent
+  columns:
+    title: string(255)
+    description: string(255)