New in Symfony 5.4: Controller Changes

Symfony Controllers are the "glue code" that runs some logic and calls some services to serve each application route. They are a very stable piece of software that we rarely change. However, in Symfony 5.4 we've made some changes to controllers that may impact your applications.

Deprecated the Request::get() Method

        Contributed by Roland Franssen 
        in #42392.

The Symfony Request Object is an object-oriented representation of the HTTP request message. This object provides several methods to get information from the incoming request:

    1

2 3 4 5 6 7 8 // retrieve information from $_GET $request->query->get('id'); // retrieve information from $_POST $request->request->get('category', 'default category'); // retrieve information from $_SERVER $request->server->get('HTTP_HOST'); // retrieve information from $_COOKIE $request->cookies->get('PHPSESSID');

In addition to these specific methods, there's a generic get() method that looks for information in path (routing placeholders or custom attributes), $_GET, and $_POST and returns the first value found:

    1

2 // this information could come from route attributes, from $_GET or form $_POST $request->get('id');

The flexibility of this method could be useful in some edge-cases, but it's generally better to be explicit about where does data come from. That's why we've been discouraging the usage of this method from some years and in Symfony 5.4 we're marking it as private. You can still use it, but you'll see deprecation messages if you do, so it's better if you start upgrading your applications.

Deprecated Some Controller Shortcuts

        Contributed by Fabien Potencier 
        in #42422
        and #42442.

In early Symfony versions, you could access all your application services from the controllers using the get() and has() methods:

    1

2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 // src/Controller/SomeController.php namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Routing\Annotation\Route;

class SomeController extends AbstractController {

[Route(...)]

public function someAction(): Response
{
    $doctrine = $this->get('doctrine');
    // ...
}

}

Later we removed this feature because accessing the entire service container in this way is considered an anti-pattern. Therefore, the get() method only allows access to a very limited set of services related to controllers. In Symfony 5.4 we're deprecating the get() and has() methods entirely. Instead, fetching services in controllers should use constructor or method injection. Besides, controllers provide a series of shortcuts for the most common operations. For example, to redirect to some route, you don't need to inject the UrlGeneratorInterface class to get the URL generator service. You can optionally use the redirectToRoute() shortcut:

    1

2 3 4 5 6 7

[Route(...)]

public function someAction(): Response { // ...

return $this->redirectToRoute('...');

}

In addition to this change, we reviewed the list of shortcuts to see if we should add or remove some. We decided to deprecate the following controller shortcuts because they are not directly related to HTTP operations: dispatchMessage() getDoctrine() Instead of using those shortcuts, inject the related services in the constructor or the controller methods.

                Sponsor the Symfony project.

http://feedproxy.google.com/~r/symfony/blog/~3/QFefyYCFvR0/new-in-symfony-5-4-controller-changes

Created 4y | Nov 8, 2021, 8:20:07 AM


Login to add comment

Other posts in this group

SymfonyOnline June 2025: Speakers, Stats & Replays!

Thank you for joining us at SymfonyOnline June 2025!

What a great edition of SymfonyOnline we’ve just wrapped up! 🎉

We were thrilled to welcome 300 participants from 35 different countries—a

Jun 18, 2025, 8:50:17 AM | Symfony
A Week of Symfony #963 (June 9–15, 2025)

This week, Symfony celebrated the SymfonyOnline June 2025 conference with great success. Meanwhile, development efforts focused on improving invokable commands for the upcoming Symfony 7.4 version. Th

Jun 15, 2025, 9:10:09 AM | Symfony
A Week of Symfony #962 (June 2–8, 2025)

This week, development activity focused on the upcoming Symfony 7.4 and 8.0 versions, which will deprecate and remove many features. In addition, we published a case study about Yousign. Finally, we'r

Jun 8, 2025, 7:50:05 AM | Symfony
Case study - Yousign: Scaling Trust with Smart, Scalable Architecture

As digital signatures become the norm in modern business, Yousign has established itself as a trusted leader across Europe. Behind its simple, intuitive interface is a powerful technical engine, handl

Jun 6, 2025, 7:10:24 AM | Symfony
SymfonyOnline June 2025 starts next week!

Get ready for the exciting SymfonyOnline June 2025, kicking off in a few days only! There’s still time to register and join the international online Symfony conference—along with pre-conferenc

Jun 5, 2025, 10:20:09 AM | Symfony
A Week of Symfony #961 (May 26 – June 1, 2025)

This week, Symfony released the stable version of Symfony 7.3, which includes lots of amazing new features. We also published the maintenance versions 6.4.22 and 7.2.7.

Symfony development highlights

Jun 1, 2025, 8:50:16 AM | Symfony
New in Symfony 7.3: DX Improvements (part 2)

This is the second part of the blog post showcasing the main DX (developer experience) features introduced in Symfony 7.3. Read the first part of this blog post.

Verify URI Signatures… https://symfon

May 29, 2025, 9:10:19 AM | Symfony