[Form] TransformationFailedException: Support specifying message to display #20978

ogizanagi · 2016-12-18T13:44:40Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#22501
License	MIT
Doc PR	N/A

Currently, a failed transformation can't display a very accurate message, as it only uses the value of the invalid_message option. I suggest to add more flexibility, somehow the same way we did for CustomUserMessageAuthenticationException.

A test case in FormTypeTest shows a use-case based on @webmozart's blog post about value/immutable objects in Symfony forms.

~~I named the exception properties and methods the same way as for CustomUserMessageAuthenticationException, but do you think the followings would be better:~~

~~setSafeMessage ➜ setInvalidMessage~~
~~getMessageKey ➜ getInvalidMessageKey~~
~~getMessageData ➜ getInvalidMessageParameters~~

~~in order to echoes invalid_message and invalid_message_parameters options?~~

=> Replaced to use invalidMessage & invalidMessageParameters

src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php

src/Symfony/Component/Form/Exception/TransformationFailedException.php

ogizanagi · 2017-07-06T11:24:52Z

@HeahDude : Is it worth working again on this PR or should I wait your propositions about #20978 (comment) ?

HeahDude · 2017-07-06T11:27:10Z

Yes, I suggest to wait :).

nicolas-grekas · 2017-10-08T15:46:25Z

Moving to 4.1. Rebase on master needed, where PHP 7.1 features can be used btw.

fabpot · 2018-03-31T05:47:59Z

@HeahDude Any ways we can unblock this PR?

xabbuh · 2018-09-15T10:04:35Z

What about allowing the option to be a closure that would get passed the transformation failure exception and would return the error message to use?

ogizanagi · 2018-09-15T14:38:43Z

@xabbuh : Would you remove the safe message in favor of more specific TransformationFailedException instances then? I'm fine with both solutions, but I thing the safe message approach is more convenient than creating a dedicated exception and treat it in each form type invalid_message option when relevant.

xabbuh · 2018-10-09T17:02:08Z

After thinking about it again I think having a message key in the exception isn't such a bad idea. It's also consistent with what we support in the Security component.

ogizanagi · 2018-11-05T23:25:45Z

Woops. I've closed this one by mistake.

nicolas-grekas · 2018-11-08T22:08:26Z

rebase needed. for which branch is this PR?

ogizanagi · 2018-11-09T09:41:33Z

Rebased on master

src/Symfony/Component/Form/Exception/TransformationFailedException.php

xabbuh · 2018-11-10T16:03:55Z

src/Symfony/Component/Form/Form.php

