From 6fccc70e417c10d2cf06922475c9282cfb2466b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 13 Oct 2021 23:02:53 +0200 Subject: [PATCH] add some doc [ci-skip] --- .../Form/Type/PickAddressType.php | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/Bundle/ChillMainBundle/Form/Type/PickAddressType.php b/src/Bundle/ChillMainBundle/Form/Type/PickAddressType.php index c2f46a5aa..efd117b96 100644 --- a/src/Bundle/ChillMainBundle/Form/Type/PickAddressType.php +++ b/src/Bundle/ChillMainBundle/Form/Type/PickAddressType.php @@ -11,6 +11,24 @@ use Symfony\Component\Form\FormInterface; use Symfony\Component\Form\FormView; use Symfony\Component\OptionsResolver\OptionsResolver; +/** + * Form type for picking an address. + * + * In the UI, this resolve to a vuejs component which will insert the created address id into the + * hidden's value. It will also allow to edit existing addresses without changing the id. + * + * In every page where this component is shown, you must include the required module: + * + * ```twig + * {% block js %} + * {{ encore_entry_script_tags('mod_input_address') }} + * {% endblock %} + * + * {% block css %} + * {{ encore_entry_link_tags('mod_input_address') }} + * {% endblock %} + * ``` + */ final class PickAddressType extends AbstractType { private AddressToIdDataTransformer $addressToIdDataTransformer;