Fix the lazy PhpDumper

symfony · GuilhemN · Mar 14, 2016 · Mar 15, 2016 · Mar 16, 2016 · Mar 16, 2016
commit 795399a02bc68e404179c9f7ee7624715f1667b8
diff --git a/src/Symfony/Bridge/ProxyManager/LazyProxy/PhpDumper/ProxyDumper.php b/src/Symfony/Bridge/ProxyManager/LazyProxy/PhpDumper/ProxyDumper.php
@@ -71,7 +71,12 @@ public function getProxyFactoryCode(Definition $definition, $id)
             $instantiation .= " \$this->services['$id'] =";
         }
 
-        $methodName = 'get'.Container::camelize($id).'Service';
+        if (func_num_args() >= 3) {
+            $methodName = func_get_arg(2);
+        } else {
+            @trigger_error(sprintf('You must use the third argument of %s to define the method to call to construct your service since version 3.1, not using it won\'t be supported in 4.0.', __METHOD__), E_USER_DEPRECATED);
+            $methodName = 'get'.Container::camelize($id).'Service';
+        }
         $proxyClass = $this->getProxyClassName($definition);
 
         $generatedClass = $this->generateProxyClass($definition);

@@ -60,6 +60,27 @@ public function testGetProxyCode()
         );
     }
 
+    public function testGetProxyFactoryCodeWithCustomMethod()
+    {
+        $definition = new Definition(__CLASS__);
+
+        $definition->setLazy(true);
+
+        $code = $this->dumper->getProxyFactoryCode($definition, 'foo', 'getFoo2Service');
+
+        $this->assertStringMatchesFormat(
+            '%wif ($lazyLoad) {%wreturn $this->services[\'foo\'] =%s'
+            .'SymfonyBridgeProxyManagerTestsLazyProxyPhpDumperProxyDumperTest_%s(%wfunction '
+            .'(&$wrappedInstance, \ProxyManager\Proxy\LazyLoadingInterface $proxy) {'
+            .'%w$wrappedInstance = $this->getFoo2Service(false);%w$proxy->setProxyInitializer(null);'
+            .'%wreturn true;%w}%w);%w}%w',
+           $code
+        );
+    }
+
+    /**
+     * @group legacy
+     */
     public function testGetProxyFactoryCode()
     {
         $definition = new Definition(__CLASS__);

@@ -630,19 +630,20 @@ private function addService($id, $definition)
         // with proxies, for 5.3.3 compatibility, the getter must be public to be accessible to the initializer
         $isProxyCandidate = $this->getProxyDumper()->isProxyCandidate($definition);
         $visibility = $isProxyCandidate ? 'public' : 'protected';
+        $methodName = $this->generateMethodName($id);
         $code = <<<EOF
 
     /*{$this->docStar}
      * Gets the '$id' service.$doc
      *$lazyInitializationDoc
      * $return
      */
-    {$visibility} function {$this->generateMethodName($id)}($lazyInitialization)
+    {$visibility} function {$methodName}($lazyInitialization)
     {
 
 EOF;
 
-        $code .= $isProxyCandidate ? $this->getProxyDumper()->getProxyFactoryCode($definition, $id) : '';
+        $code .= $isProxyCandidate ? $this->getProxyDumper()->getProxyFactoryCode($definition, $id, $methodName) : '';
 
         if ($definition->isSynthetic()) {
             $code .= sprintf("        throw new RuntimeException('You have requested a synthetic service (\"%s\"). The DIC does not know how to construct this service.');\n    }\n", $id);

@@ -34,10 +34,11 @@ public function isProxyCandidate(Definition $definition);
      *
      * @param Definition $definition
      * @param string     $id         service identifier
+     * @param string     $methodName the method name to get the service, will be added to the interface in 4.0.
      *
      * @return string
      */
-    public function getProxyFactoryCode(Definition $definition, $id);
+    public function getProxyFactoryCode(Definition $definition, $id/**, $methodName = null */);
 
     /**
      * Generates the code for the lazy proxy.