Merge pull request #138 from sumocoders/add-min-max-to-collection-items

Add a min and max var to collection types

Author: Bjorn Van Acker

src/Form/Extension/CollectionTypeExtension.php

@@ -3,10 +3,14 @@
 namespace SumoCoders\FrameworkCoreBundle\Form\Extension;
 
 use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\FormView;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Form\Extension\Core\Type\CollectionType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormError;
 
 final class CollectionTypeExtension extends AbstractTypeExtension
 {
@@ -24,13 +28,57 @@ public function configureOptions(OptionsResolver $resolver): void
             [
                 'allow_drag_and_drop' => true,
                 'add_button_label' => 'forms.buttons.addItem',
+                'minimum_required_items' => 0,
+                'maximum_required_items' => null,
+                'error_bubbling' => false,
             ]
         );
     }
 
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        parent::buildForm($builder, $options);
+
+        if ($options['minimum_required_items'] < 0) {
+            throw new \InvalidArgumentException('minimum_required_items cannot be lower than 0');
+        }
+
+        if ($options['maximum_required_items'] !== null && $options['maximum_required_items'] < $options['minimum_required_items']) {
+            throw new \InvalidArgumentException('maximum_required_items cannot be lower than minimum_required_items');
+        }
+
+        $builder->addEventListener(FormEvents::POST_SUBMIT, function(FormEvent $event) {
+            $form = $event->getForm();
+            $min = $form->getConfig()->getOption('minimum_required_items');
+            $max = $form->getConfig()->getOption('maximum_required_items');
+
+            if ($form->count() < $min) {
+                $error = new FormError(
+                    message: 'You must add at least '.$min.' items',
+                    messageTemplate: 'You must add at least %count% items',
+                    messageParameters: ['%count%' => $min]
+                );
+                $error->setOrigin($form);
+                $form->addError($error);
+            }
+
+            if ($max !== null && $form->count() > $max) {
+                $error = new FormError(
+                    message: 'You can add a maximum of '.$max.' items',
+                    messageTemplate: 'You can add a maximum of %count% items',
+                    messageParameters: ['%count%' => $max]
+                );
+                $error->setOrigin($form);
+                $form->addError($error);
+            }
+        });
+    }
+
     public function buildView(FormView $view, FormInterface $form, array $options): void
     {
         $view->vars['allow_drag_and_drop'] = $options['allow_drag_and_drop'];
         $view->vars['add_button_label'] = $options['add_button_label'];
+        $view->vars['minimum_required_items'] = $options['minimum_required_items'];
+        $view->vars['maximum_required_items'] = $options['maximum_required_items'];
     }
 }

templates/Form/fields.html.twig

@@ -80,6 +80,7 @@
     {% set attr = attr|merge({'data-allow-remove': allow_delete ? 1 : 0}) %}
     {% set attr = attr|merge({'data-name-prefix': full_name}) %}
     {% set attr = attr|merge({'data-role': 'collection'}) %}
+    {% set attr = attr|merge({'data-min': minimum_required_items, 'data-max': maximum_required_items}) %}
 
     <div
       {{ block('widget_container_attributes') }}

translations/validators.en.yml

@@ -2,3 +2,6 @@ forms:
   not_blank: This field is required.
   url: This is not a valid URL.
   email: This is not a valid e-mail address.
+
+You can add a maximum of %count% items: You can add a maximum of %count% items.
+You must add at least %count% items: You must add at least %count% items.

translations/validators.nl.yml

@@ -2,3 +2,6 @@ forms:
   not_blank: Dit veld is verplicht.
   url: Dit is geen geldige URL.
   email: Dit is geen geldige e-mailadres.
+
+You can add a maximum of %count% items: Je kan maximaal %count% items toevoegen.
+You must add at least %count% items: Je moet minimaal %count% items toevoegen.