[2.0] Fixed hydration issue with bidirectional one-to-many associations. Added...

[2.0] Fixed hydration issue with bidirectional one-to-many associations. Added more test coverage for some advanced association queries and lazy-loading.

lib/Doctrine/ORM/Internal/Hydration/ObjectHydrator.php

@@ -101,7 +101,7 @@ class ObjectHydrator extends AbstractHydrator
     /**
      * {@inheritdoc}
      */
-    /*@override*/ protected function _cleanup()
+    protected function _cleanup()
     {
         parent::_cleanup();
         $this->_identifierMap =
@@ -113,7 +113,7 @@ class ObjectHydrator extends AbstractHydrator
     /**
      * {@inheritdoc}
      */
-    /*@override*/ protected function _hydrateAll()
+    protected function _hydrateAll()
     {
         $result = array();
         $cache = array();
@@ -267,7 +267,7 @@ class ObjectHydrator extends AbstractHydrator
     /**
      * {@inheritdoc}
      */
-    /*@override*/ protected function _hydrateRow(array &$data, array &$cache, array &$result)
+    protected function _hydrateRow(array &$data, array &$cache, array &$result)
     {
         // Initialize
         $id = $this->_idTemplate; // initialize the id-memory
@@ -381,10 +381,18 @@ class ObjectHydrator extends AbstractHydrator
                             $this->_uow->setOriginalEntityProperty($oid, $relationField, $element);
                             $targetClass = $this->_ce[$relation->targetEntityName];
                             if ($relation->isOwningSide) {
+                                //FIXME: Not correct for many-to-one where other side is a collection!
                                 // If there is an inverse mapping on the target class its bidirectional
                                 if (isset($targetClass->inverseMappings[$relation->sourceEntityName][$relationField])) {
-                                    $sourceProp = $targetClass->inverseMappings[$relation->sourceEntityName][$relationField]->sourceFieldName;
-                                    $targetClass->reflFields[$sourceProp]->setValue($element, $parentObject);
+                                    $inverseAssoc = $targetClass->inverseMappings[$relation->sourceEntityName][$relationField];
+                                    if ($inverseAssoc->isOneToMany()) {
+                                        // Only initialize reverse collection if it is not yet initialized.
+                                        if ( ! isset($this->_initializedCollections[spl_object_hash($element) . $inverseAssoc->sourceFieldName])) {
+                                            $this->_initRelatedCollection($element, $inverseAssoc->sourceFieldName);
+                                        }
+                                    } else {
+                                        $targetClass->reflFields[$inverseAssoc->sourceFieldName]->setValue($element, $parentObject);
+                                    }
                                 } else if ($this->_ce[$parentClass] === $targetClass && $relation->mappedByFieldName) {
                                     // Special case: bi-directional self-referencing one-one on the same class
                                     $targetClass->reflFields[$relationField]->setValue($element, $parentObject);

tests/Doctrine/Tests/ORM/Functional/AdvancedAssociationTest.php

+<?php
+
+namespace Doctrine\Tests\ORM\Functional;
+
+use Doctrine\ORM\Query;
+
+require_once __DIR__ . '/../../TestInit.php';
+
+/**
+ * Functional tests for the Single Table Inheritance mapping strategy.
+ *
+ * @author robo
+ */
+class AdvancedAssociationTest extends \Doctrine\Tests\OrmFunctionalTestCase
+{
+    protected function setUp() {
+        parent::setUp();
+        try {
+            $this->_schemaTool->createSchema(array(
+                $this->_em->getClassMetadata('Doctrine\Tests\ORM\Functional\Phrase'),
+                $this->_em->getClassMetadata('Doctrine\Tests\ORM\Functional\PhraseType'),
+                $this->_em->getClassMetadata('Doctrine\Tests\ORM\Functional\Definition'),
+            ));
+        } catch (\Exception $e) {
+            // Swallow all exceptions. We do not test the schema tool here.
+        }
+    }
+
+    public function testIssue()
+    {
+        //setup
+        $phrase = new Phrase;
+        $phrase->setPhrase('lalala');
+        
+        $type = new PhraseType;
+        $type->setType('nonsense');
+        $type->setAbbreviation('non');
+        
+        $def1 = new Definition;
+        $def1->setDefinition('def1');
+        $def2 = new Definition;
+        $def2->setDefinition('def2');
+        
+        $phrase->setType($type);
+        $phrase->addDefinition($def1);
+        $phrase->addDefinition($def2);
+        
+        $this->_em->persist($phrase);
+        $this->_em->persist($type);
+        
+        $this->_em->flush();
+        $this->_em->clear();
+        //end setup
+        
+        // test1 - lazy-loading many-to-one after find()
+        $phrase2 = $this->_em->find('Doctrine\Tests\ORM\Functional\Phrase', $phrase->getId());
+        $this->assertTrue(is_numeric($phrase2->getType()->getId()));
+        
+        $this->_em->clear();
+        
+        // test2 - eager load in DQL query
+        $query = $this->_em->createQuery("SELECT p,t FROM Doctrine\Tests\ORM\Functional\Phrase p JOIN p.type t");
+        $res = $query->getResult();
+        $this->assertEquals(1, count($res));
+        $this->assertTrue($res[0]->getType() instanceof PhraseType);
+        $this->assertTrue($res[0]->getType()->getPhrases() instanceof \Doctrine\ORM\PersistentCollection);
+        $this->assertFalse($res[0]->getType()->getPhrases()->isInitialized());
+        
+        $this->_em->clear();
+        
+        // test2 - eager load in DQL query with double-join back and forth
+        $query = $this->_em->createQuery("SELECT p,t,pp FROM Doctrine\Tests\ORM\Functional\Phrase p JOIN p.type t JOIN t.phrases pp");
+        $res = $query->getResult();
+        $this->assertEquals(1, count($res));
+        $this->assertTrue($res[0]->getType() instanceof PhraseType);
+        $this->assertTrue($res[0]->getType()->getPhrases() instanceof \Doctrine\ORM\PersistentCollection);
+        $this->assertTrue($res[0]->getType()->getPhrases()->isInitialized());
+        
+        $this->_em->clear();
+        
+        // test3 - lazy-loading one-to-many after find()
+        $phrase3 = $this->_em->find('Doctrine\Tests\ORM\Functional\Phrase', $phrase->getId());
+        $definitions = $phrase3->getDefinitions();
+        $this->assertTrue($definitions instanceof \Doctrine\ORM\PersistentCollection);
+        $this->assertTrue($definitions[0] instanceof Definition);
+        
+        $this->_em->clear();
+        
+        // test4 - lazy-loading after DQL query
+        $query = $this->_em->createQuery("SELECT p FROM Doctrine\Tests\ORM\Functional\Phrase p");
+        $res = $query->getResult();
+        $definitions = $res[0]->getDefinitions();
+        
+        $this->assertEquals(1, count($res));
+        $this->assertTrue($definitions[0] instanceof Definition);
+        $this->assertEquals(2, $definitions->count());
+        
+    }
+}
+
+/**
+ * @Entity
+ * @Table(name="phrase")
+ */
+class Phrase {
+
+    const CLASS_NAME = __CLASS__;
+
+    /**
+     * @Id
+     * @Column(type="integer", name="phrase_id")
+     * @GeneratedValue(strategy="AUTO")
+     */
+    private $id;
+
+    /**
+     * @Column(type="string", name="phrase_name", unique=true, length=255)
+     */
+    private $phrase;
+
+    /**
+     * @ManyToOne(targetEntity="PhraseType")
+     * @JoinColumn(name="phrase_type_id", referencedColumnName="phrase_type_id")
+     */
+    private $type;
+    
+    /**
+     * @OneToMany(targetEntity="Definition", mappedBy="phrase", cascade={"persist"})
+     */
+    private $definitions;
+
+    public function __construct() {
+        $this->definitions = new \Doctrine\Common\Collections\ArrayCollection;
+    }
+    
+    /**
+     * 
+     * @param Definition $definition
+     * @return void
+     */
+    public function addDefinition(Definition $definition){
+        $this->definitions[] = $definition;
+        $definition->setPhrase($this);
+    }
+    
+    /**
+     * @return int
+     */
+    public function getId(){
+        return $this->id;
+    }
+    
+    /**
+     * @param string $phrase
+     * @return void
+     */
+    public function setPhrase($phrase){
+        $this->phrase = $phrase;
+    }
+    
+    /**
+     * @return string
+     */
+    public function getPhrase(){
+        return $this->phrase;
+    }
+    
+    /**
+     *
+     * @param PhraseType $type
+     * @return void
+     */
+    public function setType(PhraseType $type){
+        $this->type = $type;
+    }
+    
+    /**
+     *
+     * @return PhraseType
+     */
+    public function getType(){
+        return $this->type;
+    }
+    
+    /**
+     * 
+     * @return ArrayCollection
+     */
+    public function getDefinitions(){
+        return $this->definitions;
+    }
+}
+
+/**
+ * @Entity
+ * @Table(name="phrase_type")
+ */
+class PhraseType {
+    
+    const CLASS_NAME = __CLASS__;
+    
+    /**
+     * @Id
+     * @Column(type="integer", name="phrase_type_id")
+     * @GeneratedValue(strategy="AUTO")
+     */
+    private $id;
+    
+    /**
+     * @Column(type="string", name="phrase_type_name", unique=true)
+     */
+    private $type;
+    
+    /**
+     * @Column(type="string", name="phrase_type_abbreviation", unique=true)
+     */
+    private $abbreviation;
+    
+    /**
+     * @OneToMany(targetEntity="Phrase", mappedBy="type")
+     */
+    private $phrases;
+    
+    public function __construct() {
+        $this->phrases = new \Doctrine\Common\Collections\ArrayCollection;
+    }
+    
+    /**
+     * @return int
+     */
+    public function getId(){
+        return $this->id;
+    }
+    
+    /**
+     * @param string $type
+     * @return void
+     */
+    public function setType($type){
+        $this->type = $type;
+    }
+    
+    /**
+     * @return string
+     */
+    public function getType(){
+        return $this->type;
+    }
+    
+    /**
+     * @param string $abbreviation
+     * @return void
+     */
+    public function setAbbreviation($abbreviation){
+        $this->abbreviation = $abbreviation;
+    }
+    
+    /**
+     * @return string
+     */
+    public function getAbbreviation(){
+        return $this->abbreviation;
+    }
+    
+    /**
+     * @param ArrayCollection $phrases
+     * @return void
+     */
+    public function setPhrases($phrases){
+        $this->phrases = $phrases;
+    }
+    
+    /**
+     * 
+     * @return ArrayCollection
+     */
+    public function getPhrases(){
+        return $this->phrases;
+    }
+    
+}
+
+/**
+ * @Entity
+ * @Table(name="definition")
+ */
+class Definition {
+    
+    const CLASS_NAME = __CLASS__;
+    
+    /**
+     * @Id
+     * @Column(type="integer", name="definition_id")
+     * @GeneratedValue(strategy="AUTO")
+     */
+    private $id;
+    
+    /**
+     * @ManyToOne(targetEntity="Phrase")
+     * @JoinColumn(name="definition_phrase_id", referencedColumnName="phrase_id")
+     */
+    private $phrase;
+    
+    /**
+     * @Column(type="text", name="definition_text")
+     */
+    private $definition;
+    
+    /**
+     * @return int
+     */
+    public function getId(){
+        return $this->id;
+    }
+    
+    /**
+     * @param Phrase $phrase
+     * @return void
+     */
+    public function setPhrase(Phrase $phrase){
+        $this->phrase = $phrase;
+    }
+    
+    /**
+     * @return Phrase
+     */
+    public function getPhrase(){
+        return $this->phrase;
+    }
+    
+    public function removePhrase() {
+        if ($this->phrase !== null) {
+            /*@var $phrase kateglo\application\models\Phrase */
+            $phrase = $this->phrase;
+            $this->phrase = null;
+            $phrase->removeDefinition($this);
+        }
+    }
+    
+    /**
+     * @param string $definition
+     * @return void
+     */
+    public function setDefinition($definition){
+        $this->definition = $definition;
+    }
+    
+    /**
+     * @return string
+     */
+    public function getDefinition(){
+        return $this->definition;
+    }
+}

tests/Doctrine/Tests/ORM/Functional/AllTests.php

@@ -20,6 +20,7 @@ class AllTests
         $suite = new \Doctrine\Tests\OrmFunctionalTestSuite('Doctrine Orm Functional');
 
         $suite->addTestSuite('Doctrine\Tests\ORM\Functional\BasicFunctionalTest');
+        $suite->addTestSuite('Doctrine\Tests\ORM\Functional\AdvancedAssociationTest');
         $suite->addTestSuite('Doctrine\Tests\ORM\Functional\NativeQueryTest');
         $suite->addTestSuite('Doctrine\Tests\ORM\Functional\SingleTableInheritanceTest');
         $suite->addTestSuite('Doctrine\Tests\ORM\Functional\ClassTableInheritanceTest');