Merge pull request #26 from LinioIT/feat/DIS-735-improve-features-of-born-date-type

[DIS-735] feat: improve features of birth date type

Author: klaussilveira

.php-cs-fixer.php

@@ -37,4 +37,4 @@
     ])
     ->setFinder($finder)
     ->setUsingCache(true)
-    ->setRiskyAllowed(true);
+    ->setRiskyAllowed(true);

README.md

@@ -91,6 +91,34 @@ dynamic_form:
 ### Options
 Field options are the same as symfony, refer to the documentation
 
+#### Birthday Type
+
+Supports `Symfony >= 4.4`.
+
+In addition to the own options that the field brings by default ([see documentation](https://symfony.com/doc/current/reference/forms/types/birthday.html)), we added 3 new attributes to make its behavior more flexible.
+
+##### minAgeAllowed and maxAgeAllowed:
+
+These options work together and it is an improvement to the `years` option because it is too strict to only receive an array with the allowed years (and that in our case we should leave static in our Yaml file). With them we can determine (taking the current date) the minimum and maximum number of ages to generate the years that will be displayed in the form. These options only accept whole numbers greater than or equal to zero.
+
+For example, if we want to have a field of type `birthday` but we only want children who have between **5** and **10** years of life to be registered, we would have something like the following:
+
+```yaml
+dynamic_form:
+    new_user:
+        birthday:
+            enabled: true
+            type: birthday
+            options:
+                minAgeAllowed: 5
+                maxAgeAllowed: 10
+```
+
+The above would generate this array of `years` => `[2016, 2015, 2014, 2013, 2012, 2011]` taking into account `2021` as the current year.
+
+##### Order:
+
+This option is used together with `minAgeAllowed` and `maxAgeAllowed` and is for the cases where we want to show our drop-down list of years in one order or another. The accepted values are **`asc`** and **`desc`**, the latter by default.
 
 ### Transformers
 

composer.json

@@ -33,4 +33,4 @@
       "@phpunit"
     ]
   }
-}
+}

src/Exception/InvalidConfigurationException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Linio\DynamicFormBundle\Exception;
+
+class InvalidConfigurationException extends DynamicFormException
+{
+}

src/Exception/NumberFormatException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Linio\DynamicFormBundle\Exception;
+
+class NumberFormatException extends DynamicFormException
+{
+}

src/Form/Extension/BirthdayTypeExtension.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Linio\DynamicFormBundle\Form\Extension;
+
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Extension\Core\Type\BirthdayType;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\FormView;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class BirthdayTypeExtension extends AbstractTypeExtension
+{
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefined(['order', 'minAgeAllowed', 'maxAgeAllowed']);
+    }
+
+    public function buildView(FormView $view, FormInterface $form, array $options): void
+    {
+        $view->vars['order'] = $options['order'] ?? '';
+        $view->vars['minAgeAllowed'] = $options['minAgeAllowed'] ?? '';
+        $view->vars['maxAgeAllowed'] = $options['maxAgeAllowed'] ?? '';
+    }
+
+    public static function getExtendedTypes(): iterable
+    {
+        return [BirthdayType::class];
+    }
+}

src/FormlyMapper/FormlyField/BirthdayField.php

@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Linio\DynamicFormBundle\FormlyMapper\FormlyField;
+
+use Linio\DynamicFormBundle\Exception\InvalidConfigurationException;
+use Linio\DynamicFormBundle\Exception\NumberFormatException;
+use Linio\DynamicFormBundle\FormlyMapper\FormlyField;
+
+class BirthdayField extends FormlyField
+{
+    const ORDER_ASC = 'asc';
+    const ORDER_DESC = 'desc';
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getFieldType()
+    {
+        return 'birthday';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function buildFieldTypeConfiguration(): void
+    {
+        $options = $this->fieldConfiguration['options'];
+
+        $this->validateNumberFormatForSpecificRangeOfYearsArray($options);
+        $this->validateMaxAgeAllowedIsLargerThanMinAgeAllowed($options);
+
+        $this->formlyFieldConfiguration['templateOptions']['type'] = $this->getFieldType();
+
+        $order = isset($options['order']) && (strtolower($options['order']) == (self::ORDER_ASC || self::ORDER_DESC))
+        ? $options['order']
+        : self::ORDER_DESC;
+
+        unset($this->formlyFieldConfiguration['templateOptions']['order']);
+
+        if (!isset($options['minAgeAllowed']) || !isset($options['maxAgeAllowed'])
+            || !is_numeric($options['minAgeAllowed']) || !is_numeric($options['maxAgeAllowed'])
+            || $options['minAgeAllowed'] < 0 || $options['maxAgeAllowed'] < 0) {
+            $this->removeAgeAllowedFromTemplateOptions();
+
+            return;
+        }
+
+        $yearsRange = range(date('Y') - $options['minAgeAllowed'], date('Y') - $options['maxAgeAllowed']);
+
+        $this->formlyFieldConfiguration['templateOptions']['years'] = ($order == self::ORDER_ASC)
+            ? array_reverse($yearsRange)
+            : $yearsRange;
+
+        $this->removeAgeAllowedFromTemplateOptions();
+    }
+
+    private function removeAgeAllowedFromTemplateOptions(): void
+    {
+        unset($this->formlyFieldConfiguration['templateOptions']['minAgeAllowed']);
+        unset($this->formlyFieldConfiguration['templateOptions']['maxAgeAllowed']);
+    }
+
+    private function validateNumberFormatForSpecificRangeOfYearsArray(array $options): void
+    {
+        if (!isset($options['years'])) {
+            return;
+        }
+
+        foreach ($options['years'] as $key => $year) {
+            if (!is_numeric($year)) {
+                throw new NumberFormatException(sprintf('The year "%s" does not have a valid number format.', $year));
+            }
+
+            $options['years'][$key] = (int) $year;
+        }
+    }
+
+    private function validateMaxAgeAllowedIsLargerThanMinAgeAllowed(array $options): void
+    {
+        if (!isset($options['minAgeAllowed']) || !isset($options['maxAgeAllowed'])) {
+            return;
+        }
+
+        if ($options['minAgeAllowed'] > $options['maxAgeAllowed']) {
+            throw new InvalidConfigurationException(sprintf('The value of minAgeAllowed (%s) cannot be greater than maxAgeAllowed (%s).', $options['minAgeAllowed'], $options['maxAgeAllowed']));
+        }
+    }
+}

src/Resources/config/services.yml

@@ -15,6 +15,12 @@ services:
     container.formly_field:
         class: Linio\DynamicFormBundle\FormlyMapper\FormlyField\FormlyFieldFactory
 
+    formly_field.birthday:
+        class: Linio\DynamicFormBundle\FormlyMapper\FormlyField\BirthdayField
+        lazy: true
+        tags:
+            - {name: formly_field, alias: birthday}
+
     formly_field.choice:
         class: Linio\DynamicFormBundle\FormlyMapper\FormlyField\ChoiceField
         lazy: true
@@ -109,3 +115,8 @@ services:
         class: Linio\DynamicFormBundle\Form\Extension\HelpMessageTypeExtension
         tags:
             - {name: form.type_extension, extended_type: Symfony\Component\Form\Extension\Core\Type\FormType}
+
+    form.type_extension.birthday:
+        class: Linio\DynamicFormBundle\Form\Extension\BirthdayTypeExtension
+        tags:
+            - {name: form.type_extension, extended_type: Symfony\Component\Form\Extension\Core\Type\BirthdayType}