Use Doctrine Instantiator for ClassMetadata new instance creation

As mentioned in the changelog, __clone() methods will no longer be invoked. This is a BC break for code that might have relied upon that behavior.

Author: jmikola

CHANGELOG-1.0.md

@@ -15,6 +15,14 @@ To generate a changelog summary since the last version, run
 1.0.x-dev
 ---------
 
+#### `__clone()` method no longer called when documents are instantiated via `ClassMetadata::newInstance()`
+
+As of [#956](https://github.com/doctrine/mongodb-odm/pull/956), ClassMetadata
+uses the [Doctrine Instantiator](https://github.com/doctrine/instantiator)
+library to create new document instances. This library avoids calling
+`__clone()` or any public API on instantiated objects. This is a BC break for\
+code that may have relied upon the previous behavior.
+
 1.0.0-BETA11 (2014-06-06)
 -------------------------
 

composer.json

@@ -19,6 +19,7 @@
         "doctrine/common": "2.4.*",
         "doctrine/cache": "~1.0",
         "doctrine/inflector": "~1.0",
+        "doctrine/instantiator": "~1.0.1",
         "doctrine/mongodb": ">=1.1.5,<2.0"
     },
     "require-dev": {

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

@@ -19,6 +19,7 @@
 
 namespace Doctrine\ODM\MongoDB\Mapping;
 
+use Doctrine\Instantiator\Instantiator;
 use Doctrine\ODM\MongoDB\LockException;
 
 /**
@@ -49,11 +50,9 @@ class ClassMetadata extends ClassMetadataInfo
     public $reflFields = array();
 
     /**
-     * The prototype from which new instances of the mapped class are created.
-     *
-     * @var object
+     * @var \Doctrine\Instantiator\InstantiatorInterface|null
      */
-    private $prototype;
+    private $instantiator;
 
     /**
      * Initializes a new ClassMetadata instance that will hold the object-document mapping
@@ -67,6 +66,7 @@ public function __construct($documentName)
         $this->reflClass = new \ReflectionClass($documentName);
         $this->namespace = $this->reflClass->getNamespaceName();
         $this->setCollection($this->reflClass->getShortName());
+        $this->instantiator = new Instantiator();
     }
 
     /**
@@ -176,6 +176,7 @@ public function __wakeup()
     {
         // Restore ReflectionClass and properties
         $this->reflClass = new \ReflectionClass($this->name);
+        $this->instantiator = $this->instantiator ?: new Instantiator();
 
         foreach ($this->fieldMappings as $field => $mapping) {
             if (isset($mapping['declared'])) {
@@ -195,12 +196,6 @@ public function __wakeup()
      */
     public function newInstance()
     {
-        if ($this->prototype === null) {
-            $this->prototype = version_compare(PHP_VERSION, '5.4.0', '>=')
-                ? $this->reflClass->newInstanceWithoutConstructor()
-                : unserialize(sprintf('O:%d:"%s":0:{}', strlen($this->name), $this->name));
-        }
-
-        return clone $this->prototype;
+        return $this->instantiator->instantiate($this->name);
     }
 }