Skip to content
  • About
    • What is Symfony?
    • Community
    • News
    • Contributing
    • Support
  • Documentation
    • Symfony Docs
    • Symfony Book
    • Screencasts
    • Symfony Bundles
    • Symfony Cloud
    • Training
  • Services
    • Platform.sh for Symfony Best platform to deploy Symfony apps
    • SymfonyInsight Automatic quality checks for your apps
    • Symfony Certification Prove your knowledge and boost your career
    • SensioLabs Professional services to help you with Symfony
    • Blackfire Profile and monitor performance of your apps
  • Other
  • Blog
  • Download
sponsored by
  1. Home
  2. Documentation
  3. Bundles
  4. SensioFrameworkExtraBundle
  5. @Route and @Method

@Route and @Method

Edit this page
It's no longer recommended to use this bundle in current Symfony applications. All the annotations provided by this bundle are now built-in in Symfony as PHP attributes. Check out the full list of Symfony attributes.

Routing annotations of the SensioFrameworkExtraBundle are deprecated since version 5.2 because they are now a core feature of Symfony.

How to Update your Applications

@Route Annotation

The Symfony @Route annotation is similar to the SensioFrameworkExtraBundle annotation, so you only have to update the annotation class namespace:

1
2
3
4
5
6
7
8
9
10
11
12
13
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+use Symfony\Component\Routing\Annotation\Route;

class DefaultController extends Controller
{
    /**
     * @Route("/")
     */
    public function index()
    {
        // ...
    }
}

Alternatively, it can be done with the help of the PHP 8 attribute:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+use Symfony\Component\Routing\Annotation\Route;

class DefaultController extends Controller
{
-    /**
-     * @Route("/")
-     */
+    #[Route('/')]
    public function index()
    {
        // ...
    }
}

The main difference is that Symfony's annotation no longer defines the service option, which was used to instantiate the controller by fetching the given service from the container. In modern Symfony applications, all controllers are services by default and their service IDs are their fully- qualified class names, so this option is no longer needed.

@Method Annotation

The @Method annotation from SensioFrameworkExtraBundle has been removed. Instead, the Symfony @Route annotation defines a methods option to restrict the HTTP methods of the route:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
+use Symfony\Component\Routing\Annotation\Route;

class DefaultController extends Controller
{
    /**
-      * @Route("/show/{id}")
-      * @Method({"GET", "HEAD"})
+      * @Route("/show/{id}", methods={"GET","HEAD"})
     */
    public function show($id)
    {
        // ...
    }
}

Alternatively, it can be done with the help of the PHP 8 attribute:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
+use Symfony\Component\Routing\Annotation\Route;

class DefaultController extends Controller
{
-    /**
-     * @Route("/show/{id}")
-     * @Method({"GET", "HEAD"})
-     */
+    #[Route('/show/{id}', methods: ['GET','HEAD'])]
    public function show($id)
    {
        // ...
    }
}

Read the chapter about Routing in the Symfony Documentation to learn everything about these and the other annotations available.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version
    Peruse our complete Symfony & PHP solutions catalog for your web development needs.

    Peruse our complete Symfony & PHP solutions catalog for your web development needs.

    No stress: we've got you covered with our 116 automated quality checks of your code

    No stress: we've got you covered with our 116 automated quality checks of your code

    Version:

    Table of Contents

    • How to Update your Applications
      • @Route Annotation
      • @Method Annotation

    Symfony footer

    Avatar of Michał Jusięga, a Symfony contributor

    Thanks Michał Jusięga for being a Symfony contributor

    2 commits • 4 lines changed

    View all contributors that help us make Symfony

    Become a Symfony contributor

    Be an active part of the community and contribute ideas, code and bug fixes. Both experts and newcomers are welcome.

    Learn how to contribute

    Symfony™ is a trademark of Symfony SAS. All rights reserved.

    • What is Symfony?

      • What is Symfony?
      • Symfony at a Glance
      • Symfony Components
      • Symfony Releases
      • Security Policy
      • Logo & Screenshots
      • Trademark & Licenses
      • symfony1 Legacy
    • Learn Symfony

      • Symfony Docs
      • Symfony Book
      • Reference
      • Bundles
      • Best Practices
      • Training
      • eLearning Platform
      • Certification
    • Screencasts

      • Learn Symfony
      • Learn PHP
      • Learn JavaScript
      • Learn Drupal
      • Learn RESTful APIs
    • Community

      • Symfony Community
      • SymfonyConnect
      • Events & Meetups
      • Projects using Symfony
      • Contributors
      • Symfony Jobs
      • Backers
      • Code of Conduct
      • Downloads Stats
      • Support
    • Blog

      • All Blog Posts
      • A Week of Symfony
      • Case Studies
      • Cloud
      • Community
      • Conferences
      • Diversity
      • Living on the edge
      • Releases
      • Security Advisories
      • Symfony Insight
      • Twig
      • SensioLabs Blog
    • Services

      • SensioLabs services
      • Train developers
      • Manage your project quality
      • Improve your project performance
      • Host Symfony projects

      Powered by

    Follow Symfony