Wrong description of normalized data in FormEvents::SUBMIT

[sb-relaxt-at]

There seems to be an error in the documentation about form events. Given our limited testing we see the following behaviour in Symfony 4.2:

FormEvents::SUBMIT / Normalized data
This contains the same data as in FormEvents::POST_SET_DATA (so it is yet not updated) - whereas the docs say "Data from the request reverse-transformed from the request using a view transformer" (which indicates that this contains the new value from the request).

FormEvents::POST_SUBMIT / Normalized data
As a subsequent error the description of FormEvents::POST_SUBMIT ("Same as in FormEvents::SUBMIT") is wrong, as it contains the data from the request.

[xabbuh]

I'd say this is rather related to your code then as both events will actually receive the submitted data but not the initial data.

[sb-relaxt-at]

Whereas the data received via the event is the submitted data, this is not true for the data retrieved from the form. We have prepared a minimal working example. If you use this type and submit a change from "initial_data" to "request_data" you will receive the following output:

FormEvents::PRE_SUBMIT

"request_data" // $event->getData()
"initial_data" // $event->getForm()->getData()
"initial_data" // $event->getForm()->getNormData()
"initial_data" // $event->getForm()->getViewData()

FormEvents::SUBMIT

"request_data" // $event->getData()
"initial_data" // $event->getForm()->getData()
"initial_data" // $event->getForm()->getNormData() (!!!)
"initial_data" // $event->getForm()->getViewData()

FormEvents::POSTSUBMIT

"request_data" // $event->getData()
"request_data" // $event->getForm()->getData()
"request_data" // $event->getForm()->getNormData()
"request_data" // $event->getForm()->getViewData()

From my understanding this corresponds to the implementation in Form.php as the norm data of the form is updated just before dispatching FormEvents::POST_SUBMIT.

[xabbuh]

That's the expected behaviour. From your initial description I thought you were talking about the getData() method of the event as that's the method being documented here.

[sb-relaxt-at]

Sorry for being ambiguous in this point. I am referring to the following description (screenshot from the docs):

The FormEvents::SUBMIT Event

I believe this to document getData(), getNormData() and getViewData() methods from $event->getForm().

[sb-relaxt-at]

@xabbuh Could you be so kind and have another look at this issue? It's about the normalized data in the submit event (example and description in previous comments).

[xabbuh]

@sb-relaxt-at This looks indeed confusing. Though I have no idea how we could improve this.

[carsonbot]

Thank you for this issue.
There has not been a lot of activity here for a while. Has this been resolved?

[carsonbot]

Hello? This issue is about to be closed if nobody replies.

[alamirault]

I created PR #18934 which update documentation