[FrameworkBundle][Routing] Added new template and redirect routes configuration

Author: HeahDude

routing.rst

@@ -1292,7 +1292,8 @@ in the main article about Symfony templates.
 Redirecting to URLs and Routes Directly from a Route
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Use the ``RedirectController`` to redirect to other routes and URLs:
+Use the :class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\RedirectController`
+to redirect to other routes and URLs:
 
 .. configuration-block::
 
@@ -1301,28 +1302,27 @@ Use the ``RedirectController`` to redirect to other routes and URLs:
         # config/routes.yaml
         doc_shortcut:
             path: /doc
-            controller: Symfony\Bundle\FrameworkBundle\Controller\RedirectController
+            redirect_to_route: 'doc_page'
+
+            # redirections are temporary by default (code 302) but you can make them permanent (code 301)
+            permanent: true
+            # add this to keep the original query string parameters when redirecting
+            keepQueryParams: true
+            # add this to keep the HTTP method when redirecting. The redirect status changes
+            # * for temporary redirects, it uses the 307 status code instead of 302
+            # * for permanent redirects, it uses the 308 status code instead of 301
+            keepRequestMethod: true
+
+            # optionally you can define some arguments passed to the route
             defaults:
-                route: 'doc_page'
-                # optionally you can define some arguments passed to the route
                 page: 'index'
                 version: 'current'
-                # redirections are temporary by default (code 302) but you can make them permanent (code 301)
-                permanent: true
-                # add this to keep the original query string parameters when redirecting
-                keepQueryParams: true
-                # add this to keep the HTTP method when redirecting. The redirect status changes
-                # * for temporary redirects, it uses the 307 status code instead of 302
-                # * for permanent redirects, it uses the 308 status code instead of 301
-                keepRequestMethod: true
 
         legacy_doc:
             path: /legacy/doc
-            controller: Symfony\Bundle\FrameworkBundle\Controller\RedirectController
-            defaults:
-                # this value can be an absolute path or an absolute URL
-                path: 'https://legacy.example.com/doc'
-                permanent: true
+            # this value can be an absolute path or an absolute URL
+            redirect_to_url: 'https://legacy.example.com/doc'
+            permanent: true
 
     .. code-block:: xml
 
@@ -1333,68 +1333,71 @@ Use the ``RedirectController`` to redirect to other routes and URLs:
             xsi:schemaLocation="http://symfony.com/schema/routing
                 https://symfony.com/schema/routing/routing-1.0.xsd">
 
-            <route id="doc_shortcut" path="/doc"
-                   controller="Symfony\Bundle\FrameworkBundle\Controller\RedirectController">
-                <default key="route">doc_page</default>
+            <redirect-route id="doc_shortcut" path="/doc"
+                    redirect-to-route="doc_page"
+                    <!-- redirections are temporary by default (code 302) but you can make them permanent (code 301)-->
+                    permanent="true">
                 <!-- optionally you can define some arguments passed to the route -->
                 <default key="page">index</default>
                 <default key="version">current</default>
-                <!-- redirections are temporary by default (code 302) but you can make them permanent (code 301)-->
-                <default key="permanent">true</default>
                 <!-- add this to keep the original query string parameters when redirecting -->
                 <default key="keepQueryParams">true</default>
                 <!-- add this to keep the HTTP method when redirecting. The redirect status changes:
                      * for temporary redirects, it uses the 307 status code instead of 302
                      * for permanent redirects, it uses the 308 status code instead of 301 -->
                 <default key="keepRequestMethod">true</default>
-            </route>
+            </redirect-route>
 
-            <route id="legacy_doc" path="/legacy/doc"
-                   controller="Symfony\Bundle\FrameworkBundle\Controller\RedirectController">
+            <url-redirect-route id="legacy_doc" path="/legacy/doc"
                 <!-- this value can be an absolute path or an absolute URL -->
-                <default key="path">https://legacy.example.com/doc</default>
+                redirect-to-url="https://legacy.example.com/doc"
                 <!-- redirections are temporary by default (code 302) but you can make them permanent (code 301)-->
-                <default key="permanent">true</default>
-            </route>
+                permanent="true">
+            </url-redirect-route>
         </routes>
 
     .. code-block:: php
 
         // config/routes.php
         use App\Controller\DefaultController;
-        use Symfony\Bundle\FrameworkBundle\Controller\RedirectController;
         use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
 
         return function (RoutingConfigurator $routes) {
             $routes->add('doc_shortcut', '/doc')
-                ->controller(RedirectController::class)
-                 ->defaults([
-                    'route' => 'doc_page',
-                    // optionally you can define some arguments passed to the template
+                ->redirectToRoute('doc_page')
+
+                // redirections are temporary by default (code 302) but you can make them permanent (code 301)
+                ->permanent()
+
+                // add this to keep the original query string parameters when redirecting
+                ->keepQueryParams()
+
+                // add this to keep the HTTP method when redirecting. The redirect status changes:
+                // * for temporary redirects, it uses the 307 status code instead of 302
+                // * for permanent redirects, it uses the 308 status code instead of 301
+                ->keepRequestMethod()
+
+                // optionally you can define some arguments passed to the template
+                ->defaults([
                     'page' => 'index',
                     'version' => 'current',
-                    // redirections are temporary by default (code 302) but you can make them permanent (code 301)
-                    'permanent' => true,
-                    // add this to keep the original query string parameters when redirecting
-                    'keepQueryParams' => true,
-                    // add this to keep the HTTP method when redirecting. The redirect status changes:
-                    // * for temporary redirects, it uses the 307 status code instead of 302
-                    // * for permanent redirects, it uses the 308 status code instead of 301
-                    'keepRequestMethod' => true,
                 ])
             ;
 
             $routes->add('legacy_doc', '/legacy/doc')
-                ->controller(RedirectController::class)
-                 ->defaults([
-                    // this value can be an absolute path or an absolute URL
-                    'path' => 'https://legacy.example.com/doc',
-                    // redirections are temporary by default (code 302) but you can make them permanent (code 301)
-                    'permanent' => true,
-                ])
+                // this value can be an absolute path or an absolute URL
+                ->redirectToUrl('https://legacy.example.com/doc')
+
+                // redirections are temporary by default (code 302) but you can make them permanent (code 301)
+                ->permanent()
             ;
         };
 
+.. versionadded:: 5.1
+
+    This short syntax was introduced in Symfony 5.1. Before you had to
+    define the controller and specific route attributes using ``defaults``.
+
 .. tip::
 
     Symfony also provides some utilities to

templates.rst

@@ -457,8 +457,9 @@ Rendering a Template Directly from a Route
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Although templates are usually rendered in controllers and services, you can
-render static pages that don't need any variables directly from the route
-definition. Use the special ``TemplateController`` provided by Symfony:
+render static pages from the route definition. Use the special
+:class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\TemplateController`
+provided by Symfony:
 
 .. configuration-block::
 
