Configure routing via attributes.

Author: derrabus

src/Controller/Admin/BlogController.php

@@ -31,12 +31,12 @@
  *
  * See http://knpbundles.com/keyword/admin
  *
- * @Route("/admin/post")
  * @IsGranted("ROLE_ADMIN")
  *
  * @author Ryan Weaver <[email protected]>
  * @author Javier Eguiluz <[email protected]>
  */
+#[Route('/admin/post')]
 class BlogController extends AbstractController
 {
     /**
@@ -49,10 +49,11 @@ class BlogController extends AbstractController
      *     to create simpler links in the templates. Moreover, in the future we
      *     could move this annotation to any other controller while maintaining
      *     the route name and therefore, without breaking any existing link.
-     *
-     * @Route("/", methods="GET", name="admin_index")
-     * @Route("/", methods="GET", name="admin_post_index")
      */
+    #[
+        Route("/", methods: ['GET'], name: 'admin_index'),
+        Route("/", methods: ['GET'], name: 'admin_post_index'),
+    ]
     public function index(PostRepository $posts): Response
     {
         $authorPosts = $posts->findBy(['author' => $this->getUser()], ['publishedAt' => 'DESC']);
@@ -63,12 +64,11 @@ public function index(PostRepository $posts): Response
     /**
      * Creates a new Post entity.
      *
-     * @Route("/new", methods="GET|POST", name="admin_post_new")
-     *
      * NOTE: the Method annotation is optional, but it's a recommended practice
      * to constraint the HTTP methods each controller responds to (by default
      * it responds to all methods).
      */
+    #[Route('/new', methods: ['GET', 'POST'], name: 'admin_post_new')]
     public function new(Request $request): Response
     {
         $post = new Post();
@@ -110,9 +110,8 @@ public function new(Request $request): Response
 
     /**
      * Finds and displays a Post entity.
-     *
-     * @Route("/{id<\d+>}", methods="GET", name="admin_post_show")
      */
+    #[Route('/{id<\d+>}', methods: ['GET'], name: 'admin_post_show')]
     public function show(Post $post): Response
     {
         // This security check can also be performed
@@ -127,9 +126,9 @@ public function show(Post $post): Response
     /**
      * Displays a form to edit an existing Post entity.
      *
-     * @Route("/{id<\d+>}/edit", methods="GET|POST", name="admin_post_edit")
      * @IsGranted("edit", subject="post", message="Posts can only be edited by their authors.")
      */
+    #[Route('/{id<\d+>}/edit', methods: ['GET', 'POST'], name: 'admin_post_edit')]
     public function edit(Request $request, Post $post): Response
     {
         $form = $this->createForm(PostType::class, $post);
@@ -152,9 +151,9 @@ public function edit(Request $request, Post $post): Response
     /**
      * Deletes a Post entity.
      *
-     * @Route("/{id}/delete", methods="POST", name="admin_post_delete")
      * @IsGranted("delete", subject="post")
      */
+    #[Route('/{id}/delete', methods: ['POST'], name: 'admin_post_delete')]
     public function delete(Request $request, Post $post): Response
     {
         if (!$this->isCsrfTokenValid('delete', $request->request->get('token'))) {

src/Controller/BlogController.php

@@ -29,23 +29,24 @@
 /**
  * Controller used to manage blog contents in the public part of the site.
  *
- * @Route("/blog")
- *
  * @author Ryan Weaver <[email protected]>
  * @author Javier Eguiluz <[email protected]>
  */
+#[Route('/blog')]
 class BlogController extends AbstractController
 {
     /**
-     * @Route("/", defaults={"page": "1", "_format"="html"}, methods="GET", name="blog_index")
-     * @Route("/rss.xml", defaults={"page": "1", "_format"="xml"}, methods="GET", name="blog_rss")
-     * @Route("/page/{page<[1-9]\d*>}", defaults={"_format"="html"}, methods="GET", name="blog_index_paginated")
      * @Cache(smaxage="10")
      *
      * NOTE: For standard formats, Symfony will also automatically choose the best
      * Content-Type header for the response.
      * See https://symfony.com/doc/current/routing.html#special-parameters
      */
+    #[
+        Route('/', defaults: ['page' => '1', '_format' => 'html'], methods: ['GET'], name: 'blog_index'),
+        Route('/rss.xml', defaults: ['page' => '1', '_format' => 'xml'], methods: ['GET'], name: 'blog_rss'),
+        Route('/page/{page<[1-9]\d*>}', defaults: ['_format' => 'html'], methods: ['GET'], name: 'blog_index_paginated'),
+    ]
     public function index(Request $request, int $page, string $_format, PostRepository $posts, TagRepository $tags): Response
     {
         $tag = null;
@@ -64,13 +65,12 @@ public function index(Request $request, int $page, string $_format, PostReposito
     }
 
     /**
-     * @Route("/posts/{slug}", methods="GET", name="blog_post")
-     *
      * NOTE: The $post controller argument is automatically injected by Symfony
      * after performing a database query looking for a Post with the 'slug'
      * value given in the route.
      * See https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
      */
+    #[Route('/posts/{slug}', methods: ['GET'], name: 'blog_post')]
     public function postShow(Post $post): Response
     {
         // Symfony's 'dump()' function is an improved version of PHP's 'var_dump()' but
@@ -84,14 +84,14 @@ public function postShow(Post $post): Response
     }
 
     /**
-     * @Route("/comment/{postSlug}/new", methods="POST", name="comment_new")
      * @IsGranted("IS_AUTHENTICATED_FULLY")
      * @ParamConverter("post", options={"mapping": {"postSlug": "slug"}})
      *
      * NOTE: The ParamConverter mapping is required because the route parameter
      * (postSlug) doesn't match any of the Doctrine entity properties (slug).
      * See https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html#doctrine-converter
      */
+    #[Route('/comment/{postSlug}/new', methods: ['POST'], name: 'comment_new')]
     public function commentNew(Request $request, Post $post, EventDispatcherInterface $eventDispatcher): Response
     {
         $comment = new Comment();
@@ -140,9 +140,7 @@ public function commentForm(Post $post): Response
         ]);
     }
 
-    /**
-     * @Route("/search", methods="GET", name="blog_search")
-     */
+    #[Route('/search', methods: ['GET'], name: 'blog_search')]
     public function search(Request $request, PostRepository $posts): Response
     {
         $query = $request->query->get('q', '');

src/Controller/SecurityController.php

@@ -30,9 +30,7 @@ class SecurityController extends AbstractController
 {
     use TargetPathTrait;
 
-    /**
-     * @Route("/login", name="security_login")
-     */
+    #[Route('/login', name: 'security_login')]
     public function login(Request $request, Security $security, AuthenticationUtils $helper): Response
     {
         // if user is already logged in, don't display the login page again
@@ -59,9 +57,8 @@ public function login(Request $request, Security $security, AuthenticationUtils
      *
      * But, this will never be executed. Symfony will intercept this first
      * and handle the logout automatically. See logout in config/packages/security.yaml
-     *
-     * @Route("/logout", name="security_logout")
      */
+    #[Route('/logout', name: 'security_logout')]
     public function logout(): void
     {
         throw new \Exception('This should never be reached!');

src/Controller/UserController.php

@@ -23,16 +23,14 @@
 /**
  * Controller used to manage current user.
  *
- * @Route("/profile")
  * @IsGranted("ROLE_USER")
  *
  * @author Romain Monteil <[email protected]>
  */
+#[Route("/profile")]
 class UserController extends AbstractController
 {
-    /**
-     * @Route("/edit", methods="GET|POST", name="user_edit")
-     */
+    #[Route('/edit', methods: ['GET', 'POST'], name: 'user_edit')]
     public function edit(Request $request): Response
     {
         $user = $this->getUser();
@@ -54,9 +52,7 @@ public function edit(Request $request): Response
         ]);
     }
 
-    /**
-     * @Route("/change-password", methods="GET|POST", name="user_change_password")
-     */
+    #[Route("/change-password", methods: ['GET', 'POST'], name: 'user_change_password')]
     public function changePassword(Request $request, UserPasswordEncoderInterface $encoder): Response
     {
         $user = $this->getUser();