Configuration to turn off copying of default variables

Author: merk

Controller/Annotations/View.php

@@ -35,6 +35,11 @@ class View extends Template
      */
     protected $serializerGroups;
 
+    /**
+     * @var Boolean
+     */
+    protected $populateDefaultVars = true;
+
     /**
      * Returns the annotation alias name.
      *
@@ -97,4 +102,20 @@ public function getSerializerGroups()
     {
         return $this->serializerGroups;
     }
+
+    /**
+     * @param Boolean $populateDefaultVars
+     */
+    public function setPopulateDefaultVars($populateDefaultVars)
+    {
+        $this->populateDefaultVars = (Boolean) $populateDefaultVars;
+    }
+
+    /**
+     * @return Boolean
+     */
+    public function isPopulateDefaultVars()
+    {
+        return $this->populateDefaultVars;
+    }
 }

EventListener/ViewResponseListener.php

@@ -96,14 +96,17 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
                 $context->setGroups($configuration->getSerializerGroups());
                 $view->setSerializationContext($context);
             }
+            $fillDefaultTemplateVars = $configuration->isPopulateDefaultVars();
+        } else {
+            $fillDefaultTemplateVars = true;
         }
 
         if (null === $view->getFormat()) {
             $view->setFormat($request->getRequestFormat());
         }
 
         $vars = $request->attributes->get('_template_vars');
-        if (!$vars) {
+        if (!$vars && $fillDefaultTemplateVars) {
             $vars = $request->attributes->get('_template_default_vars');
         }
 

Resources/doc/3-listener-support.md

@@ -144,6 +144,24 @@ public function getUsersAction()
 See the following example code for more details:
 https://github.com/liip/LiipHelloBundle/blob/master/Controller/ExtraController.php
 
+The ViewResponse listener will automatically populate your view with request attributes if
+you do not provide any data when returning a view object. This behaviour comes from
+SensioFrameworkExtraBundle and will automatically add any variables listed in the
+`_template_default_vars` request attribute when no data is supplied. In some cases, this
+is not desirable and can be disabled by either supplying the data you want or disabling
+the automatic population of data with the @View annotation. :
+
+```php
+/**
+ * $user will no longer end up in the View's data.
+ *
+ * @View(populateDefaultVars=false)
+ */
+public function getUserDetails(User $user)
+{
+}
+```
+
 ### Body listener
 
 The Request body decoding listener makes it possible to decode the contents of
@@ -195,7 +213,7 @@ fos_rest:
 ```
 
 Note: You will probably want to disable the automatic route generation (`@NoRoute`)
-for routes using the body converter, and instead define the routes manually to 
+for routes using the body converter, and instead define the routes manually to
 avoid having the deserialized, typehinted objects (`$post in this example`) appear
 in the route as a parameter.
 

Tests/EventListener/ViewResponseListenerTest.php

@@ -232,13 +232,14 @@ public function testStatusCode($annotationCode, $viewCode, $expectedCode)
         $this->viewHandler->setContainer($this->container);
 
         // This is why we avoid container dependencies!
+        $that = $this;
         $this->container->expects($this->exactly(2))
             ->method('get')
             ->with($this->logicalOr('fos_rest.view_handler', 'fos_rest.templating'))
-            ->will($this->returnCallback(function ($service) {
+            ->will($this->returnCallback(function ($service) use ($that) {
                 return $service === 'fos_rest.view_handler' ?
-                    $this->viewHandler :
-                    $this->templating;
+                    $that->viewHandler :
+                    $that->templating;
             }));
 
         $this->templating->expects($this->any())
@@ -264,6 +265,58 @@ public function testStatusCode($annotationCode, $viewCode, $expectedCode)
         $this->assertSame($expectedCode, $response->getStatusCode());
     }
 
+    public function getDataForDefaultVarsCopy()
+    {
+        return array(
+            array(true, false, false),
+            array(true, true, true),
+            array(false, null, true)
+        );
+    }
+
+    /**
+     * @dataProvider getDataForDefaultVarsCopy
+     */
+    public function testViewWithNoCopyDefaultVars($createAnnotation, $populateDefaultVars, $shouldCopy)
+    {
+        $request = new Request();
+        $request->attributes->set('_template_default_vars', array('customer'));
+        $request->attributes->set('customer', 'A person goes here');
+        $view = View::create();
+
+        if ($createAnnotation) {
+            $viewAnnotation = new ViewAnnotation(array());
+            $viewAnnotation->setPopulateDefaultVars($populateDefaultVars);
+            $request->attributes->set('_view', $viewAnnotation);
+        }
+
+        $event = $this->getResponseEvent($request, $view);
+
+        $this->viewHandler = new ViewHandler(array('html' => true));
+        $this->viewHandler->setContainer($this->container);
+
+        // This is why we avoid container dependencies!
+        $that = $this;
+        $this->container->expects($this->exactly(2))
+            ->method('get')
+            ->with($this->logicalOr('fos_rest.view_handler', 'fos_rest.templating'))
+            ->will($this->returnCallback(function ($service) use ($that) {
+                return $service === 'fos_rest.view_handler' ?
+                    $that->viewHandler :
+                    $that->templating;
+            }));
+
+        $this->listener->onKernelView($event);
+
+        $data = $view->getData();
+        if ($shouldCopy) {
+            $this->assertArrayHasKey('customer', $data);
+            $this->assertEquals('A person goes here', $data['customer']);
+        } else {
+            $this->assertNull($data);
+        }
+    }
+
     protected function setUp()
     {
         $this->viewHandler = $this->getMock('FOS\RestBundle\View\ViewHandlerInterface');