@@ -467,19 +468,17 @@ definition. Use the special ``TemplateController`` provided by Symfony:
         # config/routes.yaml
         acme_privacy:
             path:          /privacy
-            controller:    Symfony\Bundle\FrameworkBundle\Controller\TemplateController
-            defaults:
-                # the path of the template to render
-                template:  'static/privacy.html.twig'
+            # the path of the template to render
+            template:  'static/privacy.html.twig'
 
-                # special options defined by Symfony to set the page cache
-                maxAge:    86400
-                sharedAge: 86400
+            # special options defined by Symfony to set the page cache
+            maxAge:    86400
+            sharedAge: 86400
 
-                # optionally you can define some arguments passed to the template
-                context:
-                    site_name: 'ACME'
-                    theme: 'dark'
+            # some variables passed to the template
+            context:
+                site_name: 'ACME'
+                theme: 'dark'
 
     .. code-block:: xml
 
@@ -489,50 +488,46 @@ definition. Use the special ``TemplateController`` provided by Symfony:
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://symfony.com/schema/routing https://symfony.com/schema/routing/routing-1.0.xsd">
 
-            <route id="acme_privacy"
+            <template-route id="acme_privacy"
                 path="/privacy"
-                controller="Symfony\Bundle\FrameworkBundle\Controller\TemplateController">
                 <!-- the path of the template to render -->
-                <default key="template">static/privacy.html.twig</default>
+                template="static/privacy.html.twig"
 
                 <!-- special options defined by Symfony to set the page cache -->
-                <default key="maxAge">86400</default>
-                <default key="sharedAge">86400</default>
+                maxAge="86400"
+                sharedMaxAge="86400">
 
-                <!-- optionally you can define some arguments passed to the template -->
+                <!-- some variables passed to the template -->
                 <default key="context">
                     <default key="site_name">ACME</default>
                     <default key="theme">dark</default>
                 </default>
-            </route>
+            </template-route>
         </routes>
 
     .. code-block:: php
 
         // config/routes.php
-        use Symfony\Bundle\FrameworkBundle\Controller\TemplateController;
         use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
 
         return function (RoutingConfigurator $routes) {
             $routes->add('acme_privacy', '/privacy')
-                ->controller(TemplateController::class)
-                ->defaults([
-                    // the path of the template to render
-                    'template'  => 'static/privacy.html.twig',
-
-                    // special options defined by Symfony to set the page cache
-                    'maxAge'    => 86400,
-                    'sharedAge' => 86400,
-
-                    // optionally you can define some arguments passed to the template
-                    'context' => [
-                        'site_name' => 'ACME',
-                        'theme' => 'dark',
-                    ]
+                // the path of the template to render and a context of variables passed to it
+                ->template('static/privacy.html.twig', [
+                    'site_name' => 'ACME',
+                    'theme' => 'dark',
                 ])
+                // special options defined by Symfony to set the page cache
+                ->maxAge(86400)
+                ->sharedMaxAge(86400)
             ;
         };
 
+.. versionadded:: 5.1
+
+    This short syntax was introduced in Symfony 5.1. Before you had to
+    define the controller and specific route attributes using ``defaults``.
+
 .. versionadded:: 5.1
 
     The ``context`` option was introduced in Symfony 5.1.