@@ -1050,7 +1050,13 @@ private function modelToNorm($value)
                $value = $transformer->transform($value);
            }
        } catch (TransformationFailedException $exception) {
-            throw new TransformationFailedException('Unable to transform value for property path "'.$this->getPropertyPath().'": '.$exception->getMessage(), $exception->getCode(), $exception);
+            throw new TransformationFailedException(


should be kept on one line

also, not sure if we really need this change

not sure if we really need this change

Well, we need to forward the invalid message and parameters to the new exception, otherwise it's just vanished. What did you mean?

src/Symfony/Component/Form/Form.php

fabpot · 2019-03-24T19:32:33Z

@ogizanagi @HeahDude I think we need to take a decision here. Finish/merge or close?

ogizanagi

I still think this is valuable and doesn't bring much complexity.

ogizanagi · 2019-03-24T21:51:03Z

src/Symfony/Component/Form/Form.php

@@ -1050,7 +1050,13 @@ private function modelToNorm($value)
                $value = $transformer->transform($value);
            }
        } catch (TransformationFailedException $exception) {
-            throw new TransformationFailedException('Unable to transform value for property path "'.$this->getPropertyPath().'": '.$exception->getMessage(), $exception->getCode(), $exception);
+            throw new TransformationFailedException(


not sure if we really need this change

Well, we need to forward the invalid message and parameters to the new exception, otherwise it's just vanished. What did you mean?

…isplay

ogizanagi · 2019-03-26T21:44:07Z

(PR rebased)

fabpot · 2019-03-27T06:26:40Z

Thank you @ogizanagi.

@webmozart

…ng message to display (ogizanagi) This PR was merged into the 4.3-dev branch. Discussion ---------- [Form] TransformationFailedException: Support specifying message to display | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #22501 | License | MIT | Doc PR | N/A Currently, a failed transformation can't display a very accurate message, as it only uses the value of the `invalid_message` option. I suggest to add more flexibility, somehow the same way we did for `CustomUserMessageAuthenticationException`. A test case in `FormTypeTest` shows a use-case based on @webmozart's [blog post about value/immutable objects in Symfony forms](https://webmozart.io/blog/2015/09/09/value-objects-in-symfony-forms/). ~I named the exception properties and methods the same way as for `CustomUserMessageAuthenticationException`, but do you think the followings would be better:~ - ~`setSafeMessage` ➜ `setInvalidMessage`~ - ~`getMessageKey` ➜ `getInvalidMessageKey`~ - ~`getMessageData` ➜ `getInvalidMessageParameters`~ ~in order to echoes `invalid_message` and `invalid_message_parameters` options?~ => Replaced to use `invalidMessage` & `invalidMessageParameters` Commits ------- d11055c [Form] TransformationFailedException: Support specifying message to display

carsonbot added Status: Needs Review Form Feature labels Dec 18, 2016

HeahDude reviewed Dec 18, 2016

View reviewed changes

src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php Show resolved Hide resolved

nicolas-grekas added this to the 3.x milestone Dec 26, 2016

xabbuh reviewed Dec 30, 2016

View reviewed changes

src/Symfony/Component/Form/Exception/TransformationFailedException.php Outdated Show resolved Hide resolved

xabbuh reviewed Dec 30, 2016

View reviewed changes

src/Symfony/Component/Form/Exception/TransformationFailedException.php Outdated Show resolved Hide resolved

HeahDude mentioned this pull request Jan 7, 2017

[Form] DateTimeToLocalizedStringTransformer - reverseTransform returns wrong \DateTime Object #20578

Closed

ogizanagi mentioned this pull request Apr 22, 2017

Forms, DataTransformer: Allow multiple invalid_messages when using data transformers #22501

Closed

ogizanagi changed the base branch from master to 3.4 May 17, 2017 18:32

nicolas-grekas modified the milestones: 3.4, 4.1 Oct 8, 2017

nicolas-grekas modified the milestones: 4.1, next Apr 20, 2018

ogizanagi closed this Oct 31, 2018

ogizanagi deleted the feature/form/trans_failed_ex_safe_message branch October 31, 2018 17:41

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

ogizanagi restored the feature/form/trans_failed_ex_safe_message branch November 5, 2018 23:23

ogizanagi reopened this Nov 5, 2018

ogizanagi removed this from the 4.2 milestone Nov 9, 2018

ogizanagi added this to the next milestone Nov 9, 2018

ogizanagi changed the base branch from 3.4 to master November 9, 2018 07:30

xabbuh reviewed Nov 10, 2018

View reviewed changes

ogizanagi commented Mar 24, 2019

View reviewed changes

[Form] TransformationFailedException: Support specifying message to d…

d11055c

…isplay

fabpot approved these changes Mar 27, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Mar 27, 2019

fabpot merged commit d11055c into symfony:master Mar 27, 2019

ogizanagi deleted the feature/form/trans_failed_ex_safe_message branch March 27, 2019 06:53

ogizanagi mentioned this pull request Mar 27, 2019

[Form] Allow to customize error message according to data transformer failures #9891

Closed

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

fabpot mentioned this pull request May 9, 2019

Release v4.3.0-BETA1 #31435

Merged

javiereguiluz mentioned this pull request May 10, 2019

[Form] TransformationFailedException: Support specifying message to display symfony/symfony-docs#11559

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Form] TransformationFailedException: Support specifying message to display #20978

[Form] TransformationFailedException: Support specifying message to display #20978

ogizanagi commented Dec 18, 2016 •

edited

Loading

ogizanagi commented Jul 6, 2017

HeahDude commented Jul 6, 2017

nicolas-grekas commented Oct 8, 2017

fabpot commented Mar 31, 2018

xabbuh commented Sep 15, 2018

ogizanagi commented Sep 15, 2018

xabbuh commented Oct 9, 2018 •

edited

Loading

ogizanagi commented Nov 5, 2018

nicolas-grekas commented Nov 8, 2018

ogizanagi commented Nov 9, 2018

xabbuh Nov 10, 2018

xabbuh Nov 10, 2018

ogizanagi Mar 24, 2019

fabpot commented Mar 24, 2019

ogizanagi left a comment

ogizanagi Mar 24, 2019

ogizanagi commented Mar 26, 2019

fabpot commented Mar 27, 2019

[Form] TransformationFailedException: Support specifying message to display #20978

[Form] TransformationFailedException: Support specifying message to display #20978

Conversation

ogizanagi commented Dec 18, 2016 • edited Loading

ogizanagi commented Jul 6, 2017

HeahDude commented Jul 6, 2017

nicolas-grekas commented Oct 8, 2017

fabpot commented Mar 31, 2018

xabbuh commented Sep 15, 2018

ogizanagi commented Sep 15, 2018

xabbuh commented Oct 9, 2018 • edited Loading

ogizanagi commented Nov 5, 2018

nicolas-grekas commented Nov 8, 2018

ogizanagi commented Nov 9, 2018

xabbuh Nov 10, 2018

Choose a reason for hiding this comment

xabbuh Nov 10, 2018

Choose a reason for hiding this comment

ogizanagi Mar 24, 2019

Choose a reason for hiding this comment

fabpot commented Mar 24, 2019

ogizanagi left a comment

Choose a reason for hiding this comment

ogizanagi Mar 24, 2019

Choose a reason for hiding this comment

ogizanagi commented Mar 26, 2019

fabpot commented Mar 27, 2019

ogizanagi commented Dec 18, 2016 •

edited

Loading

xabbuh commented Oct 9, 2018 •

edited

Loading