8000 [Form] Update FormEvents Data and Form Data description by alamirault · Pull Request #18934 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[Form] Update FormEvents Data and Form Data description #18934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 5, 2023
Merged

[Form] Update FormEvents Data and Form Data description #18934

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 40 additions & 35 deletions form/events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,14 @@ The method :method:`Form::setData() <Symfony\\Component\\Form\\Form::setData>`
is locked since the event is dispatched from it and will throw an exception
if called from a listener.

=============== ========
Data Type Value
=============== ========
Model 8000 data ``null``
Normalized data ``null``
View data ``null``
=============== ========
==================== ======================================
Data Type Value
==================== ======================================
Event data Model data injected into ``setData()``
Form model data ``null``
Form normalized data ``null``
Form view data ``null``
==================== ======================================

.. seealso::

Expand All @@ -98,13 +99,14 @@ The ``FormEvents::POST_SET_DATA`` event is dispatched at the end of the
method. This event can be used to modify a form depending on the populated data
(adding or removing fields dynamically).

=============== ====================================================
Data Type Value
=============== ====================================================
Model data Model data injected into ``setData()``
Normalized data Model data transformed using a model transformer
View data Normalized data transformed using a view transformer
=============== ====================================================
==================== ====================================================
Data Type Value
==================== ====================================================
Event data Model data injected into ``setData()``
Form model data Model data injected into ``setData()``
Form normalized data Model data transformed using a model transformer
Form view data Normalized data transformed using a view transformer
==================== ====================================================

.. seealso::

Expand Down Expand Up @@ -144,13 +146,14 @@ It can be used to:
* Change data from the request, before submitting the data to the form;
* Add or remove form fields, before submitting the data to the form.

=============== ========================================
Data Type Value
=============== ========================================
Model data Same as in ``FormEvents::POST_SET_DATA``
Normalized data Same as in ``FormEvents::POST_SET_DATA``
View data Same as in ``FormEvents::POST_SET_DATA``
=============== ========================================
==================== ========================================
Data Type Value
==================== ========================================
Event data Data from the request
Form model data Same as in ``FormEvents::POST_SET_DATA``
Form normalized data Same as in ``FormEvents::POST_SET_DATA``
Form view data Same as in ``FormEvents::POST_SET_DATA``
==================== ========================================

.. seealso::

Expand All @@ -175,13 +178,14 @@ transforms back the normalized data to the model and view data.

It can be used to change data from the normalized representation of the data.

=============== ===================================================================================
Data Type Value
=============== ===================================================================================
Model data Same as in ``FormEvents::POST_SET_DATA``
Normalized data Data from the request reverse-transformed from the request using a view transformer
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is reported by the issue. Indeed this value is not yet in $event->getForm()->getNormData() but it's given in $event->getData()

View data Same as in ``FormEvents::POST_SET_DATA``
=============== ===================================================================================
==================== ===================================================================================
Data Type Value
==================== ===================================================================================
Event data Data from the request reverse-transformed from the request using a view transformer
Form model data Same as in ``FormEvents::POST_SET_DATA``
Form normalized data Same as in ``FormEvents::POST_SET_DATA``
Form view data Same as in ``FormEvents::POST_SET_DATA``
==================== ===================================================================================

.. seealso::

Expand All @@ -207,13 +211,14 @@ model and view data have been denormalized.

It can be used to fetch data after denormalization.

=============== =============================================================
Data Type Value
=============== =============================================================
Model data Normalized data reverse-transformed using a model transformer
Normalized data Same as in ``FormEvents::SUBMIT``
View data Normalized data transformed using a view transformer
=============== =============================================================
==================== ===================================================================================
Data Type Value
==================== ===================================================================================
Event data Normalized data transformed using a view transformer
Form model data Normalized data reverse-transformed using a model transformer
Form normalized data Data from the request reverse-transformed from the request using a view transformer
Form view data Normalized data transformed using a view transformer
==================== ===================================================================================

.. seealso::

Expand Down
0