Re-introduce Route attribute

[fritzmg]

This re-introduces the #[Route] attribute in a way that is compatible with Symfony 5, 6 & 7 (Contao 4.13, 5.3 and 5.4+), as suggested by @Tastaturberuf.

Contao 4.13:

$ vendor/bin/contao-console debug:router nc_bulky_item_download
+--------------+-----------------------------------------------------------------------------------------------------------------------+
| Property     | Value                                                                                                                 |
+--------------+-----------------------------------------------------------------------------------------------------------------------+
| Route Name   | nc_bulky_item_download                                                                                                |
| Path         | /notifications/download/{voucher}                                                                                     |
| Path Regex   | {^/notifications/download/(?P<voucher>\d{8}/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12})$}sDu |
| Host         | ANY                                                                                                                   |
| Host Regex   |                                                                                                                       |
| Scheme       | ANY                                                                                                                   |
| Method       | ANY                                                                                                                   |
| Requirements | voucher: \d{8}/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}                                    |
| Class        | Symfony\Component\Routing\Route                                                                                       |
| Defaults     | _controller: Terminal42\NotificationCenterBundle\Controller\DownloadBulkyItemController()                             |
| Options      | compiler_class: Symfony\Component\Routing\RouteCompiler                                                               |
|              | utf8: true                                                                                                            |
+--------------+-----------------------------------------------------------------------------------------------------------------------+

Contao 5.3:

$ bin/console debug:router nc_bulky_item_download
+--------------+-----------------------------------------------------------------------------------------------------------------------+
| Property     | Value                                                                                                                 |
+--------------+-----------------------------------------------------------------------------------------------------------------------+
| Route Name   | nc_bulky_item_download                                                                                                |
| Path         | /notifications/download/{voucher}                                                                                     |
| Path Regex   | {^/notifications/download/(?P<voucher>\d{8}/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12})$}sDu |
| Host         | ANY                                                                                                                   |
| Host Regex   |                                                                                                                       |
| Scheme       | ANY                                                                                                                   |
| Method       | ANY                                                                                                                   |
| Requirements | voucher: \d{8}/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}                                    |
| Class        | Symfony\Component\Routing\Route                                                                                       |
| Defaults     | _controller: Terminal42\NotificationCenterBundle\Controller\DownloadBulkyItemController()                             |
| Options      | compiler_class: Symfony\Component\Routing\RouteCompiler                                                               |
|              | utf8: true                                                                                                            |
+--------------+-----------------------------------------------------------------------------------------------------------------------+

Contao 5.x:

$ bin/console debug:router nc_bulky_item_download
+--------------+-----------------------------------------------------------------------------------------------------------------------+
| Property     | Value                                                                                                                 |
+--------------+-----------------------------------------------------------------------------------------------------------------------+
| Route Name   | nc_bulky_item_download                                                                                                |
| Path         | /notifications/download/{voucher}                                                                                     |
| Path Regex   | {^/notifications/download/(?P<voucher>\d{8}/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12})$}sDu |
| Host         | ANY                                                                                                                   |
| Host Regex   |                                                                                                                       |
| Scheme       | ANY                                                                                                                   |
| Method       | ANY                                                                                                                   |
| Requirements | voucher: \d{8}/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}                                    |
| Class        | Symfony\Component\Routing\Route                                                                                       |
| Defaults     | _controller: Terminal42\NotificationCenterBundle\Controller\DownloadBulkyItemController()                             |
| Options      | compiler_class: Symfony\Component\Routing\RouteCompiler                                                               |
|              | utf8: true                                                                                                            |
+--------------+-----------------------------------------------------------------------------------------------------------------------+

[aschempp]

Does this have any advantages over the current implementation? Also using a deprecated class that will likely be dropped in Symfony 8?

[fritzmg]

At the moment there is no real advantage, other than having an example to look at in a popular repository. It would be more advantageous once you need more controllers/routes.

The Symfony\Component\Routing\Annotation\Route class is not deprecated.

[aschempp]

Closing this because I think using a config file for route loading is perfectly fine, and superior to kernel-version handling because of PHP side-effects like attributes vs. annotations.