minor #20411 update controller return value (Florian-Merle)

javiereguiluz · javiereguiluz · commit 6b7528737bc1 · 2024-11-26T17:49:08.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- update controller return value A controller is not required to return a `Response` object anymore. Commits ------- 42b4c95 update controller return value doc
diff --git a/controller.rst b/controller.rst
@@ -447,7 +447,7 @@ and provides methods for getting and setting response headers. The header names
 normalized. As a result, the name ``Content-Type`` is equivalent to
 the name ``content-type`` or ``content_type``.
 
-In Symfony, a controller is required to return a ``Response`` object::
+In Symfony, a controller usually returns a ``Response`` object::
 
     use Symfony\Component\HttpFoundation\Response;
 
@@ -463,6 +463,14 @@ response types.  Some of these are mentioned below. To learn more about the
 ``Request`` and ``Response`` (and different ``Response`` classes), see the
 :ref:`HttpFoundation component documentation <component-http-foundation-request>`.
 
+.. note::
+
+    When a controller returns a non-``Response`` object, a ``kernel.view``
+    listener is expected to transform it into a ``Response`` object;
+    otherwise an exception is thrown.
+
+    See :ref:`kernel.view event <component-http-kernel-kernel-view>` for details on the ``kernel.view`` event.
+
 Accessing Configuration Values
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
