doctrine2/tests/Doctrine/Tests/ORM/Functional/SingleTableInheritanceTest.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 SingleTableInheritanceTest extends \Doctrine\Tests\OrmFunctionalTestCase
{
    protected function setUp() {
        parent::setUp();
        try {
            $this->_schemaTool->createSchema(array(
                $this->_em->getClassMetadata('Doctrine\Tests\ORM\Functional\ParentEntity'),
                $this->_em->getClassMetadata('Doctrine\Tests\ORM\Functional\ChildEntity'),
                $this->_em->getClassMetadata('Doctrine\Tests\ORM\Functional\RelatedEntity'),
                $this->_em->getClassMetadata('Doctrine\Tests\ORM\Functional\ParentRelatedEntity')
            ));
        } catch (\Exception $e) {
            // Swallow all exceptions. We do not test the schema tool here.
        }
    }

    public function testCRUD()
    {        
        $parent = new ParentEntity;
        $parent->setData('foobar');

        $this->_em->persist($parent);

        $child = new ChildEntity;
        $child->setData('thedata');
        $child->setNumber(1234);

        $this->_em->persist($child);

        $relatedEntity = new RelatedEntity;
        $relatedEntity->setName('theRelatedOne');
        $relatedEntity->setOwner($child);

        $this->_em->persist($relatedEntity);

        $this->_em->flush();
        $this->_em->clear();

        $query = $this->_em->createQuery("select e from Doctrine\Tests\ORM\Functional\ParentEntity e order by e.data asc");
        $query->setHint(Query::HINT_FORCE_PARTIAL_LOAD, true);
        $entities = $query->getResult();
        
        $this->assertEquals(2, count($entities));
        $this->assertTrue(is_numeric($entities[0]->getId()));
        $this->assertTrue(is_numeric($entities[1]->getId()));
        $this->assertTrue($entities[0] instanceof ParentEntity);
        $this->assertTrue($entities[1] instanceof ChildEntity);
        $this->assertNull($entities[0]->getParentRelated());
        $this->assertNull($entities[1]->getParentRelated());
        $this->assertEquals('foobar', $entities[0]->getData());
        $this->assertEquals('thedata', $entities[1]->getData());
        $this->assertEquals(1234, $entities[1]->getNumber());

        $this->_em->clear();

        // READ by DQL on subtype
        $query = $this->_em->createQuery("select e from Doctrine\Tests\ORM\Functional\ChildEntity e");
        $entities = $query->getResult();
        $this->assertEquals(1, count($entities));
        $this->assertTrue($entities[0] instanceof ChildEntity);
        $this->assertTrue(is_numeric($entities[0]->getId()));
        $this->assertEquals('thedata', $entities[0]->getData());
        $this->assertEquals(1234, $entities[0]->getNumber());
        $this->assertNull($entities[0]->getParentRelated());

        $this->_em->clear();

        // READ by findAll() on subtype
        $entities = $this->_em->getRepository('Doctrine\Tests\ORM\Functional\ChildEntity')->findAll();
        $this->assertEquals(1, count($entities));
        $this->assertTrue($entities[0] instanceof ChildEntity);
        $this->assertTrue(is_numeric($entities[0]->getId()));
        $this->assertEquals('thedata', $entities[0]->getData());
        $this->assertEquals(1234, $entities[0]->getNumber());
        $this->assertNull($entities[0]->getParentRelated());

        $this->_em->clear();

        // READ by joining into an STI hierarchy from outwards
        $query = $this->_em->createQuery("select r,o from Doctrine\Tests\ORM\Functional\RelatedEntity r join r.owner o");

        $entities = $query->getResult();
        $this->assertEquals(1, count($entities));
        $this->assertTrue($entities[0] instanceof RelatedEntity);
        $this->assertTrue(is_numeric($entities[0]->getId()));
        $this->assertEquals('theRelatedOne', $entities[0]->getName());
        $this->assertTrue($entities[0]->getOwner() instanceof ChildEntity);
        $this->assertEquals('thedata', $entities[0]->getOwner()->getData());
        $this->assertSame($entities[0], $entities[0]->getOwner()->getRelatedEntity());
        $this->assertNull($entities[0]->getOwner()->getParentRelated());

        $query = $this->_em->createQuery("update Doctrine\Tests\ORM\Functional\ChildEntity e set e.data = 'newdata'");

        $affected = $query->execute();
        $this->assertEquals(1, $affected);
        
        $query = $this->_em->createQuery("delete Doctrine\Tests\ORM\Functional\ParentEntity e");

        $affected = $query->execute();
        $this->assertEquals(2, $affected);
        
        $this->_em->clear();
        
        // DQL query with WHERE clause
        $child = new ChildEntity;
        $child->setData('thedata');
        $child->setNumber(1234);

        $this->_em->persist($child);
        $this->_em->flush();
        $this->_em->clear();
        
        $query = $this->_em->createQuery('select e from Doctrine\Tests\ORM\Functional\ParentEntity e where e.id=?1');
        $query->setParameter(1, $child->getId());
        
        $child2 = $query->getSingleResult();
        $this->assertTrue($child2 instanceof ChildEntity);
        $this->assertEquals('thedata', $child2->getData());
        $this->assertEquals(1234, $child2->getNumber());
        $this->assertEquals($child->getId(), $child2->getId());
        $this->assertFalse($child === $child2);
        $this->assertNull($child2->getParentRelated());
    }
    
    public function testGetScalarResult()
    {
        $child = new ChildEntity;
        $child->setData('thedata');
        $child->setNumber(1234);

        $this->_em->persist($child);
        $this->_em->flush();
        
        $query = $this->_em->createQuery('select e from Doctrine\Tests\ORM\Functional\ParentEntity e where e.id=?1');
        $query->setParameter(1, $child->getId());
        
        $result = $query->getScalarResult();
        
        $this->assertEquals(1, count($result));
        $this->assertEquals($child->getId(), $result[0]['e_id']);
        $this->assertEquals('thedata', $result[0]['e_data']);
        $this->assertEquals(1234, $result[0]['e_number']);
        $this->assertNull($result[0]['e_related_entity_id']);
        $this->assertEquals('child', $result[0]['e_discr']);
    }
    
    public function testPolymorphicFindAndQuery()
    {
        $child = new ChildEntity;
        $child->setData('thedata');
        $child->setNumber(1234);

        $this->_em->persist($child);
        $this->_em->flush();
        
        $this->_em->clear();
        
        $child2 = $this->_em->find('Doctrine\Tests\ORM\Functional\ParentEntity', $child->getId());
        
        $this->assertTrue($child2 instanceof ChildEntity);
        $this->assertEquals('thedata', $child2->getData());
        $this->assertSame(1234, $child2->getNumber());
        
        $parentRelated = new ParentRelatedEntity;
        $parentRelated->setData('related to parent!');
        $child2->setParentRelated($parentRelated);
        $parentRelated->setParent($child2);
        $this->_em->persist($parentRelated);
        
        //$this->_em->getConnection()->getConfiguration()->setSQLLogger(new \Doctrine\DBAL\Logging\EchoSQLLogger);
        
        $this->_em->flush();
        $this->_em->clear();
        
        $query = $this->_em->createQuery("select p, r from Doctrine\Tests\ORM\Functional\ParentEntity p join p.parentRelated r");
        $result = $query->getResult();
        
        $this->assertEquals(1, count($result));
        $this->assertTrue($result[0] instanceof ChildEntity);
        $related = $result[0]->getParentRelated();
        $this->assertFalse($related instanceof \Doctrine\ORM\Proxy\Proxy);
        $this->assertTrue($related instanceof ParentRelatedEntity);
        $this->assertEquals('related to parent!', $related->getData());
    }
    
}

