Merge pull request #576 from merk/fill-default-template-vars

[Proposal] Configuration to disable copying of default template variables

Author: lsmith77

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

@@ -72,6 +72,7 @@ public function onKernelController(FilterControllerEvent $event)
     public function onKernelView(GetResponseForControllerResultEvent $event)
     {
         $request = $event->getRequest();
+        /** @var \FOS\RestBundle\Controller\Annotations\View $configuration */
         $configuration = $request->attributes->get('_view');
 
         $view = $event->getControllerResult();
@@ -95,14 +96,17 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
                 $context->setGroups($configuration->getSerializerGroups());
                 $view->setSerializationContext($context);
             }
+            $populateDefaultVars = $configuration->isPopulateDefaultVars();
+        } else {
+            $populateDefaultVars = true;
         }
 
         if (null === $view->getFormat()) {
             $view->setFormat($request->getRequestFormat());
         }
 
         $vars = $request->attributes->get('_template_vars');
-        if (!$vars) {
+        if (!$vars && $populateDefaultVars) {
             $vars = $request->attributes->get('_template_default_vars');
         }
 
@@ -133,4 +137,4 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
 
         $event->setResponse($response);
     }
-}
+}

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.