Doctrine Project

[MODM-93] YAML and XML mapping drivers ignore discriminatorField and discriminatorMap

Wed, 24 Nov 2010 13:13:32 +0000

The discriminatorField and discriminatorMap options are ignored by both the YAML and XML drivers.

Example:
This mapping fails to store the discriminator in the type field and instead uses _doctrine_class_name as the discriminatorField the mapping also reverts to using class names.

 
<?xml version="1.0" encoding="UTF-8"?>
<doctrine-mongo-mapping>
    <document name="Application\Test\Document\Group" collection="groups">
        <field name="id" fieldName="id" id="true" />
        <field name="name" fieldName="name" type="string" />
        <embed-many field="people" discriminator-field="type">
            <discriminator-map>
                <discriminator-mapping class="Admin" value="Admin" />
                <discriminator-mapping class="User" value="User" />
            </discriminator-map>
        </embed-many>
    </document>
</doctrine-mongo-mapping>

I think that this is also a problem for referenced documents as well, as the code for the two is nearly identical.

I refactored addEmbedMapping and addReferenceMapping to call the same function addDocumentMapping
Commit can be found here http://github.com/dordille/mongodb-odm/commit/41ce2ee126ff7f82610130704dbec451384bfdd3

[MODM-50] GridFs file classes don't support inheritance

Tue, 17 Aug 2010 23:57:45 +0000

GridFs files do not support inheritance anymore. This issue only appeared after latest updates from git. It was working before.

Here is a test case:

/**
 * @Document(collection="files", db="tests")
 * @InheritanceType("SINGLE_COLLECTION")
 * @DiscriminatorField(fieldName="type")
 * @DiscriminatorMap({
 *      "file"="file",
 *      "image"="image"
 * })
 */
class file
{
    /** @Id */
    protected $id;

    /** @File */
    protected $file;

    function __construct($file) {$this->file = $file;}
}

/** @Document(collection="files", db="tests") */
class image extends file
{
    /** @File */
    protected $file;
}

$a = new image(__DIR__ . '/test.txt');
$dm->persist($a);
$dm->flush();

This code creates document in regular collection "files" instead of GridFs collection.

[MODM-49] Getting PHP notice and warning with empty persistent collection

Tue, 17 Aug 2010 17:16:52 +0000

If there is an object with empty collection, e.g.:

{
  "_id": "4c6a11810f9d503c03000000",
  "b": [
  ]
}

Then following code produces notice and warning:

/** @Document(db="tests", collection="tests") */
class a
{
    /** @Id */
    protected $id;

    /** @ReferenceMany(targetDocument="b", cascade="persist") */
    protected $b;

    function getB()   {return $this->b;}
}

/** @Document(db="tests", collection="tests2") */
class b
{
    /** @Id */
    protected $id;
}

$a = $dm->loadByID('a', '4c6a11810f9d503c03000000');
echo count($a->getB()); // produces notice and warning

Notice and warning text:

Notice: Undefined variable: groupedIds in library\Doctrine\ODM\MongoDB\PersistentCollection.php on line 122

Warning: Invalid argument supplied for foreach() in library\Doctrine\ODM\MongoDB\PersistentCollection.php on line 122

[MODM-48] Embedded document changes are ignored if it was empty before

Tue, 17 Aug 2010 20:13:13 +0000

Imaging the object in DB:

{
  "_id": "4c693f9f0f9d501c0d000000",
  "b": [
  ]
}

Then following code fails to update property "b":

/** @Document(db="tests", collection="tests") */
class a
{
    /** @Id */
    protected $id;

    /** @EmbedOne(targetDocument="b", cascade="all") */
    protected $b;

    function getId()  {return $this->id;}
    function getB()   {return $this->b;}
    function setB($b) {$this->b = $b;}
}

/** @EmbeddedDocument */
class b
{
    /** @String */
    protected $val;
    function setVal($val) {$this->val = $val;}
    function getVal() {return $this->val;}
}

$a = $dm->loadByID('a', '4c693f9f0f9d501c0d000000');
$a->getB()->setVal('test');

$dm->persist($a);
$dm->flush();
$dm->getUnitOfWork()->clear();

