From 41e873bd729d5511f68a2c46fac3ad1ce2e1fb65 Mon Sep 17 00:00:00 2001
From: Stefano Torresi <stefano@torresi.io>
Date: Tue, 17 Mar 2015 17:58:59 +0100
Subject: [PATCH 01/11] add failing functional test for custom id object types

---
 .../Tests/DbalTypes/CustomIdObject.php        | 32 +++++++
 .../Tests/DbalTypes/CustomIdObjectType.php    | 49 +++++++++++
 .../CustomType/CustomIdObjectTypeChild.php    | 43 ++++++++++
 .../CustomType/CustomIdObjectTypeParent.php   | 43 ++++++++++
 .../ORM/Functional/CustomIdObjectTypeTest.php | 86 +++++++++++++++++++
 .../Doctrine/Tests/OrmFunctionalTestCase.php  | 11 ++-
 6 files changed, 263 insertions(+), 1 deletion(-)
 create mode 100644 tests/Doctrine/Tests/DbalTypes/CustomIdObject.php
 create mode 100644 tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
 create mode 100644 tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
 create mode 100644 tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
 create mode 100644 tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php

diff --git a/tests/Doctrine/Tests/DbalTypes/CustomIdObject.php b/tests/Doctrine/Tests/DbalTypes/CustomIdObject.php
new file mode 100644
index 000000000..72d259d54
--- /dev/null
+++ b/tests/Doctrine/Tests/DbalTypes/CustomIdObject.php
@@ -0,0 +1,32 @@
+<?php
+/**
+ * @author Stefano Torresi (http://stefanotorresi.it)
+ * @license See the file LICENSE.txt for copying permission.
+ * ************************************************
+ */
+
+namespace Doctrine\Tests\DbalTypes;
+
+class CustomIdObject
+{
+    /**
+     * @var string
+     */
+    public $id;
+
+    /**
+     * @param string $id
+     */
+    public function __construct($id)
+    {
+        $this->id = (string) $id;
+    }
+
+    /**
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->id;
+    }
+}
diff --git a/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php b/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
new file mode 100644
index 000000000..c24c11354
--- /dev/null
+++ b/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
@@ -0,0 +1,49 @@
+<?php
+/**
+ * @author Stefano Torresi (http://stefanotorresi.it)
+ * @license See the file LICENSE.txt for copying permission.
+ * ************************************************
+ */
+
+namespace Doctrine\Tests\DbalTypes;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class CustomIdObjectType extends Type
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function convertToDatabaseValue($value, AbstractPlatform $platform)
+    {
+        return $value->id;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function convertToPHPValue($value, AbstractPlatform $platform)
+    {
+        $idObject = new CustomIdObject($value);
+
+        return $idObject;
+    }
+
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        $platform->getVarcharTypeDeclarationSQL($fieldDeclaration);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'CustomIdObject';
+    }
+}
diff --git a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
new file mode 100644
index 000000000..a14759e87
--- /dev/null
+++ b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * @author Stefano Torresi (http://stefanotorresi.it)
+ * @license See the file LICENSE.txt for copying permission.
+ * ************************************************
+ */
+
+namespace Doctrine\Tests\Models\CustomType;
+
+use Doctrine\Tests\DbalTypes\CustomIdObject;
+
+/**
+ * @Entity
+ * @Table(name="custom_id_type_child")
+ */
+class CustomIdObjectTypeChild
+{
+    /**
+     * @Id @Column(type="CustomIdObject")
+     *
+     * @var CustomIdObject
+     */
+    public $id;
+
+    /**
+     * @ManyToOne(targetEntity="Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent", inversedBy="children")
+     */
+    public $parent;
+
+    /**
+     * @param CustomIdObject|string    $id
+     * @param CustomIdObjectTypeParent $parent
+     */
+    public function __construct($id, CustomIdObjectTypeParent $parent)
+    {
+        if (! $id instanceof CustomIdObject) {
+            $id = new CustomIdObject($id);
+        }
+
+        $this->id     = $id;
+        $this->parent = $parent;
+    }
+}
diff --git a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
new file mode 100644
index 000000000..d5e00db9a
--- /dev/null
+++ b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * @author Stefano Torresi (http://stefanotorresi.it)
+ * @license See the file LICENSE.txt for copying permission.
+ * ************************************************
+ */
+
+namespace Doctrine\Tests\Models\CustomType;
+
+use Doctrine\Tests\DbalTypes\CustomIdObject;
+use Doctrine\Common\Collections\ArrayCollection;
+
+/**
+ * @Entity
+ * @Table(name="custom_id_type_parent")
+ */
+class CustomIdObjectTypeParent
+{
+    /**
+     * @Id @Column(type="CustomIdObject")
+     *
+     * @var CustomIdObject
+     */
+    public $id;
+
+    /**
+     * @OneToMany(targetEntity="Doctrine\Tests\Models\CustomType\CustomIdObjectTypeChild", cascade={"persist", "remove"}, mappedBy="parent")
+     */
+    public $children;
+
+    /**
+     * @param CustomIdObject|string $id
+     */
+    public function __construct($id)
+    {
+        if (! $id instanceof CustomIdObject) {
+            $id = new CustomIdObject($id);
+        }
+
+        $this->id       = $id;
+        $this->children = new ArrayCollection();
+    }
+}
diff --git a/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
new file mode 100644
index 000000000..3b7276ad8
--- /dev/null
+++ b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
@@ -0,0 +1,86 @@
+<?php
+/**
+ * @author Stefano Torresi (http://stefanotorresi.it)
+ * @license See the file LICENSE.txt for copying permission.
+ * ************************************************
+ */
+
+namespace Doctrine\Tests\ORM\Functional;
+
+use Doctrine\Tests\Models\CustomType\CustomIdObjectTypeChild;
+use Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent;
+use Doctrine\Tests\OrmFunctionalTestCase;
+use Doctrine\DBAL\Types\Type as DBALType;
+
+class CustomIdObjectTypeTest extends OrmFunctionalTestCase
+{
+    protected function setUp()
+    {
+        if (DBALType::hasType('CustomIdObject')) {
+            DBALType::overrideType('CustomIdObject', '\Doctrine\Tests\DbalTypes\CustomIdObjectType');
+        } else {
+            DBALType::addType('CustomIdObject', '\Doctrine\Tests\DbalTypes\CustomIdObjectType');
+        }
+
+        $this->useModelSet('custom_id_object_type');
+        parent::setUp();
+    }
+
+    public function testFindByCustomIdObject()
+    {
+        $parent = new CustomIdObjectTypeParent('foo');
+
+        $this->_em->persist($parent);
+        $this->_em->flush();
+
+        $result = $this->_em->find('Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent', $parent->id);
+
+        $this->assertSame($parent, $result);
+    }
+
+    public function testFetchJoinCustomIdObject()
+    {
+        $parent = new CustomIdObjectTypeParent('foo');
+        $parent->children->add(new CustomIdObjectTypeChild('bar', $parent));
+
+        $this->_em->persist($parent);
+        $this->_em->flush();
+
+        $qb = $this->_em->createQueryBuilder();
+        $qb
+            ->select('parent')
+            ->from('Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent', 'parent')
+            ->addSelect('children')
+            ->leftJoin('parent.children', 'children')
+        ;
+
+        $result = $qb->getQuery()->getResult();
+
+        $this->assertCount(1, $result);
+        $this->assertSame($parent, $result[0]);
+    }
+
+    public function testFetchJoinWhereCustomIdObject()
+    {
+        $parent = new CustomIdObjectTypeParent('foo');
+        $parent->children->add(new CustomIdObjectTypeChild('bar', $parent));
+
+        $this->_em->persist($parent);
+        $this->_em->flush();
+
+        $qb = $this->_em->createQueryBuilder();
+        $qb
+            ->select('parent')
+            ->from('Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent', 'parent')
+            ->addSelect('children')
+            ->leftJoin('parent.children', 'children')
+            ->where('children.id = ?1')
+            ->setParameter(1, $parent->children->first()->id);
+        ;
+
+        $result = $qb->getQuery()->getResult();
+
+        $this->assertCount(1, $result);
+        $this->assertSame($parent, $result[0]);
+    }
+}
diff --git a/tests/Doctrine/Tests/OrmFunctionalTestCase.php b/tests/Doctrine/Tests/OrmFunctionalTestCase.php
index 7aaeae81a..48f9bbdb3 100644
--- a/tests/Doctrine/Tests/OrmFunctionalTestCase.php
+++ b/tests/Doctrine/Tests/OrmFunctionalTestCase.php
@@ -257,7 +257,11 @@ abstract class OrmFunctionalTestCase extends OrmTestCase
             'Doctrine\Tests\Models\GeoNames\Admin1',
             'Doctrine\Tests\Models\GeoNames\Admin1AlternateName',
             'Doctrine\Tests\Models\GeoNames\City'
-        )
+        ),
+        'custom_id_object_type' => array(
+            'Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent',
+            'Doctrine\Tests\Models\CustomType\CustomIdObjectTypeChild',
+        ),
     );
 
     /**
@@ -496,6 +500,11 @@ abstract class OrmFunctionalTestCase extends OrmTestCase
             $conn->executeUpdate('DELETE FROM geonames_country');
         }
 
+        if (isset($this->_usedModelSets['custom_id_object_type'])) {
+            $conn->executeUpdate('DELETE FROM custom_id_type_parent');
+            $conn->executeUpdate('DELETE FROM custom_id_type_child');
+        }
+
         $this->_em->clear();
     }
 

From 2bdc1142fe4c2ba5f49f7f7f16c43f06f829b9d7 Mon Sep 17 00:00:00 2001
From: Stefano Torresi <stefano@torresi.io>
Date: Tue, 17 Mar 2015 17:59:47 +0100
Subject: [PATCH 02/11] add string casting to id hashes

---
 lib/Doctrine/ORM/UnitOfWork.php | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/lib/Doctrine/ORM/UnitOfWork.php b/lib/Doctrine/ORM/UnitOfWork.php
index 0126bc628..3e19e53af 100644
--- a/lib/Doctrine/ORM/UnitOfWork.php
+++ b/lib/Doctrine/ORM/UnitOfWork.php
@@ -1573,6 +1573,10 @@ class UnitOfWork implements PropertyChangedListener
      */
     public function tryGetByIdHash($idHash, $rootClassName)
     {
+        if (! is_string($idHash)) {
+            $idHash = (string) $idHash;
+        }
+
         if (isset($this->identityMap[$rootClassName][$idHash])) {
             return $this->identityMap[$rootClassName][$idHash];
         }
@@ -2938,6 +2942,10 @@ class UnitOfWork implements PropertyChangedListener
     {
         $idHash = implode(' ', (array) $id);
 
+        if (! is_string($idHash)) {
+            $idHash = (string) $idHash;
+        }
+
         if (isset($this->identityMap[$rootClassName][$idHash])) {
             return $this->identityMap[$rootClassName][$idHash];
         }

From 1b850fbb2358c2f87b5ab860a5588e9c22d47c45 Mon Sep 17 00:00:00 2001
From: Stefano Torresi <stefano@torresi.io>
Date: Tue, 17 Mar 2015 18:16:47 +0100
Subject: [PATCH 03/11] add missing return statement

---
 tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php b/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
index c24c11354..ff7bcd6fa 100644
--- a/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
+++ b/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
@@ -30,13 +30,12 @@ class CustomIdObjectType extends Type
         return $idObject;
     }
 
-
     /**
      * {@inheritdoc}
      */
     public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
     {
-        $platform->getVarcharTypeDeclarationSQL($fieldDeclaration);
+        return $platform->getVarcharTypeDeclarationSQL($fieldDeclaration);
     }
 
     /**

From c7ad932b5f2a9b515eaee34987a8891eab6f4d8e Mon Sep 17 00:00:00 2001
From: Stefano Torresi <stefano@torresi.io>
Date: Tue, 17 Mar 2015 18:23:47 +0100
Subject: [PATCH 04/11] fix copyright notices

---
 .../Tests/DbalTypes/CustomIdObject.php        | 20 +++++++++++++++----
 .../Tests/DbalTypes/CustomIdObjectType.php    | 20 +++++++++++++++----
 .../CustomType/CustomIdObjectTypeChild.php    | 20 +++++++++++++++----
 .../CustomType/CustomIdObjectTypeParent.php   | 20 +++++++++++++++----
 .../ORM/Functional/CustomIdObjectTypeTest.php | 20 +++++++++++++++----
 5 files changed, 80 insertions(+), 20 deletions(-)

diff --git a/tests/Doctrine/Tests/DbalTypes/CustomIdObject.php b/tests/Doctrine/Tests/DbalTypes/CustomIdObject.php
index 72d259d54..df34ebccb 100644
--- a/tests/Doctrine/Tests/DbalTypes/CustomIdObject.php
+++ b/tests/Doctrine/Tests/DbalTypes/CustomIdObject.php
@@ -1,8 +1,20 @@
 <?php
-/**
- * @author Stefano Torresi (http://stefanotorresi.it)
- * @license See the file LICENSE.txt for copying permission.
- * ************************************************
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
  */
 
 namespace Doctrine\Tests\DbalTypes;
diff --git a/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php b/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
index ff7bcd6fa..8c639e7ac 100644
--- a/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
+++ b/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
@@ -1,8 +1,20 @@
 <?php
-/**
- * @author Stefano Torresi (http://stefanotorresi.it)
- * @license See the file LICENSE.txt for copying permission.
- * ************************************************
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
  */
 
 namespace Doctrine\Tests\DbalTypes;
diff --git a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
index a14759e87..df16ba9f1 100644
--- a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
+++ b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
@@ -1,8 +1,20 @@
 <?php
-/**
- * @author Stefano Torresi (http://stefanotorresi.it)
- * @license See the file LICENSE.txt for copying permission.
- * ************************************************
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
  */
 
 namespace Doctrine\Tests\Models\CustomType;
diff --git a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
index d5e00db9a..e0ae65a01 100644
--- a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
+++ b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
@@ -1,8 +1,20 @@
 <?php
-/**
- * @author Stefano Torresi (http://stefanotorresi.it)
- * @license See the file LICENSE.txt for copying permission.
- * ************************************************
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
  */
 
 namespace Doctrine\Tests\Models\CustomType;
diff --git a/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
index 3b7276ad8..d78fb8775 100644
--- a/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
+++ b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
@@ -1,8 +1,20 @@
 <?php
-/**
- * @author Stefano Torresi (http://stefanotorresi.it)
- * @license See the file LICENSE.txt for copying permission.
- * ************************************************
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
  */
 
 namespace Doctrine\Tests\ORM\Functional;

From 904bcfa4f94ac333da6bb9fe92fe1359288d65a7 Mon Sep 17 00:00:00 2001
From: Stefano Torresi <stefano@torresi.io>
Date: Tue, 17 Mar 2015 19:36:11 +0100
Subject: [PATCH 05/11] add docs notice about custom object types as IDs

---
 docs/en/cookbook/custom-mapping-types.rst | 28 ++++++++++++++---------
 1 file changed, 17 insertions(+), 11 deletions(-)

diff --git a/docs/en/cookbook/custom-mapping-types.rst b/docs/en/cookbook/custom-mapping-types.rst
index 27ada30ee..1bd4f1242 100644
--- a/docs/en/cookbook/custom-mapping-types.rst
+++ b/docs/en/cookbook/custom-mapping-types.rst
@@ -13,44 +13,50 @@ you wish. Here is an example skeleton of such a custom type class:
 
     <?php
     namespace My\Project\Types;
-    
+
     use Doctrine\DBAL\Types\Type;
     use Doctrine\DBAL\Platforms\AbstractPlatform;
-    
+
     /**
      * My custom datatype.
      */
     class MyType extends Type
     {
         const MYTYPE = 'mytype'; // modify to match your type name
-    
+
         public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
         {
             // return the SQL used to create your column type. To create a portable column type, use the $platform.
         }
-    
+
         public function convertToPHPValue($value, AbstractPlatform $platform)
         {
             // This is executed when the value is read from the database. Make your conversions here, optionally using the $platform.
         }
-    
+
         public function convertToDatabaseValue($value, AbstractPlatform $platform)
         {
             // This is executed when the value is written to the database. Make your conversions here, optionally using the $platform.
         }
-    
+
         public function getName()
         {
             return self::MYTYPE; // modify to match your constant name
         }
     }
 
-The following assumptions are applied to mapping types by the ORM:
+.. note::
 
--  If the value of the field is *NULL* the method
-   ``convertToDatabaseValue()`` is not called.
--  The ``UnitOfWork`` never passes values to the database convert
-   method that did not change in the request.
+    The following assumptions are applied to mapping types by the ORM:
+
+    -  If the value of the field is *NULL* the method
+       ``convertToDatabaseValue()`` is not called.
+    -  The ``UnitOfWork`` never passes values to the database convert
+       method that did not change in the request.
+    -  The ``UnitOfWork`` internally assumes that entity identifiers are
+       castable to string. Hence, when using custom types that map to PHP
+       objects as IDs, such objects must implement the ``__toString()`` magic
+       method.
 
 When you have implemented the type you still need to let Doctrine
 know about it. This can be achieved through the

From 5d6a39d14c054456e3826985130ef352aa238f35 Mon Sep 17 00:00:00 2001
From: Stefano Torresi <stefano@torresi.io>
Date: Tue, 17 Mar 2015 19:43:13 +0100
Subject: [PATCH 06/11] fix tests tear down

---
 tests/Doctrine/Tests/OrmFunctionalTestCase.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/Doctrine/Tests/OrmFunctionalTestCase.php b/tests/Doctrine/Tests/OrmFunctionalTestCase.php
index 48f9bbdb3..ae9f4b43b 100644
--- a/tests/Doctrine/Tests/OrmFunctionalTestCase.php
+++ b/tests/Doctrine/Tests/OrmFunctionalTestCase.php
@@ -501,8 +501,8 @@ abstract class OrmFunctionalTestCase extends OrmTestCase
         }
 
         if (isset($this->_usedModelSets['custom_id_object_type'])) {
-            $conn->executeUpdate('DELETE FROM custom_id_type_parent');
             $conn->executeUpdate('DELETE FROM custom_id_type_child');
+            $conn->executeUpdate('DELETE FROM custom_id_type_parent');
         }
 
         $this->_em->clear();

