add type, count, choice constraint, add format option to date fields (#380)

solverat · web-flow · commit c4d134266dd4 · 2023-03-03T13:20:55.000+01:00
* add type, count, choice constraint, add format option to date fields
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,13 @@
 # Upgrade Notes
 
+## Version 4.4.0
+- **[ENHANCEMENT]**: Added `format` option to `Birthday`, `DateTime` and `DateField`
+- **[ENHANCEMENT]**: Translate all non-default constraints messages (Key contains `message`)
+- **[ENHANCEMENT]**: New Constraints added:
+  - `Symfony\Component\Validator\Constraints\Type`
+  - `Symfony\Component\Validator\Constraints\Count`
+  - `Symfony\Component\Validator\Constraints\Choice`
+
 ## Version 4.3.2
 - **[BUGFIX]**: Assert valid timezone in date time fallback output transformer
 
diff --git a/src/FormBuilderBundle/Builder/FrontendFormBuilder.php b/src/FormBuilderBundle/Builder/FrontendFormBuilder.php
@@ -101,8 +101,9 @@ public function buildForm(FormDefinitionInterface $formDefinition, array $formRu
     private function addFormAttributes(array $currentAttributes, array $attributes): array
     {
         foreach ($attributes as $attribute) {
+
             // legacy
-            if (!isset($attribute['option']) || is_null($attribute['option'])) {
+            if (!isset($attribute['option'])) {
                 continue;
             }
 
diff --git a/src/FormBuilderBundle/Configuration/Configuration.php b/src/FormBuilderBundle/Configuration/Configuration.php
@@ -102,24 +102,43 @@ public function getAvailableConstraints(): array
                 continue;
             }
 
+            $constraintParameters = $refClass->getConstructor()?->getParameters();
             $defaultProperties = $refClass->getDefaultProperties();
             $constraintConfig = [];
+
             foreach ($refClass->getProperties(\ReflectionProperty::IS_PUBLIC) as $refProperty) {
+
                 $propertyName = $refProperty->getName();
 
                 if (in_array($propertyName, $invalidProperties)) {
                     continue;
                 }
 
-                if (isset($defaultProperties[$propertyName])) {
+                $constructorParameters = array_values(array_filter($constraintParameters ?? [], static function (\ReflectionParameter $parameter) use ($propertyName) {
+                    return $parameter->getName() === $propertyName;
+                }));
+
+                $constructorParameterType = null;
+                if (count($constructorParameters) > 0) {
+                    /** @var \ReflectionParameter $constructorParameter */
+                    $constructorParameter = $constructorParameters[0];
+                    if ($constructorParameter->hasType() && $constructorParameter->getType() instanceof \ReflectionNamedType) {
+                        $constructorParameterType = $constructorParameter->getType()->getName();
+                    }
+                }
+
+                if ($constructorParameterType !== null) {
+                    $defaultValue = $defaultProperties[$propertyName] ?? null;
+                    $type = $constructorParameterType;
+                } elseif (isset($defaultProperties[$propertyName])) {
                     $defaultValue = $defaultProperties[$propertyName];
                     $type = gettype($defaultValue);
                 } else {
                     $defaultValue = null;
                     $type = 'string';
                 }
 
-                if ($defaultValue === null || in_array(gettype($defaultValue), ['string', 'boolean', 'integer'])) {
+                if ($defaultValue === null || in_array(gettype($defaultValue), ['string', 'boolean', 'bool', 'integer', 'int', 'array'])) {
                     $constraintConfig[] = [
                         'name'         => $propertyName,
                         'type'         => $type,
diff --git a/src/FormBuilderBundle/Migrations/Version20230303094642.php b/src/FormBuilderBundle/Migrations/Version20230303094642.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FormBuilderBundle\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+use FormBuilderBundle\Tool\Install;
+use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+
+final class Version20230303094642 extends AbstractMigration
+{
+    use ContainerAwareTrait;
+
+    public function doesSqlMigrations(): bool
+    {
+        return false;
+    }
+
+    public function up(Schema $schema): void
+    {
+        $installer = $this->container->get(Install::class);
+        $installer->updateTranslations();
+    }
+
+    public function down(Schema $schema): void
+    {
+        // nothing to do
+    }
+}
diff --git a/src/FormBuilderBundle/Resources/config/backend/base_config.yml b/src/FormBuilderBundle/Resources/config/backend/base_config.yml
@@ -134,4 +134,16 @@ form_builder:
         time:
             class: Symfony\Component\Validator\Constraints\Time
             label: 'form_builder_validation_constraint.time'
+            icon_class: form_builder_icon_validation
+        type:
+            class: Symfony\Component\Validator\Constraints\Type
+            label: 'form_builder_validation_constraint.type'
+            icon_class: form_builder_icon_validation
+        count:
+            class: Symfony\Component\Validator\Constraints\Count
+            label: 'form_builder_validation_constraint.count'
+            icon_class: form_builder_icon_validation
+        choice:
+            class: Symfony\Component\Validator\Constraints\Choice
+            label: 'form_builder_validation_constraint.choice'
             icon_class: form_builder_icon_validation
diff --git a/src/FormBuilderBundle/Resources/config/types/type/birthday.yml b/src/FormBuilderBundle/Resources/config/types/type/birthday.yml
@@ -27,6 +27,11 @@ form_builder:
                                 - ['Choice', 'choice']
                                 - ['Text', 'text']
                                 - ['Single Text', 'single_text']
+                    options.format:
+                        display_group_id: attributes
+                        type: textfield
+                        label: 'form_builder_type_field.date_format'
+                        config: ~
                     options.days:
                         display_group_id: attributes
                         type: tagfield
diff --git a/src/FormBuilderBundle/Resources/config/types/type/date.yml b/src/FormBuilderBundle/Resources/config/types/type/date.yml
@@ -27,6 +27,11 @@ form_builder:
                                 - ['Choice', 'choice']
                                 - ['Text', 'text']
                                 - ['Single Text', 'single_text']
+                    options.format:
+                        display_group_id: attributes
+                        type: textfield
+                        label: 'form_builder_type_field.date_format'
+                        config: ~
                     options.days:
                         display_group_id: attributes
                         type: tagfield
diff --git a/src/FormBuilderBundle/Resources/config/types/type/date_time.yml b/src/FormBuilderBundle/Resources/config/types/type/date_time.yml
@@ -36,6 +36,11 @@ form_builder:
                                 - ['Choice', 'choice']
                                 - ['Text', 'text']
                                 - ['Single Text', 'single_text']
+                    options.format:
+                        display_group_id: attributes
+                        type: textfield
+                        label: 'form_builder_type_field.format'
+                        config: ~
                     options.seconds:
                         display_group_id: attributes
                         type: tagfield
diff --git a/src/FormBuilderBundle/Resources/install/translations/admin.csv b/src/FormBuilderBundle/Resources/install/translations/admin.csv
@@ -39,6 +39,9 @@
 "form_builder_validation_constraint.iban","Iban","Iban"
 "form_builder_validation_constraint.date","Date","Datum"
 "form_builder_validation_constraint.date_time","Date & Time","Datum & Uhrzeit"
+"form_builder_validation_constraint.count","Count","Anzahl"
+"form_builder_validation_constraint.choice","Choice","Auswahl"
+"form_builder_validation_constraint.type","Type","Daten-Typ"
 "form_builder_validation_constraint.time","Time","Uhrzeit"
 "form_builder_container_type.fieldset","Fieldset","Fieldset"
 "form_builder_container_type.repeater","Repeater","Repeater"
@@ -104,6 +107,7 @@
 "form_builder_type_field.time_widget","Widget Time","Darstellung Uhrzeit"
 "form_builder_type_field.date_with_minutes","With Minutes","Minuten darstellen"
 "form_builder_type_field.date_with_seconds","With Seconds","Sekunden darstellen"
+"form_builder_type_field.date_format","Format","Format"
 "form_builder_type_field.recaptcha_v3.action_name","Action","Aktion"
 "form_builder_type_template.default","Default","Default"
 "form_builder_form_template.bootstrap_3_horizontal_layout","Bootstrap 3 Horizontal Layout","Bootstrap 3 Horizontales Layout"
diff --git a/src/FormBuilderBundle/Resources/public/js/extjs/components/formFieldConstraintComponent.js b/src/FormBuilderBundle/Resources/public/js/extjs/components/formFieldConstraintComponent.js
@@ -155,6 +155,7 @@ Formbuilder.extjs.components.formFieldConstraint = Class.create({
 
                     break;
 
+                case 'bool':
                 case 'boolean':
                     field = new Ext.form.Checkbox({
                         fieldLabel: configElement.name,
@@ -180,6 +181,7 @@ Formbuilder.extjs.components.formFieldConstraint = Class.create({
 
                     break;
 
+                case 'int':
                 case 'integer':
                     field = new Ext.form.field.Number({
                         fieldLabel: configElement.name,
@@ -201,6 +203,57 @@ Formbuilder.extjs.components.formFieldConstraint = Class.create({
                         }
                     });
 
+                    break;
+
+                case 'array':
+                    field = new Ext.form.field.Tag({
+                        fieldLabel: configElement.name,
+                        name: 'config.' + configElement.name,
+                        value: this.getFieldValue(configElement.name, configElement.defaultValue),
+                        flex: 2,
+                        queryDelay: 0,
+                        mode: 'local',
+                        displayField: 'name',
+                        valueField: 'index',
+                        store: new Ext.data.ArrayStore({
+                            fields: ['index', 'name'],
+                            data: []
+                        }),
+                        allowBlank: true,
+                        editable: true,
+                        hideTrigger: true,
+                        filterPickList: false,
+                        createNewOnBlur: true,
+                        createNewOnEnter: true,
+                        selectOnFocus: false,
+                        forceSelection: true,
+                        style: opacityStyle,
+                        getSubmitValue: function () {
+
+                            if (Ext.isArray(this.getValue()) && this.getValue().length === 0) {
+                                return null;
+                            }
+
+                            if (this.getValue() === configElement.defaultValue) {
+                                return null;
+                            }
+
+                            return this.value;
+                        },
+                        listeners: {
+                            change: function (field, newVal, oldVal) {
+
+                                if (Ext.isArray(this.getValue()) && this.getValue().length === 0) {
+                                    newVal = null;
+                                }
+
+                                console.warn(newVal, configElement.defaultValue);
+
+                                field.setStyle('opacity', newVal !== configElement.defaultValue ? 1 : 0.6);
+                            }
+                        }
+                    });
+
                     break;
             }
 
@@ -235,7 +288,7 @@ Formbuilder.extjs.components.formFieldConstraint = Class.create({
                     }
 
                     var description = t('form_builder_constraint_default_value') + ': <code>' + defaultValue + '</code>';
-                    if (configElement.name === 'message') {
+                    if (Ext.isString(configElement.name) && configElement.name.toLowerCase().indexOf('message') !== -1) {
                         description += '<br>' + t('form_builder_constraint_message_note');
                     }
 
diff --git a/src/FormBuilderBundle/Transformer/Target/TargetAwareOutputTransformer.php b/src/FormBuilderBundle/Transformer/Target/TargetAwareOutputTransformer.php
@@ -23,10 +23,6 @@ public function transform(mixed $target): mixed
             return call_user_func_array($this->callable, [$this->targetAwareData]);
         }
 
-        if (is_array($this->callable)) {
-            return call_user_func_array($this->callable, [$this->targetAwareData]);
-        }
-
-        return null;
+        return call_user_func_array($this->callable, [$this->targetAwareData]);
     }
 }
diff --git a/src/FormBuilderBundle/Validation/ConditionalLogic/Dispatcher/Module/Constraints.php b/src/FormBuilderBundle/Validation/ConditionalLogic/Dispatcher/Module/Constraints.php
@@ -106,32 +106,32 @@ private function checkConditionalLogicConstraints(array $defaultFieldConstraints
             }
         }
 
-        //$tempArr = array_unique(array_column($defaultFieldConstraints, 'type'));
-        //array_intersect_key($defaultFieldConstraints, $tempArr);
-
         return $defaultFieldConstraints;
     }
 
     private function appendConstraintsData(array $constraints): array
     {
         $constraintData = [];
         foreach ($constraints as $constraint) {
+
             $constraintType = $constraint['type'];
-            $constraintConfig = isset($constraint['config']) ? $constraint['config'] : [];
+            $constraintConfig = $constraint['config'] ?? [];
 
             if (!isset($this->availableConstraints[$constraintType])) {
                 continue;
             }
 
             $constraintInfo = $this->availableConstraints[$constraintType];
 
-            //translate custom message.
-            if (isset($constraintConfig['message']) && !empty($constraintConfig['message'])) {
-                $configKey = array_search('message', array_column($constraintInfo['config'], 'name'), true);
-                if ($configKey !== false) {
-                    $defaultMessage = $constraintInfo['config'][$configKey]['defaultValue'];
-                    if (!empty($defaultMessage) && !empty($constraintConfig['message']) && $defaultMessage !== $constraintConfig['message']) {
-                        $constraintConfig['message'] = $this->translator->trans($constraintConfig['message']);
+            // translate config properties containing "message" in configuration key
+            foreach ($constraintConfig as $messageKey => $messageData) {
+                if (str_contains(strtolower($messageKey), 'message')) {
+                    $configKey = array_search($messageKey, array_column($constraintInfo['config'], 'name'), true);
+                    if ($configKey !== false) {
+                        $defaultMessage = $constraintInfo['config'][$configKey]['defaultValue'];
+                        if (!empty($defaultMessage) && !empty($messageData) && $defaultMessage !== $messageData) {
+                            $constraintConfig[$messageKey] = $this->translator->trans($messageData);
+                        }
                     }
                 }
             }
diff --git a/src/FormBuilderBundle/Validation/ConditionalLogic/Rule/Condition/ElementValueCondition.php b/src/FormBuilderBundle/Validation/ConditionalLogic/Rule/Condition/ElementValueCondition.php
@@ -18,7 +18,11 @@ public function isValid(array $formData, int $ruleId, array $configuration = [])
             $fieldValue = $this->getFieldValue($formData, $conditionFieldName);
 
             if ($this->getComparator() === 'contains') {
-                $value = is_array($this->getValue()) ? $this->getValue() : (is_string($this->getValue()) ? explode(',', $this->getValue()) : [$this->getValue()]);
+
+                $value = $this->getValue();
+                if (!is_array($value)) {
+                    $value = is_string($this->getValue()) && str_contains($this->getValue(), ',') ? explode(',', $this->getValue()) : [$this->getValue()];
+                }
 
                 return !empty(array_intersect($value, (array) $fieldValue));
             }

Original file line number	Diff line number	Diff line change
`@@ -101,8 +101,9 @@ public function buildForm(FormDefinitionInterface $formDefinition, array $formRu`
`101`	`101`	`private function addFormAttributes(array $currentAttributes, array $attributes): array`
`102`	`102`	`{`
`103`	`103`	`foreach ($attributes as $attribute) {`
	`104`	`+`
`104`	`105`	`// legacy`
`105`		`- if (!isset($attribute['option']) \|\| is_null($attribute['option'])) {`
	`106`	`+ if (!isset($attribute['option'])) {`
`106`	`107`	`continue;`
`107`	`108`	`}`
`108`	`109`