From 1ba5f993c759ac41cab4b49c036125a6453bc060 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20ALFAIATE?= Date: Fri, 26 Aug 2022 13:58:16 +0700 Subject: [PATCH] [Form] Introduce validation events documentation --- form/events.rst | 49 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 40 insertions(+), 9 deletions(-) diff --git a/form/events.rst b/form/events.rst index a99698aa247..2dd6ea1db0d 100644 --- a/form/events.rst +++ b/form/events.rst @@ -228,6 +228,35 @@ View data Normalized data transformed using a view transformer subscribes to the ``FormEvents::POST_SUBMIT`` event in order to automatically validate the denormalized object. +3) Validating the Form (``ValidatorFormEvents::PRE_VALIDATE`` and ``ValidatorFormEvents::POST_VALIDATE``) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Form validation is triggered by the ``FormEvents::POST_SUBMIT`` event of the root form. +Two events are dispatched when Form validation is triggered: +``ValidatorFormEvents::PRE_VALIDATE``, ``ValidatorFormEvents::POST_VALIDATE``. + +A) The ``ValidatorFormEvents::PRE_VALIDATE`` Event +.................................................. + +The ``ValidatorFormEvents::PRE_VALIDATE`` event is dispatched at the beginning of the +Form validation. + +.. seealso:: + + See all form events at a glance in the + :ref:`Form Events Information Table `. + +B) The ``ValidatorFormEvents::POST_VALIDATE`` Event +................................................... + +The ``ValidatorFormEvents::POST_VALIDATE`` event is dispatched after the +the entire form has been validated. + +.. seealso:: + + See all form events at a glance in the + :ref:`Form Events Information Table `. + Registering Event Listeners or Event Subscribers ------------------------------------------------ @@ -244,15 +273,17 @@ processed. .. _component-form-event-table: -====================== ============================= =============== -Name ``FormEvents`` Constant Event's Data -====================== ============================= =============== -``form.pre_set_data`` ``FormEvents::PRE_SET_DATA`` Model data -``form.post_set_data`` ``FormEvents::POST_SET_DATA`` Model data -``form.pre_submit`` ``FormEvents::PRE_SUBMIT`` Request data -``form.submit`` ``FormEvents::SUBMIT`` Normalized data -``form.post_submit`` ``FormEvents::POST_SUBMIT`` View data -====================== ============================= =============== +====================== ====================================== =============== +Name ``FormEvents`` Constant Event's Data +====================== ====================================== =============== +``form.pre_set_data`` ``FormEvents::PRE_SET_DATA`` Model data +``form.post_set_data`` ``FormEvents::POST_SET_DATA`` Model data +``form.pre_submit`` ``FormEvents::PRE_SUBMIT`` Request data +``form.submit`` ``FormEvents::SUBMIT`` Normalized data +``form.post_submit`` ``FormEvents::POST_SUBMIT`` View data +``form.pre_validate`` ``ValidatorFormEvents::PRE_VALIDATE`` View data +``form.post_validate`` ``ValidatorFormEvents::POST_VALIDATE`` View data +====================== ====================================== =============== Event Listeners ~~~~~~~~~~~~~~~