prefer @route annotation from Routing component

xabbuh · xabbuh · commit 6b282558a0a0 · 2018-08-03T19:26:27.000+02:00
diff --git a/best_practices/controllers.rst b/best_practices/controllers.rst
@@ -95,7 +95,7 @@ for the homepage of our app::
 
     use AppBundle\Entity\Post;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class DefaultController extends Controller
     {
@@ -130,7 +130,7 @@ to automatically query for an entity and pass it as an argument to your controll
 For example::
 
     use AppBundle\Entity\Post;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+    use Symfony\Component\Routing\Annotation\Route;
 
     /**
      * @Route("/{id}", name="admin_post_show")
@@ -179,9 +179,9 @@ You can also use the ``@ParamConverter`` configuration, which is infinitely
 flexible::
 
     use AppBundle\Entity\Post;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
     use Symfony\Component\HttpFoundation\Request;
+    use Symfony\Component\Routing\Annotation\Route;
 
     /**
      * @Route("/comment/{postSlug}/new", name="comment_new")
diff --git a/best_practices/security.rst b/best_practices/security.rst
@@ -109,8 +109,8 @@ Using ``@Security``, this looks like:
 
 .. code-block:: php
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+    use Symfony\Component\Routing\Annotation\Route;
     // ...
 
     /**
@@ -133,8 +133,8 @@ controller if their email matches the value returned by the ``getAuthorEmail()``
 method on the ``Post`` object::
 
     use AppBundle\Entity\Post;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+    use Symfony\Component\Routing\Annotation\Route;
 
     /**
      * @Route("/{id}/edit", name="admin_post_edit")
diff --git a/configuration/micro_kernel_trait.rst b/configuration/micro_kernel_trait.rst
@@ -254,7 +254,7 @@ has one file in it::
     namespace App\Controller;
 
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class MicroController extends Controller
     {
diff --git a/controller.rst b/controller.rst
@@ -16,8 +16,8 @@ This renders a page that prints a lucky (random) number::
     // src/AppBundle/Controller/LuckyController.php
     namespace AppBundle\Controller;
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Component\HttpFoundation\Response;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class LuckyController
     {
@@ -59,7 +59,7 @@ class::
     namespace AppBundle\Controller;
 
     use Symfony\Component\HttpFoundation\Response;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class LuckyController
     {
diff --git a/controller/upload_file.rst b/controller/upload_file.rst
@@ -99,9 +99,9 @@ Finally, you need to update the code of the controller that handles the form::
     // src/AppBundle/Controller/ProductController.php
     namespace AppBundle\Controller;
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
     use Symfony\Component\HttpFoundation\Request;
+    use Symfony\Component\Routing\Annotation\Route;
     use AppBundle\Entity\Product;
     use AppBundle\Form\ProductType;
 
diff --git a/doctrine/registration_form.rst b/doctrine/registration_form.rst
@@ -239,9 +239,9 @@ into the database::
 
     use AppBundle\Form\UserType;
     use AppBundle\Entity\User;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
     use Symfony\Component\HttpFoundation\Request;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class RegistrationController extends Controller
     {
diff --git a/page_creation.rst b/page_creation.rst
@@ -43,8 +43,8 @@ random) number and prints it. To do that, create a "Controller class" and a
     // src/AppBundle/Controller/LuckyController.php
     namespace AppBundle\Controller;
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Component\HttpFoundation\Response;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class LuckyController
     {
diff --git a/quick_tour/the_big_picture.rst b/quick_tour/the_big_picture.rst
@@ -51,8 +51,8 @@ because that will be explained in the next section)::
 
     namespace AppBundle\Controller;
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class DefaultController extends Controller
     {
@@ -95,8 +95,8 @@ at the three lines of code above the ``indexAction()`` method::
     // src/AppBundle/Controller/DefaultController.php
     namespace AppBundle\Controller;
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class DefaultController extends Controller
     {
diff --git a/quick_tour/the_controller.rst b/quick_tour/the_controller.rst
@@ -22,9 +22,9 @@ text content::
     // src/AppBundle/Controller/DefaultController.php
     namespace AppBundle\Controller;
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
     use Symfony\Component\HttpFoundation\Response;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class DefaultController extends Controller
     {
@@ -57,8 +57,8 @@ a new method called ``helloAction()`` with the following content::
     // src/AppBundle/Controller/DefaultController.php
     namespace AppBundle\Controller;
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class DefaultController extends Controller
     {
@@ -114,8 +114,7 @@ Tweak the ``hello`` route by adding a new ``_format`` variable with ``html``
 as its default value::
 
     // src/AppBundle/Controller/DefaultController.php
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+    use Symfony\Component\Routing\Annotation\Route;
 
     // ...
 
@@ -153,8 +152,7 @@ To restrict the formats supported by a given action, use the ``requirements``
 option of the ``@Route()`` annotation::
 
     // src/AppBundle/Controller/DefaultController.php
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+    use Symfony\Component\Routing\Annotation\Route;
 
     // ...
 
@@ -254,9 +252,9 @@ forget to add the new ``use`` statement that imports this ``Request`` class)::
     // src/AppBundle/Controller/DefaultController.php
     namespace AppBundle\Controller;
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
     use Symfony\Component\HttpFoundation\Request;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class DefaultController extends Controller
     {
diff --git a/routing.rst b/routing.rst
@@ -40,7 +40,7 @@ The route is simple:
         namespace AppBundle\Controller;
 
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class BlogController extends Controller
         {
@@ -174,7 +174,7 @@ To fix this, add a *requirement* that the ``{page}`` wildcard can *only* match n
         namespace AppBundle\Controller;
 
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class BlogController extends Controller
         {
@@ -272,7 +272,7 @@ So how can you make ``blog_list`` once again match when the user visits
         namespace AppBundle\Controller;
 
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class BlogController extends Controller
         {
diff --git a/routing/custom_route_loader.rst b/routing/custom_route_loader.rst
@@ -29,7 +29,7 @@ Loading Routes
 The routes in a Symfony application are loaded by the
 :class:`Symfony\\Bundle\\FrameworkBundle\\Routing\\DelegatingLoader`.
 This loader uses several other loaders (delegates) to load resources of
-different types, for instance YAML files or ``@Route`` and ``@Method`` annotations
+different types, for instance YAML files or ``@Route`` annotations
 in controller files. The specialized loaders implement
 :class:`Symfony\\Component\\Config\\Loader\\LoaderInterface`
 and therefore have two important methods:
diff --git a/routing/external_resources.rst b/routing/external_resources.rst
@@ -98,7 +98,7 @@ suppose you want to prefix all routes in the AppBundle with ``/site`` (e.g.
 
     .. code-block:: php-annotations
 
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         /**
          * @Route("/site")
diff --git a/routing/hostname_pattern.rst b/routing/hostname_pattern.rst
@@ -14,7 +14,7 @@ You can also match on the HTTP *host* of the incoming request.
         namespace Acme\DemoBundle\Controller;
 
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class MainController extends Controller
         {
@@ -96,7 +96,7 @@ you can use placeholders in your hostname:
         namespace Acme\DemoBundle\Controller;
 
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class MainController extends Controller
         {
@@ -173,7 +173,7 @@ instance, if you want to match both ``m.example.com`` and
         namespace Acme\DemoBundle\Controller;
 
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class MainController extends Controller
         {
@@ -266,7 +266,7 @@ instance, if you want to match both ``m.example.com`` and
             namespace Acme\DemoBundle\Controller;
 
             use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-            use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+            use Symfony\Component\Routing\Annotation\Route;
 
             class MainController extends Controller
             {
@@ -367,7 +367,7 @@ You can also set the host option on imported routes:
         namespace Acme\HelloBundle\Controller;
 
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         /**
          * @Route(host="hello.example.com")
diff --git a/routing/redirect_trailing_slash.rst b/routing/redirect_trailing_slash.rst
@@ -44,9 +44,9 @@ system, as explained below:
         // src/AppBundle/Controller/RedirectingController.php
         namespace AppBundle\Controller;
 
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
         use Symfony\Component\HttpFoundation\Request;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class RedirectingController extends Controller
         {
diff --git a/routing/requirements.rst b/routing/requirements.rst
@@ -16,7 +16,7 @@ a routing ``{wildcard}`` to only match some regular expression:
         namespace AppBundle\Controller;
 
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class BlogController extends Controller
         {
@@ -187,23 +187,20 @@ accomplished with the following route configuration:
         // src/AppBundle/Controller/BlogApiController.php
         namespace AppBundle\Controller;
 
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
         // ...
 
         class BlogApiController extends Controller
         {
             /**
-             * @Route("/api/posts/{id}")
-             * @Method({"GET","HEAD"})
+             * @Route("/api/posts/{id}", methods={"GET","HEAD"})
              */
             public function showAction($id)
             {
                 // ... return a JSON response with the post
             }
 
             /**
-             * @Route("/api/posts/{id}")
-             * @Method("PUT")
+             * @Route("/api/posts/{id}", methods={"PUT"})
              */
             public function editAction($id)
             {
diff --git a/routing/scheme.rst b/routing/scheme.rst
@@ -16,7 +16,7 @@ the URI scheme via schemes:
         namespace AppBundle\Controller;
 
         use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class MainController extends Controller
         {
diff --git a/routing/slash_in_parameter.rst b/routing/slash_in_parameter.rst
@@ -26,7 +26,7 @@ a more permissive regular expression for it:
 
     .. code-block:: php-annotations
 
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class DefaultController
         {
diff --git a/security.rst b/security.rst
@@ -189,9 +189,9 @@ example, if you use annotations, create something like this::
     // src/AppBundle/Controller/DefaultController.php
     // ...
 
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Bundle\FrameworkBundle\Controller\Controller;
     use Symfony\Component\HttpFoundation\Response;
+    use Symfony\Component\Routing\Annotation\Route;
 
     class DefaultController extends Controller
     {
diff --git a/security/form_login_setup.rst b/security/form_login_setup.rst
@@ -91,7 +91,7 @@ configuration (``login``):
         // src/AppBundle/Controller/SecurityController.php
 
         // ...
-        use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+        use Symfony\Component\Routing\Annotation\Route;
 
         class SecurityController extends Controller
         {
diff --git a/service_container/autowiring.rst b/service_container/autowiring.rst
diff --git a/templating.rst b/templating.rst
diff --git a/templating/formats.rst b/templating/formats.rst

Original file line number	Diff line number	Diff line change
`@@ -254,7 +254,7 @@ has one file in it::`
`254`	`254`	`namespace App\Controller;`
`255`	`255`
`256`	`256`	`use Symfony\Bundle\FrameworkBundle\Controller\Controller;`
`257`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
	`257`	`+ use Symfony\Component\Routing\Annotation\Route;`
`258`	`258`
`259`	`259`	`class MicroController extends Controller`
`260`	`260`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ This renders a page that prints a lucky (random) number::`
`16`	`16`	`// src/AppBundle/Controller/LuckyController.php`
`17`	`17`	`namespace AppBundle\Controller;`
`18`	`18`
`19`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
`20`	`19`	`use Symfony\Component\HttpFoundation\Response;`
	`20`	`+ use Symfony\Component\Routing\Annotation\Route;`
`21`	`21`
`22`	`22`	`class LuckyController`
`23`	`23`	`{`
`@@ -59,7 +59,7 @@ class::`
`59`	`59`	`namespace AppBundle\Controller;`
`60`	`60`
`61`	`61`	`use Symfony\Component\HttpFoundation\Response;`
`62`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
	`62`	`+ use Symfony\Component\Routing\Annotation\Route;`
`63`	`63`
`64`	`64`	`class LuckyController`
`65`	`65`	`{`
Original file line number	Diff line number	Diff line change
`@@ -239,9 +239,9 @@ into the database::`
`239`	`239`
`240`	`240`	`use AppBundle\Form\UserType;`
`241`	`241`	`use AppBundle\Entity\User;`
`242`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
`243`	`242`	`use Symfony\Bundle\FrameworkBundle\Controller\Controller;`
`244`	`243`	`use Symfony\Component\HttpFoundation\Request;`
	`244`	`+ use Symfony\Component\Routing\Annotation\Route;`
`245`	`245`
`246`	`246`	`class RegistrationController extends Controller`
`247`	`247`	`{`
Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,8 @@ random) number and prints it. To do that, create a "Controller class" and a`
`43`	`43`	`// src/AppBundle/Controller/LuckyController.php`
`44`	`44`	`namespace AppBundle\Controller;`
`45`	`45`
`46`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
`47`	`46`	`use Symfony\Component\HttpFoundation\Response;`
	`47`	`+ use Symfony\Component\Routing\Annotation\Route;`
`48`	`48`
`49`	`49`	`class LuckyController`
`50`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -51,8 +51,8 @@ because that will be explained in the next section)::`
`51`	`51`
`52`	`52`	`namespace AppBundle\Controller;`
`53`	`53`
`54`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
`55`	`54`	`use Symfony\Bundle\FrameworkBundle\Controller\Controller;`
	`55`	`+ use Symfony\Component\Routing\Annotation\Route;`
`56`	`56`
`57`	`57`	`class DefaultController extends Controller`
`58`	`58`	`{`
@@ -95,8 +95,8 @@ at the three lines of code above the ``indexAction()`` method::
`95`	`95`	`// src/AppBundle/Controller/DefaultController.php`
`96`	`96`	`namespace AppBundle\Controller;`
`97`	`97`
`98`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
`99`	`98`	`use Symfony\Bundle\FrameworkBundle\Controller\Controller;`
	`99`	`+ use Symfony\Component\Routing\Annotation\Route;`
`100`	`100`
`101`	`101`	`class DefaultController extends Controller`
`102`	`102`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ The route is simple:`
`40`	`40`	`namespace AppBundle\Controller;`
`41`	`41`
`42`	`42`	`use Symfony\Bundle\FrameworkBundle\Controller\Controller;`
`43`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
	`43`	`+ use Symfony\Component\Routing\Annotation\Route;`
`44`	`44`
`45`	`45`	`class BlogController extends Controller`
`46`	`46`	`{`
@@ -174,7 +174,7 @@ To fix this, add a requirement that the ``{page}`` wildcard can only match n
`174`	`174`	`namespace AppBundle\Controller;`
`175`	`175`
`176`	`176`	`use Symfony\Bundle\FrameworkBundle\Controller\Controller;`
`177`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
	`177`	`+ use Symfony\Component\Routing\Annotation\Route;`
`178`	`178`
`179`	`179`	`class BlogController extends Controller`
`180`	`180`	`{`
@@ -272,7 +272,7 @@ So how can you make ``blog_list`` once again match when the user visits
`272`	`272`	`namespace AppBundle\Controller;`
`273`	`273`
`274`	`274`	`use Symfony\Bundle\FrameworkBundle\Controller\Controller;`
`275`		`- use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;`
	`275`	`+ use Symfony\Component\Routing\Annotation\Route;`
`276`	`276`
`277`	`277`	`class BlogController extends Controller`
`278`	`278`	`{`