$a = $dm->loadByID('a', $a->getId());
$c = ('test' === $a->getB()->getVal());

var_dump($c); // expecting "true", but outputs false

[MODM-47] @AlsoLoad annotation, used on method causes fatal error

Tue, 17 Aug 2010 17:15:27 +0000

Getting following errors when using @AlsoLoad annotation on method:

Notice: Undefined index: isCascadePersist in library\Doctrine\ODM\MongoDB\UnitOfWork.php on line 1661

Notice: Undefined index: fieldName in library\Doctrine\ODM\MongoDB\UnitOfWork.php on line 362

Notice: Undefined index: in library\Doctrine\ODM\MongoDB\Mapping\ClassMetadata.php on line 923

Fatal error: Call to a member function getValue() on a non-object in library\Doctrine\ODM\MongoDB\Mapping\ClassMetadata.php on line 923

Test Case:

/** @Document(db="tests", collection="tests") */
class a
{
    /** @Id */
    protected $id;

    /** @String */
    protected $b = 'tmp';

    /** @AlsoLoad("c") */
    function renameC($c) {$this->b = $c;}
    function getId() {return $this->id;}
}

$a = new a();
$dm->persist($a);
$dm->flush();
$dm->getUnitOfWork()->clear();

$a = $dm->loadByID('a', $a->getId());

[MODM-46] @AlsoLoad annotation causes exception when used together with Embed/Reference annotations

Tue, 17 Aug 2010 16:57:27 +0000

Imagine that there is following object in DB:

{
  "_id": "4c6936bf0f9d50300d000000",
  "c": {
    "tmp": "tmp"
  }
}

And I want to rename property "c" to "b" in my class, using @AlsoLoad together with @EmbedOne

/** @Document(db="tests", collection="tests") */
class a
{
    /** @Id */
    protected $id;

    /**
     * @EmbedOne(targetDocument="b")
     * @AlsoLoad("c")
     */
    protected $b;
}

/** @EmbeddedDocument */
class b
{
    protected $tmp = 'tmp';
}

$a = $dm->loadByID('a', '4c6936bf0f9d50300d000000'); // will throw an exception: Property "b" in "a" was already declared, but it must be declared only once

[MODM-45] Doctrine doesn't persist empty objects

Tue, 17 Aug 2010 15:49:32 +0000

Doctrine won't persist object if it is empty (all fields are nulls). Not sure if it is bug or expected behavior, but sometimes it causes inconvenience. Test case:

/** @Document(db="tests", collection="tests") */
class a
{
    /** @Id */
    protected $id;

    /** @String */
    protected $b;
}

$a = new a();
$dm->persist($a);
$dm->flush(); // $a won't be inserted

There is also related issue: when embedding empty object (all fields are nulls) embedded object is not saved.

/** @Document(db="tests", collection="tests") */
class a
{
    /** @Id */
    protected $id;

    /** @String */
    protected $tmp = 'WorkaroundToBeSaved';

    /** @EmbedOne(targetDocument="b", cascade="all") */
    protected $b;

    function getId()  {return $this->id;}
    function getB()   {return $this->b;}
    function setB($b) {$this->b = $b;}
}

/** @EmbeddedDocument */
class b
{
    /** @String */
    protected $val;
    function setVal($val) {$this->val = $val;}
    function getVal() {return $this->val;}
}

$a = new a();
$a->setB(new b());

$dm->persist($a);
$dm->flush();
$dm->getUnitOfWork()->clear();

$a = $dm->loadByID('a', $a->getId());
$c = (null !== $a->getB()); 
var_dump($c); // returns false, while expecting true

[MODM-43] Explicit schema migration

Tue, 17 Aug 2010 16:46:39 +0000

Currently supported ways of schema migration are sufficient in many cases. But I think it's worth considering to have more explicit way to migrate schema for better readability / code maintenance.

It might be useful to be able to transform original MongoDb data prior to hydration. Maybe as a new lifecycle callback (e.g. preLoad). This way one could have special property for schema version in the document and normalize data according to version differencies. e.g.:

