New in Symfony 6.1: Improved Routing Requirements and UTF-8 Parameters

Using PHP BackedEnum as Route Requirements

        Contributed by Thomas Calvet
         in #45803.

In PHP, backed enumerations are enumerations where all its elements are backed by some scalar value. This makes them useful to restrict the possible values of some routing parameter. In previous Symfony versions, you had to create the requirements manually using public constants:

    #[Route('/foo/{bar}', requirements: ['bar' => SomeEnum::AAA.'|'.SomeEnum::BBB])]

In Symfony 6.1, we're improving the Routing component to fully support \BackedEnum objects as follows:

    use Symfony\Component\Routing\Requirement\EnumRequirement;

// 'bar' parameter allows all values defined in the Enum

[Route('/foo/{bar}', requirements: ['bar' => new EnumRequirement(SomeEnum::class)])]

// 'bar' parameter only allows certain values of those defined in the Enum

[Route('/foo/{bar}', requirements: ['bar' => new EnumRequirement(SomeEnum::class, SomeEnum::Aaa, SomeEnum::Bbb)])]

A Collection of Common Routing Requirements

        Contributed by Thomas Calvet
         in #45528.

When defining routes, there are some requirements that repeat on many projects. For example, restricting some value to be an integer, or a date or a valid UUID pattern. In Symfony 6.1 we're introducing a Requirement enumeration to define all those common routing requirements so you can use them in your projects:

    use Symfony\Component\Routing\Requirement\Requirement;

[Route('/users/{id}', requirements: ['id' => Requirement::UUID_V4])]

[Route('/users/{id}')]

[Route('/posts/{date}/{slug}', requirements: [

'date' => Requirement::DATE_YMD,
'slug' => Requirement::ASCII_SLUG,

])]

// 'CATCH_ALL' is equivalent to '.+' (accepts all characters, including '/')

[Route('/category/{name}', requirements: ['name' => Requirement::CATCH_ALL])]

UTF-8 Parameter Names

        Contributed by Nicolas Grekas
         in #45054.

In PHP, variable identifiers can contain UTF-8 characters (e.g. $iñtërnâtiónàlizætiøn = '...') However, parameters in Symfony routes could only include ASCII characters. In Symfony 6.1 we're improving the Routing component to allow using UTF-8 characters in all route parameters:

    use Symfony\Component\Routing\Annotation\Route;

[Route('/blog/{föo}/{bár}', name: '...')]

public function someControllerMethod(string $föo, string $bár) { // ... }

                Sponsor the Symfony project.

https://symfony.com/blog/new-in-symfony-6-1-improved-routing-requirements-and-utf-8-parameters?utm_source=Symfony%20Blog%20Feed&utm_medium=feed

Created 3y | Apr 25, 2022, 2:20:27 PM


Login to add comment

Other posts in this group

New in Symfony 7.3: Global Translation Parameters

Contributed by Hubert Lenoir in

Apr 24, 2025, 7:30:24 AM | Symfony
SymfonyOnline June 2025: FormFlow: Build Stunning Multistep Forms

SymfonyOnline June 2025 is almost here, starting in almost 2 months on:

June 10-11: Workshop days. It is possible to attend 1 two-day training or 2 one-day trainings. June 12-13: Online confe

Apr 23, 2025, 3:20:21 PM | Symfony
New in Symfony 7.3: Assets Pre-Compression

Contributed by Kévin Dunglas in

Apr 23, 2025, 8:20:31 AM | Symfony
SymfonyOnline June 2025: Inside a Financial App Breach: Debugging a Million-Dollar Bug

SymfonyOnline June 2025 is almost here, starting in almost 2 months on:

June 10-11: Workshop days. It is possible to attend 1 two-day training or 2 one-day trainings. June 12-13: Online confe

Apr 22, 2025, 1:50:03 PM | Symfony
New in Symfony 7.3: Invokable Commands and Input Attributes

This is the first article in a series showcasing the most important new features introduced by Symfony 7.3, which will be released at the end of May 2025.

Apr 22, 2025, 9:10:36 AM | Symfony
A Week of Symfony #955 (April 14–20, 2025)

This week, the upcoming Symfony 7.3 version improved the AsAlias attribute by adding a new argument, introduced Clock support for UriSigner, and refined the return type of the ContainerInterface::get(

Apr 20, 2025, 8:30:06 AM | Symfony
SymfonyOnline June 2025: Rethinking File Handling in Symfony

SymfonyOnline June 2025 is almost here, starting in almost 2 months on:

June 10-11: Workshop days. It is possible to attend 1 two-day training or 2 one-day trainings. June 12-13: Online confe

Apr 16, 2025, 4:30:02 PM | Symfony