Doctrine

Timestamp:

04/30/08 20:58:42 (14 months ago)

Author:

romanb

Message:

Fixed #963. Since it is impossible for Doctrine to determine where the foreign key resides we added a new option that can be used in such scenarios to help Doctrine: owningSide => true. Please refer to the ticket testcase and the introduction of chapter 4, Relations, for the usage.

Location:

branches/0.11

Files:

• lib/Doctrine/Export.php (modified) (2 diffs)
• lib/Doctrine/Relation.php (modified) (3 diffs)
• lib/Doctrine/Relation/Parser.php (modified) (3 diffs)
• lib/Doctrine/Table.php (modified) (2 diffs)
• manual/docs/en/relations.txt (modified) (1 diff)
• tests/Ticket/963TestCase.php (modified) (1 diff)

branches/0.11/lib/Doctrine/Export.php

@@ -253 +253 @@
 
         $query = 'CREATE TABLE ' . $this->conn->quoteIdentifier($name, true) . ' (' . $queryFields;
-
+        
         $check = $this->getCheckDeclaration($fields);
 
@@ -261 +261 @@
 
         $query .= ')';
-
-
 
         $sql[] = $query;

branches/0.11/lib/Doctrine/Relation.php

@@ -61 +61 @@
     const MANY  = 2;
     
-    
+    // TRUE => mandatory, everything else is just a default value. this should be refactored
+    // since TRUE can bot be used as a default value this way. All values should be default values.
     protected $definition = array('alias'       => true,
                                   'foreign'     => true,
@@ -77 +78 @@
                                   'constraint'  => null,
                                   'equal'       => false,
-                                  'cascade'     => array() // application-level cascades
+                                  'cascade'     => array(), // application-level cascades
+                                  'owningSide'  => false // whether this is the owning side
                                   );
 
@@ -140 +142 @@
             }
         }
-
         $this->definition = $def;
     }

branches/0.11/lib/Doctrine/Relation/Parser.php

@@ -114 +114 @@
 
         $this->_pending[$alias] = array_merge($options, array('class' => $name, 'alias' => $alias));
-
+        
         return $this->_pending[$alias];
     }
@@ -363 +363 @@
 
         $localIdentifierColumnNames = $this->_table->getIdentifierColumnNames();
+        $localIdentifierCount = count($localIdentifierColumnNames);
         $localIdColumnName = array_pop($localIdentifierColumnNames);
         $foreignIdentifierColumnNames = $def['table']->getIdentifierColumnNames();
@@ -381 +382 @@
                 }
             } else {
-                if (count($localIdentifierColumnNames) > 0 || ($def['local'] !== $localIdColumnName && 
-                        $def['type'] == Doctrine_Relation::ONE)) {
+                if ($localIdentifierCount == 1) {
+                    if ($def['local'] == $localIdColumnName && isset($def['owningSide'])
+                            && $def['owningSide'] === true) {
+                        $def['localKey'] = true;
+                    } else if (($def['local'] !== $localIdColumnName && $def['type'] == Doctrine_Relation::ONE)) {
+                        $def['localKey'] = true;
+                    }
+                } else if ($localIdentifierCount > 1) {
+                    // It's a composite key and since 'foreign' can not point to a composite
+                    // key currently, we know that 'local' must be the foreign key.
                     $def['localKey'] = true;
                 }

branches/0.11/lib/Doctrine/Table.php

@@ -594 +594 @@
             }
         }
-        $options['foreignKeys'] = array();
-
+        
+        $options['foreignKeys'] = isset($this->_options['foreignKeys']) ?
+                $this->_options['foreignKeys'] : array();
 
         if ($parseForeignKeys && $this->getAttribute(Doctrine::ATTR_EXPORT)
@@ -634 +635 @@
                 }
             }
-
+            
             foreach ($constraints as $k => $def) {
                 $options['foreignKeys'][$k] = array_merge($options['foreignKeys'][$k], $def);

branches/0.11/manual/docs/en/relations.txt

@@ -8 +8 @@
 second argument is an array consisting of relation options. The option array contains the following keys:
 
-* **local**, the local field of the relation. Local field is the linked field or fields in the defining class.
-* **foreign**, the foreign field of the relation. Foreign field is the linked field or fields in the linked class.
-* **refClass**, the name of the reference / join class. This is needed for many-to-many associations.
-* **onDelete**, the onDelete integrity action.
-* **onUpdate**, the onUpdate integrity action.
+* **local**, the local field of the relation. Local field is the linked field in the defining class.
+* **foreign**, the foreign field of the relation. Foreign field is the linked field in the linked class.
+* **refClass**, the name of the association class. This is only needed for many-to-many associations.
+* **owningSide**, (optional) set to boolean true to indicate the owning side of the relation. The owning side is the side that owns the foreign key. There can only be one owning side in an association between two classes. Note that this option is required if Doctrine can't guess the owning side or it's guess is wrong. An example where this is the case is when both 'local' and 'foreign' are part of the identifier (primary key). It never hurts to specify the owning side in this way.', 
+* **onDelete**, (optional) the onDelete integrity action that is applied on the foreign key constraint when the tables are created by Doctrine.
+* **onUpdate**, (optional) the onUpdate integrity action that is applied on the foreign key constraint when the tables are created by Doctrine.
 
 So lets take our first example, say we have two classes Forum_Board and Forum_Thread. Here Forum_Board has many 

branches/0.11/tests/Ticket/963TestCase.php

@@ -74 +74 @@
   public function setUp()
   {
-    $this->hasOne('Ticket_963_User as User', array('local' => 'user_id',
+    $this->hasOne('Ticket_963_User as User', array(
+                                'local' => 'user_id',
                                 'foreign' => 'id',
+                                'owningSide' => true,
                                 'onDelete' => 'CASCADE'));
   }