function preLoad(array &$data)
{
    if(!isset($data['version'])) {
        $data['version'] = 1;
    }
    switch($data['version']) {
        case 1:
             $data['fullName'] = $data['name'];
             unset($data['name']);
             // breaks are ommitted intentionally here and below
        case 2:
             $e = explode(' ', $data['fullName'])
             $data['firstname'] = $e[0];
             $data['lastname'] = $e[1];
             unset($data['fullName']);
        case 3:
             $data['address'] = array(
                 'street' => $data['street'],
                 'city' => $data['city']
             );
             unset($data['street']);
             unset($data['city']);
         case 4:
         default:
              // current version
    }
}

Just as example. It also simplifies writing tests for schema migrations as I think. Is it possible with current ODM internals? What do you think?
I could try to implement this feature if it is acceptable proposal.

[MODM-42] PersistentCollection fails when working with MongoGridFs

Tue, 17 Aug 2010 15:52:52 +0000

Getting following error when trying to use MongoGridFs files with referenceMany:

Argument 2 passed to Doctrine\ODM\MongoDB\UnitOfWork::getOrCreateDocument() must be an array, object given, called in 
D:\Work\www\syter2.localhost.dev\library\Doctrine\ODM\MongoDB\PersistentCollection.php on line 110 and defined
D:\Work\www\syter2.localhost.dev\library\Doctrine\ODM\MongoDB\UnitOfWork.php:1719

As far as I understand queries against MongoGridFS collection return instances of MongoGridFSFile, while PersistentCollection only expects arrays (as with regular collections)

I think Issue appeared after latest updates from git. Because I didn't experience it with ALPHA1 (didn't test with ALPHA2)

[MODM-41] Hydration down not work for annotation "@ReferenceMany"

Mon, 9 Aug 2010 10:03:09 +0000

When you try to find or execute query, filds with annotation reference many (arrays) do not load.

Example:

user.php

<?php

/**
 * @Document(db="DB", collection="Users")
 */
class User
{
    /**
     * @Id
     */
    public $id;
    /**
     * @String
     */
    public $name;
    /**
     * @String
     */
    public $password;
    /**
     * @String
     */
    public $email;
        /**
     * @ReferenceMany(targetDocument="Group")
     */
    public $groups = array();
}
?>

group.php

<?php

/**
 * @Document(db="MCI", collection="Groups")
 */
class Group
{
    /**
     * @Id
     */
    public $id;
    /**
     * @String
     */
    public $name;
    /**
     * @String
     */
    public $role_name;

}
?>

When you execute this line:

 $obj = $this->dm->findOne("User",("name" => "Flavio"));

All the fields are returned correctly, but "groups" apear empty.

When you use @EmbedMany annotation works file.

Regards.

PS: I'm using codeigniter framework

[MODM-40] Move value scalarization and comparison to Unit Of Work

Fri, 6 Aug 2010 22:11:17 +0000

The BasicDocumentPersister::_equals belongs in the UnitOfWork.

[MODM-38] Using YAML description with embedMany causes PHP notice error

Fri, 6 Aug 2010 17:06:13 +0000

When using the YAML style description together with the new embedMany functionality of mixed documents, you get a PHP notice error every time you create a new model.

Because when you have mixed documents, you don't specify a targetDocument, and therefore the YAML Driver can not find an element in the array that describes the targetDocument.

[MODM-37] Problems with EmbedMany and discrimatorMap and discriminatorField

Fri, 6 Aug 2010 17:09:14 +0000

I'm experiencing a problem when trying to embed documents and specify my own discriminatorMap and Field.

This is the code I have:

    /** @Document(collection = "ticket") */
    class App_Model_Ticket extends App_Model_Abstract
    {
    	/**
    	 * @EmbedMany(
    	 *	discriminatorField = "type",
    	 *	discriminatorMap={
    	 *		"twitter"="App_Model_Ticket_Twitter",
	 *		"email"="App_Model_Ticket_Email"
	 *	})
	 */
    	protected $messages = array();
    
    	// [...]
    }

App_Model_Abstract is a MappedSuperClass.

App_Model_Ticket_Email and App_Model_Ticket_Twitter pretty much look alike right now:

    /** @EmbeddedDocument */
    class App_Model_Ticket_Email extends App_Model_Ticket_Message
    {
    }