From d6687e070e05922c41bb01caed53ef1b15c60c2e Mon Sep 17 00:00:00 2001
From: Marco Pivetta <ocramius@gmail.com>
Date: Tue, 17 Mar 2015 21:11:43 +0000
Subject: [PATCH 07/11] #1333 - Removing useless `is_string()` function call,
 clarifying docblock parameters

---
 lib/Doctrine/ORM/UnitOfWork.php | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

diff --git a/lib/Doctrine/ORM/UnitOfWork.php b/lib/Doctrine/ORM/UnitOfWork.php
index 3e19e53af..53596a671 100644
--- a/lib/Doctrine/ORM/UnitOfWork.php
+++ b/lib/Doctrine/ORM/UnitOfWork.php
@@ -1566,19 +1566,17 @@ class UnitOfWork implements PropertyChangedListener
      *
      * @ignore
      *
-     * @param string $idHash
+     * @param mixed  $idHash        (must be possible to cast it to string)
      * @param string $rootClassName
      *
      * @return object|bool The found entity or FALSE.
      */
     public function tryGetByIdHash($idHash, $rootClassName)
     {
-        if (! is_string($idHash)) {
-            $idHash = (string) $idHash;
-        }
+        $stringIdHash = (string) $idHash;
 
-        if (isset($this->identityMap[$rootClassName][$idHash])) {
-            return $this->identityMap[$rootClassName][$idHash];
+        if (isset($this->identityMap[$rootClassName][$stringIdHash])) {
+            return $this->identityMap[$rootClassName][$stringIdHash];
         }
 
         return false;

From 40c41857e836ccab032f897733c1a323c760dbeb Mon Sep 17 00:00:00 2001
From: Marco Pivetta <ocramius@gmail.com>
Date: Tue, 17 Mar 2015 21:12:20 +0000
Subject: [PATCH 08/11] #1333 - Removing unused `is_string()` function call and
 cast (always a string)

---
 lib/Doctrine/ORM/UnitOfWork.php | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/lib/Doctrine/ORM/UnitOfWork.php b/lib/Doctrine/ORM/UnitOfWork.php
index 53596a671..80915155d 100644
--- a/lib/Doctrine/ORM/UnitOfWork.php
+++ b/lib/Doctrine/ORM/UnitOfWork.php
@@ -2940,10 +2940,6 @@ class UnitOfWork implements PropertyChangedListener
     {
         $idHash = implode(' ', (array) $id);
 
-        if (! is_string($idHash)) {
-            $idHash = (string) $idHash;
-        }
-
         if (isset($this->identityMap[$rootClassName][$idHash])) {
             return $this->identityMap[$rootClassName][$idHash];
         }

From 11da06066854ed00d3539e5d02b7564d773dd0eb Mon Sep 17 00:00:00 2001
From: Marco Pivetta <ocramius@gmail.com>
Date: Tue, 17 Mar 2015 21:21:20 +0000
Subject: [PATCH 09/11] #1336 - class constants over string references in tests
 - removing useless QueryBuilder usage

---
 .../Tests/DbalTypes/CustomIdObjectType.php    |  5 +-
 .../CustomType/CustomIdObjectTypeChild.php    |  2 +
 .../CustomType/CustomIdObjectTypeParent.php   |  2 +
 .../ORM/Functional/CustomIdObjectTypeTest.php | 51 ++++++++++---------
 4 files changed, 35 insertions(+), 25 deletions(-)

diff --git a/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php b/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
index 8c639e7ac..3d5aa0c19 100644
--- a/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
+++ b/tests/Doctrine/Tests/DbalTypes/CustomIdObjectType.php
@@ -24,6 +24,9 @@ use Doctrine\DBAL\Types\Type;
 
 class CustomIdObjectType extends Type
 {
+    const NAME      = 'CustomIdObject';
+    const CLASSNAME = __CLASS__;
+
     /**
      * {@inheritdoc}
      */
@@ -55,6 +58,6 @@ class CustomIdObjectType extends Type
      */
     public function getName()
     {
-        return 'CustomIdObject';
+        return self::NAME;
     }
 }
diff --git a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
index df16ba9f1..0f0113d57 100644
--- a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
+++ b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
@@ -27,6 +27,8 @@ use Doctrine\Tests\DbalTypes\CustomIdObject;
  */
 class CustomIdObjectTypeChild
 {
+    const CLASSNAME = __CLASS__;
+
     /**
      * @Id @Column(type="CustomIdObject")
      *
diff --git a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
index e0ae65a01..02bebc475 100644
--- a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
+++ b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
@@ -28,6 +28,8 @@ use Doctrine\Common\Collections\ArrayCollection;
  */
 class CustomIdObjectTypeParent
 {
+    const CLASSNAME = __CLASS__;
+
     /**
      * @Id @Column(type="CustomIdObject")
      *
diff --git a/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
index d78fb8775..47fafcac2 100644
--- a/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
+++ b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
@@ -19,6 +19,7 @@
 
 namespace Doctrine\Tests\ORM\Functional;
 
+use Doctrine\Tests\DbalTypes\CustomIdObjectType;
 use Doctrine\Tests\Models\CustomType\CustomIdObjectTypeChild;
 use Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent;
 use Doctrine\Tests\OrmFunctionalTestCase;
@@ -28,13 +29,14 @@ class CustomIdObjectTypeTest extends OrmFunctionalTestCase
 {
     protected function setUp()
     {
-        if (DBALType::hasType('CustomIdObject')) {
-            DBALType::overrideType('CustomIdObject', '\Doctrine\Tests\DbalTypes\CustomIdObjectType');
+        if (DBALType::hasType(CustomIdObjectType::NAME)) {
+            DBALType::overrideType(CustomIdObjectType::NAME, CustomIdObjectType::CLASSNAME);
         } else {
-            DBALType::addType('CustomIdObject', '\Doctrine\Tests\DbalTypes\CustomIdObjectType');
+            DBALType::addType(CustomIdObjectType::NAME, CustomIdObjectType::CLASSNAME);
         }
 
         $this->useModelSet('custom_id_object_type');
+
         parent::setUp();
     }
 
@@ -45,7 +47,7 @@ class CustomIdObjectTypeTest extends OrmFunctionalTestCase
         $this->_em->persist($parent);
         $this->_em->flush();
 
-        $result = $this->_em->find('Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent', $parent->id);
+        $result = $this->_em->find(CustomIdObjectTypeParent::CLASSNAME, $parent->id);
 
         $this->assertSame($parent, $result);
     }
@@ -53,20 +55,20 @@ class CustomIdObjectTypeTest extends OrmFunctionalTestCase
     public function testFetchJoinCustomIdObject()
     {
         $parent = new CustomIdObjectTypeParent('foo');
+
         $parent->children->add(new CustomIdObjectTypeChild('bar', $parent));
 
         $this->_em->persist($parent);
         $this->_em->flush();
 
-        $qb = $this->_em->createQueryBuilder();
-        $qb
-            ->select('parent')
-            ->from('Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent', 'parent')
-            ->addSelect('children')
-            ->leftJoin('parent.children', 'children')
-        ;
-
-        $result = $qb->getQuery()->getResult();
+        $result = $this
+            ->_em
+            ->createQuery(
+                'SELECT parent, children FROM '
+                . CustomIdObjectTypeParent::CLASSNAME
+                . ' parent LEFT JOIN parent.children children'
+            )
+            ->getResult();
 
         $this->assertCount(1, $result);
         $this->assertSame($parent, $result[0]);
@@ -75,22 +77,23 @@ class CustomIdObjectTypeTest extends OrmFunctionalTestCase
     public function testFetchJoinWhereCustomIdObject()
     {
         $parent = new CustomIdObjectTypeParent('foo');
+
         $parent->children->add(new CustomIdObjectTypeChild('bar', $parent));
 
         $this->_em->persist($parent);
         $this->_em->flush();
 
-        $qb = $this->_em->createQueryBuilder();
-        $qb
-            ->select('parent')
-            ->from('Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent', 'parent')
-            ->addSelect('children')
-            ->leftJoin('parent.children', 'children')
-            ->where('children.id = ?1')
-            ->setParameter(1, $parent->children->first()->id);
-        ;
-
-        $result = $qb->getQuery()->getResult();
+        // note: hydration is willingly broken in this example:
+        $result = $this
+            ->_em
+            ->createQuery(
+                'SELECT parent, children FROM '
+                . CustomIdObjectTypeParent::CLASSNAME
+                . ' parent LEFT JOIN parent.children children '
+                . 'WHERE children.id = ?1'
+            )
+            ->setParameter(1, $parent->children->first()->id)
+            ->getResult();
 
         $this->assertCount(1, $result);
         $this->assertSame($parent, $result[0]);

From 712b6a7a64341856adf2cc02b5a1888dfbab7b3b Mon Sep 17 00:00:00 2001
From: Marco Pivetta <ocramius@gmail.com>
Date: Tue, 17 Mar 2015 21:23:16 +0000
Subject: [PATCH 10/11] #1336 DDC-3622 - adding `@group` annotations for newly
 introduced tests

---
 .../Tests/ORM/Functional/CustomIdObjectTypeTest.php       | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
index 47fafcac2..9617644a9 100644
--- a/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
+++ b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
@@ -52,6 +52,10 @@ class CustomIdObjectTypeTest extends OrmFunctionalTestCase
         $this->assertSame($parent, $result);
     }
 
+    /**
+     * @group DDC-3622
+     * @group 1336
+     */
     public function testFetchJoinCustomIdObject()
     {
         $parent = new CustomIdObjectTypeParent('foo');
@@ -74,6 +78,10 @@ class CustomIdObjectTypeTest extends OrmFunctionalTestCase
         $this->assertSame($parent, $result[0]);
     }
 
+    /**
+     * @group DDC-3622
+     * @group 1336
+     */
     public function testFetchJoinWhereCustomIdObject()
     {
         $parent = new CustomIdObjectTypeParent('foo');

From 5c89bb8c6bb8b559a4a9debe6ba13cdaffe07345 Mon Sep 17 00:00:00 2001
From: Marco Pivetta <ocramius@gmail.com>
Date: Tue, 17 Mar 2015 21:29:30 +0000
Subject: [PATCH 11/11] #1336 DDC-3622 - removing implicit cast from `string`
 to `CustomIdObject` in entity API (confusing)

---
 .../Models/CustomType/CustomIdObjectTypeChild.php     |  8 ++------
 .../Models/CustomType/CustomIdObjectTypeParent.php    |  8 ++------
 .../Tests/ORM/Functional/CustomIdObjectTypeTest.php   | 11 ++++++-----
 3 files changed, 10 insertions(+), 17 deletions(-)

diff --git a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
index 0f0113d57..028a55c25 100644
--- a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
+++ b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeChild.php
@@ -42,15 +42,11 @@ class CustomIdObjectTypeChild
     public $parent;
 
     /**
-     * @param CustomIdObject|string    $id
+     * @param CustomIdObject           $id
      * @param CustomIdObjectTypeParent $parent
      */
-    public function __construct($id, CustomIdObjectTypeParent $parent)
+    public function __construct(CustomIdObject $id, CustomIdObjectTypeParent $parent)
     {
-        if (! $id instanceof CustomIdObject) {
-            $id = new CustomIdObject($id);
-        }
-
         $this->id     = $id;
         $this->parent = $parent;
     }
diff --git a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
index 02bebc475..3045c647b 100644
--- a/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
+++ b/tests/Doctrine/Tests/Models/CustomType/CustomIdObjectTypeParent.php
@@ -43,14 +43,10 @@ class CustomIdObjectTypeParent
     public $children;
 
     /**
-     * @param CustomIdObject|string $id
+     * @param CustomIdObject $id
      */
-    public function __construct($id)
+    public function __construct(CustomIdObject $id)
     {
-        if (! $id instanceof CustomIdObject) {
-            $id = new CustomIdObject($id);
-        }
-
         $this->id       = $id;
         $this->children = new ArrayCollection();
     }
diff --git a/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
index 9617644a9..2e7abf76c 100644
--- a/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
+++ b/tests/Doctrine/Tests/ORM/Functional/CustomIdObjectTypeTest.php
@@ -19,6 +19,7 @@
 
 namespace Doctrine\Tests\ORM\Functional;
 
+use Doctrine\Tests\DbalTypes\CustomIdObject;
 use Doctrine\Tests\DbalTypes\CustomIdObjectType;
 use Doctrine\Tests\Models\CustomType\CustomIdObjectTypeChild;
 use Doctrine\Tests\Models\CustomType\CustomIdObjectTypeParent;
@@ -42,7 +43,7 @@ class CustomIdObjectTypeTest extends OrmFunctionalTestCase
 
     public function testFindByCustomIdObject()
     {
-        $parent = new CustomIdObjectTypeParent('foo');
+        $parent = new CustomIdObjectTypeParent(new CustomIdObject('foo'));
 
         $this->_em->persist($parent);
         $this->_em->flush();
@@ -58,9 +59,9 @@ class CustomIdObjectTypeTest extends OrmFunctionalTestCase
      */
     public function testFetchJoinCustomIdObject()
     {
-        $parent = new CustomIdObjectTypeParent('foo');
+        $parent = new CustomIdObjectTypeParent(new CustomIdObject('foo'));
 
-        $parent->children->add(new CustomIdObjectTypeChild('bar', $parent));
+        $parent->children->add(new CustomIdObjectTypeChild(new CustomIdObject('bar'), $parent));
 
         $this->_em->persist($parent);
         $this->_em->flush();
@@ -84,9 +85,9 @@ class CustomIdObjectTypeTest extends OrmFunctionalTestCase
      */
     public function testFetchJoinWhereCustomIdObject()
     {
-        $parent = new CustomIdObjectTypeParent('foo');
+        $parent = new CustomIdObjectTypeParent(new CustomIdObject('foo'));
 
-        $parent->children->add(new CustomIdObjectTypeChild('bar', $parent));
+        $parent->children->add(new CustomIdObjectTypeChild(new CustomIdObject('bar'), $parent));
 
         $this->_em->persist($parent);
         $this->_em->flush();