Merge pull request #6719 from Ocramius/cleanup/replace-proxy-factory

Replace proxy layer with ProxyManager's layer

Author: Ocramius

.gitignore

@@ -14,3 +14,5 @@ lib/Doctrine/DBAL
 vendor/
 composer.lock
 /tests/Doctrine/Performance/history.db
+phpbench.phar
+phpbench.phar.pubkey

UPGRADE.md

@@ -1,5 +1,49 @@
 # Upgrade to 3.0
 
+## BC Break: proxies no longer implement `Doctrine\ORM\Proxy\Proxy`
+
+Proxy objects no longer implement `Doctrine\ORM\Proxy\Proxy` nor
+`Doctrine\Common\Persistence\Proxy`: instead, they implement
+`ProxyManager\Proxy\GhostObjectInterface`.
+
+These related classes have been removed:
+
+ * `Doctrine\ORM\Proxy\ProxyFactory` - replaced by `Doctrine\ORM\Proxy\Factory\StaticProxyFacory`
+   and `Doctrine\ORM\Proxy\Factory\ProxyFactory`
+ * `Doctrine\ORM\Proxy\Proxy`
+ * `Doctrine\ORM\Proxy\Autoloader` - we suggest using the composer autoloader instead
+ * `Doctrine\ORM\Reflection\RuntimePublicReflectionProperty`
+ 
+These methods have been removed:
+
+ * `Doctrine\ORM\Configuration#getProxyDir()`
+ * `Doctrine\ORM\Configuration#getAutoGenerateProxyClasses()`
+ * `Doctrine\ORM\Configuration#getProxyNamespace()`
+
+Proxy class names change: the generated proxies now follow
+the [`ClassNameInflector`](https://github.com/Ocramius/ProxyManager/blob/2.1.1/src/ProxyManager/Inflector/ClassNameInflector.php)
+naming.
+
+Proxies are also always generated if not found: fatal errors due to missing
+proxy classes should no longer occur with ORM default settings.
+
+In addition to that, following changes affect entity lazy-loading semantics:
+
+ * `final` methods are now allowed
+ * `__clone` is no longer called by the ORM
+ * `__wakeup` is no longer called by the ORM
+ * `serialize($proxy)` will lead to full recursive proxy initialization: please mitigate
+   the recursive initialization by implementing
+   the [`Serializable`](https://secure.php.net/manual/en/class.serializable.php) interface
+ * `clone $proxy` will lead to full initialization of the cloned instance, not the
+   original instance
+ * lazy-loading a detached proxy no longer causes the proxy identifiers to be reset
+   to `null`
+ * identifier properties are always set when the ORM produces a proxy instance
+ * calling a method on a proxy no longer causes proxy lazy-loading if the method does
+   not access any un-initialized proxy state
+ * accessing entity private state, even with reflection, will trigger lazy-loading
+
 ## BC Break: Removed `Doctrine\ORM\Version`
 
 The `Doctrine\ORM\Version` class is no longer available: please refrain from checking the ORM version at runtime.

composer.json

@@ -23,6 +23,7 @@
         "doctrine/cache": "~1.6",
         "doctrine/annotations": "~1.4",
         "ocramius/package-versions": "^1.1.2",
+        "ocramius/proxy-manager": "^2.1.1",
         "symfony/console": "~3.0|~4.0"
     },
     "require-dev": {

docs/en/cookbook/implementing-wakeup-or-clone.rst

@@ -68,8 +68,6 @@ Customize it to your needs.
         $doctrineClassLoader->register();
         $entitiesClassLoader = new ClassLoader('models', rtrim(APPPATH, "/" ));
         $entitiesClassLoader->register();
-        $proxiesClassLoader = new ClassLoader('Proxies', APPPATH.'models/proxies');
-        $proxiesClassLoader->register();
     
         // Set up caches
         $config = new Configuration;
@@ -80,17 +78,13 @@ Customize it to your needs.
         $config->setQueryCacheImpl($cache);
 
         $config->setQueryCacheImpl($cache);
-    
-        // Proxy configuration
+
         $config->setProxyDir(APPPATH.'/models/proxies');
-        $config->setProxyNamespace('Proxies');
     
         // Set up logger
         $logger = new EchoSQLLogger;
         $config->setSQLLogger($logger);
     
-        $config->setAutoGenerateProxyClasses( TRUE );
-    
         // Database connection information
         $connectionOptions = array(
             'driver' => 'pdo_mysql',
@@ -108,7 +102,7 @@ Customize it to your needs.
 Please note that this is a development configuration; for a
 production system you'll want to use a real caching system like
 APC, get rid of EchoSqlLogger, and turn off
-autoGenerateProxyClasses.
+proxy auto-generation.
 
 For more details, consult the
 `Doctrine 2 Configuration documentation <http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/configuration.html>`_.

docs/en/cookbook/integrating-with-codeigniter.rst

@@ -112,7 +112,6 @@ Cookbook
 * **Implementation**:
   :doc:`Array Access <cookbook/implementing-arrayaccess-for-domain-objects>` |
   :doc:`Notify ChangeTracking Example <cookbook/implementing-the-notify-changetracking-policy>` |
-  :doc:`Using Wakeup Or Clone <cookbook/implementing-wakeup-or-clone>` |
   :doc:`Working with DateTime <cookbook/working-with-datetime>` |
   :doc:`Validation <cookbook/validation-of-entities>` |
   :doc:`Entities in the Session <cookbook/entities-in-session>` |