and App_Model_Ticket_Message is another MappedSuperClass that extends App_Model_Abstract.

Now, whenever I create a new model and persist it to mongoDB, the entry gets created and looks like this:

    [_id] => MongoId Object (
    )
    [messages] => Array (
        [0] => Array (
            [message] => Lorem ipsum
            [subject] => Ich bin ein Berliner22
            [dateSent] => MongoDate Object (
                [sec] => 1280909855
                [usec] => 0
            )
            [_doctrine_class_name] => App_Model_Ticket_Twitter
        )
        [1] => Array (
            [message] => Lorem ipsum
            [subject] => Ich bin ein Berliner22
            [dateSent] => MongoDate Object (
                [sec] => 1280909855
                [usec] => 0
            )
            [_doctrine_class_name] => App_Model_Ticket_Email
        )
    )
    [subject] => Ich bin ein Berliner22
    [dateCreated] => MongoDate Object (
        [sec] => 1280909855
        [usec] => 0
    )
    [dateLastMessage] => MongoDate Object (
        [sec] => 1280909855

However, as you can see no type field for my embedded documents, it still uses _doctrine_class_name.

But when I try to fetch this object, I get an exception saying "Class not found".

I think this is because right now Doctrine ODM does not write into the custom discriminatorField with embedded documents, but reads from it.

[MODM-36] Embedded relations are not persisted after a flush()

Fri, 6 Aug 2010 17:01:41 +0000

Newly added embedded relations do not get persisted when a flush() is executed before they are added to the parent document. Here is a failing test, note the comment "// Adding this flush here makes level1 not to be inserted.":

public function testFlushEmbedded()

{ $test = new EmbeddedTestLevel0(); $test->name = 'test'; $this->dm->persist($test); $this->dm->flush(); $this->dm->clear(); $test = $this->dm->findOne('Documents\Functional\EmbeddedTestLevel0'); $this->assertInstanceOf('Documents\Functional\EmbeddedTestLevel0', $test); // Adding this flush here makes level1 not to be inserted. $this->dm->flush(); $level1 = new EmbeddedTestLevel1(); $level1->name = 'test level1 #1'; $test->level1[] = $level1; $this->dm->persist($test); $this->dm->flush(); $this->dm->clear(); $test = $this->dm->findOne('Documents\Functional\EmbeddedTestLevel0'); $this->assertInstanceOf('Documents\Functional\EmbeddedTestLevel0', $test); $this->assertInstanceOf('Documents\Functional\EmbeddedTestLevel1', $test->level1[0]); }

[MODM-35] Proxy item gets reset on persistent collection load if that item was in the collection

Fri, 6 Aug 2010 22:13:51 +0000

Proxy item gets reset on persistent collection load if that item was in the collection

[MODM-34] Custom Id always gets sent with changeset

Fri, 6 Aug 2010 23:15:38 +0000

Whenever the Unit of Work computes the changeset for a document with custom id, the id attribute always gets sent.

[MODM-33] Class-level annotations are ignored if set on MappedSuperclass

Fri, 6 Aug 2010 23:51:42 +0000

Class-level annotations: @HasLifecycleCallbacks, @InheritanceType, @DiscriminatorField, @DiscriminatorMap have no effect when defined on @MappedSuperclass

You must explicitly set @HasLifecycleCallbacks for every document class to make callback work. As for inheritance annotations, you have to copy-paste all annotations to all document classes to make it work.

Simple example:

/**
 * @MappedSuperclass
 * @HasLifecycleCallbacks
 */
abstract class a
{
    /** @String */
    protected $a = '';

    /** @PrePersist */
    function prePersist() {$this->a = 'a';}
}

/** @Document(db="tests",collection="tests") */
class b extends a
{}

$b = new b();
$dm->persist($b);
$dm->flush($b);

With this example prePersist won't be called. Not sure if it is bug or expected behavior, but it adds some inconvenience, especially with inheritance mapping.

[MODM-32] dbref $id persisted as string instead of objectid

Fri, 6 Aug 2010 22:09:43 +0000

A clone of http://github.com/doctrine/mongodb-odm/issues/issue/2/.