/**
 * @Entity
 * @InheritanceType("SINGLE_TABLE")
 * @DiscriminatorColumn(name="discr", type="string")
 * @DiscriminatorMap({"parent"="ParentEntity", "child"="ChildEntity"})
 */
class ParentEntity {
    /**
     * @Id
     * @Column(name="parent_id", type="integer")
     * @GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @Column(name="DATA", type="string")
     */
    private $data;
    
    /** @OneToOne(targetEntity="ParentRelatedEntity", mappedBy="parent") */
    private $parentRelated;

    public function getId() {
        return $this->id;
    }

    public function getData() {
        return $this->data;
    }

    public function setData($data) {
        $this->data = $data;
    }
    
    public function getParentRelated() {
        return $this->parentRelated;
    }
    
    public function setParentRelated($parentRelated) {
        $this->parentRelated = $parentRelated;
    }
}

/**
 * @Entity
 */
class ChildEntity extends ParentEntity {
    /**
     * @Column(name="`number`", type="integer", nullable=true)
     */
    private $number;
    /**
     * @OneToOne(targetEntity="RelatedEntity")
     * @JoinColumn(name="related_entity_id", referencedColumnName="id")
     */
    private $relatedEntity;

    public function getNumber() {
        return $this->number;
    }

    public function setNumber($number) {
        $this->number = $number;
    }

    public function getRelatedEntity() {
        return $this->relatedEntity;
    }

    public function setRelatedEntity($relatedEntity) {
        $this->relatedEntity = $relatedEntity;
        $relatedEntity->setOwner($this);
    }
}

/**
 * @Entity
 */
class RelatedEntity {
    /**
     * @Id
     * @Column(type="integer")
     * @GeneratedValue(strategy="AUTO")
     */
    private $id;
    /**
     * @Column(type="string", length=50)
     */
    private $name;
    /**
     * @OneToOne(targetEntity="ChildEntity", mappedBy="relatedEntity")
     */
    private $owner;

    public function getId() {
        return $this->id;
    }

    public function getName() {
        return $this->name;
    }

    public function setName($name) {
        $this->name = $name;
    }

    public function getOwner() {
        return $this->owner;
    }

    public function setOwner($owner) {
        $this->owner = $owner;
        if ($owner->getRelatedEntity() !== $this) {
            $owner->setRelatedEntity($this);
        }
    }
}

/** @Entity */
class ParentRelatedEntity {
    /**
     * @Id @Column(type="integer")
     * @GeneratedValue(strategy="AUTO")
     */
    private $id;
    public function getId() {return $this->id;}
    /** @Column(type="string") */
    private $data;
    public function getData() {return $this->data;}
    public function setData($data) {$this->data = $data;}
    /**
     * @OneToOne(targetEntity="ParentEntity")
     * @JoinColumn(name="parent_id", referencedColumnName="parent_id")
     */
    private $parent;
    public function getParent() {return $this->parent;}
    public function setParent($parent) {$this->parent = $parent;}
}