[TwigBridge] Add #[Template()] to describe how to render arrays returned by controllers

Author: nicolas-grekas

Event/ControllerArgumentsEvent.php

@@ -30,6 +30,7 @@ final class ControllerArgumentsEvent extends KernelEvent
 {
     private ControllerEvent $controllerEvent;
     private array $arguments;
+    private array $namedArguments;
 
     public function __construct(HttpKernelInterface $kernel, callable|ControllerEvent $controller, array $arguments, Request $request, ?int $requestType)
     {
@@ -54,6 +55,7 @@ public function getController(): callable
     public function setController(callable $controller, array $attributes = null): void
     {
         $this->controllerEvent->setController($controller, $attributes);
+        unset($this->namedArguments);
     }
 
     public function getArguments(): array
@@ -64,6 +66,32 @@ public function getArguments(): array
     public function setArguments(array $arguments)
     {
         $this->arguments = $arguments;
+        unset($this->namedArguments);
+    }
+
+    public function getNamedArguments(): array
+    {
+        if (isset($this->namedArguments)) {
+            return $this->namedArguments;
+        }
+
+        $namedArguments = [];
+        $arguments = $this->arguments;
+        $r = $this->getRequest()->attributes->get('_controller_reflectors')[1] ?? new \ReflectionFunction($this->controllerEvent->getController());
+
+        foreach ($r->getParameters() as $i => $param) {
+            if ($param->isVariadic()) {
+                $namedArguments[$param->name] = \array_slice($arguments, $i);
+                break;
+            }
+            if (\array_key_exists($i, $arguments)) {
+                $namedArguments[$param->name] = $arguments[$i];
+            } elseif ($param->isDefaultvalueAvailable()) {
+                $namedArguments[$param->name] = $param->getDefaultValue();
+            }
+        }
+
+        return $this->namedArguments = $namedArguments;
     }
 
     /**

Event/ViewEvent.php

@@ -25,13 +25,15 @@
  */
 final class ViewEvent extends RequestEvent
 {
+    public readonly ?ControllerArgumentsEvent $controllerArgumentsEvent;
     private mixed $controllerResult;
 
-    public function __construct(HttpKernelInterface $kernel, Request $request, int $requestType, mixed $controllerResult)
+    public function __construct(HttpKernelInterface $kernel, Request $request, int $requestType, mixed $controllerResult, ControllerArgumentsEvent $controllerArgumentsEvent = null)
     {
         parent::__construct($kernel, $request, $requestType);
 
         $this->controllerResult = $controllerResult;
+        $this->controllerArgumentsEvent = $controllerArgumentsEvent;
     }
 
     public function getControllerResult(): mixed

HttpKernel.php

@@ -156,14 +156,13 @@ private function handleRaw(Request $request, int $type = self::MAIN_REQUEST): Re
         $this->dispatcher->dispatch($event, KernelEvents::CONTROLLER_ARGUMENTS);
         $controller = $event->getController();
         $arguments = $event->getArguments();
-        $request->attributes->remove('_controller_reflectors');
 
         // call controller
         $response = $controller(...$arguments);
 
         // view
         if (!$response instanceof Response) {
-            $event = new ViewEvent($this, $request, $type, $response);
+            $event = new ViewEvent($this, $request, $type, $response, $event);
             $this->dispatcher->dispatch($event, KernelEvents::VIEW);
 
             if ($event->hasResponse()) {
@@ -179,6 +178,7 @@ private function handleRaw(Request $request, int $type = self::MAIN_REQUEST): Re
                 throw new ControllerDoesNotReturnResponseException($msg, $controller, __FILE__, __LINE__ - 17);
             }
         }
+        $request->attributes->remove('_controller_reflectors');
 
         return $this->filterResponse($response, $request, $type);
     }