114 lines
4.0 KiB
PHP
114 lines
4.0 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Form;
|
|
|
|
use Symfony\Component\Form\Event\PostSetDataEvent;
|
|
use Symfony\Component\Form\Event\PostSubmitEvent;
|
|
use Symfony\Component\Form\Event\PreSetDataEvent;
|
|
use Symfony\Component\Form\Event\PreSubmitEvent;
|
|
use Symfony\Component\Form\Event\SubmitEvent;
|
|
|
|
/**
|
|
* To learn more about how form events work check the documentation
|
|
* entry at {@link https://symfony.com/doc/any/components/form/form_events.html}.
|
|
*
|
|
* To learn how to dynamically modify forms using events check the cookbook
|
|
* entry at {@link https://symfony.com/doc/any/cookbook/form/dynamic_form_modification.html}.
|
|
*
|
|
* @author Bernhard Schussek <bschussek@gmail.com>
|
|
*/
|
|
final class FormEvents
|
|
{
|
|
/**
|
|
* The PRE_SUBMIT event is dispatched at the beginning of the Form::submit() method.
|
|
*
|
|
* 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.
|
|
*
|
|
* @Event("Symfony\Component\Form\Event\PreSubmitEvent")
|
|
*/
|
|
public const PRE_SUBMIT = 'form.pre_submit';
|
|
|
|
/**
|
|
* The SUBMIT event is dispatched after the Form::submit() method
|
|
* has changed the view data by the request data, or submitted and mapped
|
|
* the children if the form is compound, and after reverse transformation
|
|
* to normalized representation.
|
|
*
|
|
* It's also dispatched just before the Form::submit() method transforms back
|
|
* the normalized data to the model and view data.
|
|
*
|
|
* So at this stage children of compound forms are submitted and synchronized, unless
|
|
* their transformation failed, but a parent would still be at the PRE_SUBMIT level.
|
|
*
|
|
* Since the current form is not synchronized yet, it is still possible to add and
|
|
* remove fields.
|
|
*
|
|
* @Event("Symfony\Component\Form\Event\SubmitEvent")
|
|
*/
|
|
public const SUBMIT = 'form.submit';
|
|
|
|
/**
|
|
* The FormEvents::POST_SUBMIT event is dispatched at the very end of the Form::submit().
|
|
*
|
|
* It this stage the model and view data may have been denormalized. Otherwise the form
|
|
* is desynchronized because transformation failed during submission.
|
|
*
|
|
* It can be used to fetch data after denormalization.
|
|
*
|
|
* The event attaches the current view data. To know whether this is the renormalized data
|
|
* or the invalid request data, call Form::isSynchronized() first.
|
|
*
|
|
* @Event("Symfony\Component\Form\Event\PostSubmitEvent")
|
|
*/
|
|
public const POST_SUBMIT = 'form.post_submit';
|
|
|
|
/**
|
|
* The FormEvents::PRE_SET_DATA event is dispatched at the beginning of the Form::setData() method.
|
|
*
|
|
* It can be used to:
|
|
* - Modify the data given during pre-population;
|
|
* - Keep synchronized the form depending on the data (adding or removing fields dynamically).
|
|
*
|
|
* @Event("Symfony\Component\Form\Event\PreSetDataEvent")
|
|
*/
|
|
public const PRE_SET_DATA = 'form.pre_set_data';
|
|
|
|
/**
|
|
* The FormEvents::POST_SET_DATA event is dispatched at the end of the Form::setData() method.
|
|
*
|
|
* This event can be used to modify the form depending on the final state of the underlying data
|
|
* accessible in every representation: model, normalized and view.
|
|
*
|
|
* @Event("Symfony\Component\Form\Event\PostSetDataEvent")
|
|
*/
|
|
public const POST_SET_DATA = 'form.post_set_data';
|
|
|
|
/**
|
|
* Event aliases.
|
|
*
|
|
* These aliases can be consumed by RegisterListenersPass.
|
|
*/
|
|
public const ALIASES = [
|
|
PreSubmitEvent::class => self::PRE_SUBMIT,
|
|
SubmitEvent::class => self::SUBMIT,
|
|
PostSubmitEvent::class => self::POST_SUBMIT,
|
|
PreSetDataEvent::class => self::PRE_SET_DATA,
|
|
PostSetDataEvent::class => self::POST_SET_DATA,
|
|
];
|
|
|
|
private function __construct()
|
|
{
|
|
}
|
|
}
|