[HttpKernel] Deprecate passing objects as URI attributes to the ESI and SSI renderers

jakzal · jakzal · commit 9b18306ae5b3 · 2016-01-30T14:49:51.000+01:00
diff --git a/src/Symfony/Component/HttpKernel/Fragment/AbstractSurrogateFragmentRenderer.php b/src/Symfony/Component/HttpKernel/Fragment/AbstractSurrogateFragmentRenderer.php
@@ -64,6 +64,9 @@ public function __construct(SurrogateInterface $surrogate = null, FragmentRender
     public function render($uri, Request $request, array $options = array())
     {
         if (!$this->surrogate || !$this->surrogate->hasSurrogateCapability($request)) {
+            if ($uri instanceof ControllerReference && $this->containsNonScalars($uri->attributes)) {
+                @trigger_error('Passing objects as part of URI attributes to the ESI and SSI rendering strategies is deprecated. Use another rendering strategy or use scalar values.', E_USER_DEPRECATED);
+            }
             return $this->inlineStrategy->render($uri, $request, $options);
         }
 
@@ -92,4 +95,17 @@ private function generateSignedFragmentUri($uri, Request $request)
 
         return substr($fragmentUri, strlen($request->getSchemeAndHttpHost()));
     }
+
+    private function containsNonScalars(array $values)
+    {
+        foreach ($values as $key => $value) {
+            if (is_array($value)) {
+                return $this->containsNonScalars($value);
+            } elseif (!is_scalar($value) && null !== $value) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Fragment/EsiFragmentRendererTest.php b/src/Symfony/Component/HttpKernel/Tests/Fragment/EsiFragmentRendererTest.php
@@ -25,6 +25,32 @@ public function testRenderFallbackToInlineStrategyIfEsiNotSupported()
         $strategy->render('/', Request::create('/'));
     }
 
+    /**
+     * @group legacy
+     */
+    public function testRenderFallbackWithObjectAttributesIsDeprecated()
+    {
+        $deprecations = array();
+        set_error_handler(function ($type, $message) use (&$deprecations) {
+            if (E_USER_DEPRECATED === $type) {
+                $deprecations[] = $message;
+            }
+        });
+
+        $strategy = new EsiFragmentRenderer(new Esi(), $this->getInlineStrategy(true), new UriSigner('foo'));
+
+        $request = Request::create('/');
+
+        $reference = new ControllerReference('main_controller', array('foo' => new \stdClass()), array());
+
+        $strategy->render($reference, $request);
+
+        $this->assertCount(1, $deprecations);
+        $this->assertContains('Passing objects as part of URI attributes to the ESI and SSI rendering strategies is deprecated', $deprecations[0]);
+
+        restore_error_handler();
+    }
+
     public function testRender()
     {
         $strategy = new EsiFragmentRenderer(new Esi(), $this->getInlineStrategy());
