[FrameworkBundle] fix type annotation on ControllerTrait::addFlash() #36913
Conversation
|
This should be considered on 3.4 first to me, agreeing on changing the annotation. Note that technically this is a BC break, but the method is |
|
In 3.4 the type-hint isn't there - so everything's fine: https://github.com/symfony/symfony/blob/3.4/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php#L196 In 4.4 it is there, but the entire method still lives in |
|
|
Removing `string` type-hint of $message at addFlash() Closes #28991 and #34645 Reasons: * `addFlash()` is just a convenience shortcut for `FlashBagInterface::add()` which doesn't have the type hint: https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBagInterface.php#L28 . So removing it here improves consistency. * #28991 (comment) is a valid use case for having an object as `$message`. * Twig doesn't have any rendering helpers for the `message`, see https://symfony.com/doc/current/controller.html#flash-messages . And since users have to take care of displaying the `message` themselves, there's no reason to force a string upon them.
|
Thank you @ThomasLandauer. |
Removing
stringtype-hint of $message at addFlash()Closes #28991 and #34645
Reasons:
addFlash()is just a convenience shortcut forFlashBagInterface::add()which doesn't have the type hint: https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBagInterface.php#L28 . So removing it here improves consistency.Flash message behavior changed #28991 (comment) is a valid use case for having an object as
$message.Twig doesn't have any rendering helpers for the
message, see https://symfony.com/doc/current/controller.html#flash-messages . And since users have to take care of displaying themessagethemselves, there's no reason to force a string upon them.This isn't a real new feature, but it isn't a bugfix either ;-)
I didn't update
src/**/CHANGELOG.mdyet.I'm not sure if it's necessary to update the docs. Maybe a short note https://symfony.com/doc/current/controller.html#flash-messages ?