Contributed by Alexander M. Turek in #47916 and #47943

In your Symfony applications you probably have a configuration similar to the following:

        1
2
3
4
        # config/routes.yaml
controllers:
    resource: ../src/Controller/
    type: attribute
    

This tells Symfony to look for all PHP files defined in that directory and load the routes defined as PHP attributes in the classes of those files. Internally, this uses AnnotationDirectoryLoader and AnnotationFileLoader to find the route annotations.

More specifically, AnnotationDirectoryLoader finds all PHP files recursively and AnnotationFileLoader inspects their contents, using PHP token_get_all() function, to get the full class name for the first class found in the file. The entire process is cached, so it only impacts performance the first time.

However, since all modern PHP projects use PSR-4 class autoloading, all this is unnecessary. PSR-4 defines the corresponding file path for a given fully qualified class name (and vice versa), so there's no need to guess which class defines each file.

In Symfony 6.2, we're introducing a new PSR-4 routing loader, which is similar to the annotation routing loader, but finds routes faster because it assumes that your project files follow PSR-4. See Psr4DirectoryLoader code.

The only needed change in your applications is to define the PSR-4 namespace used by your controller classes:

        1
2
3
4
5
6
7
        # config/routes.yaml
 controllers:
-    resource: ../src/Controller/
+    resource:
+        path: ../src/Controller/
+        namespace: App\Controller
     type: attribute
    

In addition to the YAML configuration shown above, the namespace option is also supported in XML and PHP configs.

Published in #Living on the edge

user_controllers: resource: path: ../src/User/Controller/ namespace: App\User\Controller type: attribute product_controllers: resource: path: ../src/Product/Controller/ namespace: App\Product\Controller type: attribute

Stephan Vierkant said on Nov 8, 2022 at 09:09

What if you're already using PHP configs?

    $routingConfigurator->import('../../src/Controller/', 'annotation');
};```

Javier Eguiluz Certified said on Nov 8, 2022 at 09:43

@Stephan you can see the full YAML, XML And PHP config examples in this page: https://symfony.com/doc/6.2/routing/custom_route_loader.html

Gaëtan Petit said on Nov 8, 2022 at 11:48

What if the controllers are distributed within different paths and namespace?

Robin Chalas said on Nov 8, 2022 at 15:25

@Gaëtan Having multiple resources should be fine:

Nicolas Toniazzi said on Nov 10, 2022 at 09:07

PSR-4 defines the corresponding file path for a given fully qualified class name (and vice versa) If so, the 'path' attribute in the resource configuration is redundant and it should be possible to omit it?

Javier Eguiluz Certified said on Nov 10, 2022 at 09:41

@Nicolas that's a very good question. We debated internally about this.

It's true that it looks redundant, but if you remove it, you need to know (or find somehow) the root directory of the PHP files/clases to load. It's usually "src/Controller/" but not always. So, you had to look for in "composer.json" configuration and that would couple this feature with Composer.

At the end, we decided that this little redundancy was better because you configure this very rarely and the alternative would be worse. Cheers.

New in Symfony 6.2: PSR-4 Route Loader

Comments

Become a Symfony contributor