data injector, resolves #395 (#396)

Author: solverat

README.md

@@ -21,7 +21,7 @@
 
 ```json
 "require" : {
-    "dachcom-digital/formbuilder" : "~4.4.0"
+    "dachcom-digital/formbuilder" : "~4.5.0"
 }
 ```
 
@@ -74,6 +74,8 @@ Nothing to tell here, it's just [Symfony](https://symfony.com/doc/current/templa
   - [Custom Adapter](docs/DynamicMultiFile/99_CustomAdapter.md)
 - [Conditional Logic](docs/81_ConditionalLogic.md)
 - [Form & Field Attributes](docs/83_Attributes.md)
+- [Form Runtime Data](docs/85_RuntimeData.md))
+- [Form Data Injection](docs/86_FormDataInjection.md)
 - [Frontend Tips](docs/90_FrontendTips.md)
 - [FormBuilder Javascript Plugins](docs/91_Javascript.md)
 - [Configuration Flags](docs/100_ConfigurationFlags.md)

UPGRADE.md

@@ -5,6 +5,7 @@
 - **[BUGFIX]**: suppress php warning of undefined array key [@jheimbach](https://github.com/dachcom-digital/pimcore-formbuilder/pull/387)
 - **[ENHANCEMENT]**: Adds sort buttons for choices in ChoiceType [@jheimbach](https://github.com/dachcom-digital/pimcore-formbuilder/pull/388)
 - **[ENHANCEMENT]**: Allow Relation(s) in Object Channel [#390](https://github.com/dachcom-digital/pimcore-formbuilder/issues/390)
+- **[NEW FEATURE]**: Data Injectors [#395](https://github.com/dachcom-digital/pimcore-formbuilder/issues/395)
 
 ## Version 4.4.1
 - **[BUGFIX]**: [Constraint Options] ignore internal properties [#381](https://github.com/dachcom-digital/pimcore-formbuilder/pull/381)

docs/30_FormTypes.md

@@ -90,3 +90,6 @@ parameters:
         - ['label','label']
         - ['p','p']
 ```
+
+## Data Injection
+If you want to add data to your text fields, based on a specific condition (a query parameter in request for example) you may want to check out [form data injectors](./86_FormDataInjection.md).

docs/86_FormDataInjection.md

@@ -0,0 +1,88 @@
+# Form Data Injection
+![image](https://github.com/dachcom-digital/pimcore-formbuilder/assets/700119/b6375824-bfeb-4705-8de1-36f174ebb7eb)
+
+Sometimes it's required to set specific data for a given form field.
+To do that, we usually fill up the `data` options field. 
+
+In case this data should be fluid, you need to hook into some form events which requires developers to do that.
+
+To make things easier, we've introduced the Data Injection Section.
+There is also a preconfigured `expression` injector.
+
+This feature is available for:
+- Hidden Type
+- Integer Type
+- Text Type
+- Textarea Type
+- 
+
+***
+
+## Expression Data Injector
+![image](https://github.com/dachcom-digital/pimcore-formbuilder/assets/700119/53b9cde9-9057-4034-b1c3-895c5466c3ea)
+
+Use this injector for the most common scenario: Link a request parameter to a given form.
+Within the expression injecor, you're allowed to fetch data from symfonys `request` object.
+
+Example: `request.query.get('myEventId')` or `request.attributes.get('siteId')`
+
+***
+
+## Custom Data Injector
+
+```yaml
+services:
+    App\Form\DataInjector\MyDataInjector:
+        tags:
+            - { name: form_builder.data_injector, identifier: my_data_injector }
+```
+
+```php
+<?php
+
+namespace App\FormBuilder\Form\DataInjector;
+
+class MyDataInjector implements DataInjectorInterface
+{
+    public function getName(): string
+    {
+        return 'My Data Injector';
+    }
+
+    public function getDescription(): ?string
+    {
+        return 'My Description';
+    }
+
+    public function parseData(array $config): mixed
+    {
+        if (!array_key_exists('my_additional_config_node', $config)) {
+            return null;
+        }
+
+        $config = $config['my_additional_config_node'];
+        
+        // do your logic
+        $newData = null;
+        
+        return $newData;
+    }
+}
+```
+
+```js
+pimcore.registerNS('Formbuilder.extjs.form.dataInjection.my_data_injector');
+Formbuilder.extjs.form.dataInjection.my_data_injector = Class.create({
+    getForm: function (data) {
+        return [{
+            xtype: 'textfield',
+            fieldLabel: 'Required Additional Config Node',
+            name: 'my_additional_config_node',
+            anchor: '100%',
+            allowBlank: false,
+            value: data !== null ? data.my_additional_config_node : null
+        }];
+    }
+});
+
+```

src/FormBuilderBundle/Controller/Admin/SettingsController.php

@@ -4,10 +4,12 @@
 
 use FormBuilderBundle\Builder\ExtJsFormBuilder;
 use FormBuilderBundle\Configuration\Configuration;
+use FormBuilderBundle\Form\DataInjector\DataInjectorInterface;
 use FormBuilderBundle\Manager\FormDefinitionManager;
 use FormBuilderBundle\Manager\PresetManager;
 use FormBuilderBundle\Registry\ChoiceBuilderRegistry;
 use FormBuilderBundle\Model\FormDefinitionInterface;
+use FormBuilderBundle\Registry\DataInjectionRegistry;
 use FormBuilderBundle\Tool\FormDependencyLocator;
 use Pimcore\Bundle\AdminBundle\Controller\AdminController;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -287,6 +289,26 @@ public function getPresetDescriptionAction(Request $request, PresetManager $pres
         );
     }
 
+    public function getDataInjectionStoreAction(Request $request, DataInjectionRegistry $dataInjectionRegistry): JsonResponse
+    {
+        $store = [];
+
+        foreach ($dataInjectionRegistry->getAll() as $dataInjectorIdentifier => $dataInjectorService) {
+            $store[] = [
+                'value'       => $dataInjectorIdentifier,
+                'label'       => $dataInjectorService->getName(),
+                'description' => $dataInjectorService->getDescription()
+            ];
+        }
+
+        return $this->json(
+            [
+                'success' => true,
+                'store'   => $store
+            ]
+        );
+    }
+
     private function getSaveName(string $name): string
     {
         return (string) preg_replace('/[^A-Za-z0-9aäüöÜÄÖß \-]/', '', $name);

src/FormBuilderBundle/DependencyInjection/CompilerPass/DataInjectionPass.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace FormBuilderBundle\DependencyInjection\CompilerPass;
+
+use FormBuilderBundle\Registry\DataInjectionRegistry;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+final class DataInjectionPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        $definition = $container->getDefinition(DataInjectionRegistry::class);
+        foreach ($container->findTaggedServiceIds('form_builder.data_injector') as $id => $tags) {
+            foreach ($tags as $attributes) {
+                if (!isset($attributes['identifier'])) {
+                    throw new InvalidConfigurationException(sprintf('You need to define a valid identifier for data injector "%s"', $id));
+                }
+
+                $definition->addMethodCall('register', [$attributes['identifier'], new Reference($id)]);
+            }
+        }
+    }
+}

src/FormBuilderBundle/EventSubscriber/FormBuilderSubscriber.php

@@ -2,6 +2,7 @@
 
 namespace FormBuilderBundle\EventSubscriber;
 
+use FormBuilderBundle\Registry\DataInjectionRegistry;
 use FormBuilderBundle\Validator\Constraints\DynamicMultiFileNotBlank;
 use FormBuilderBundle\Model\FieldDefinitionInterface;
 use FormBuilderBundle\Model\FormFieldContainerDefinitionInterface;
@@ -25,24 +26,16 @@
 
 class FormBuilderSubscriber implements EventSubscriberInterface
 {
-    protected Configuration $configuration;
-    protected EventDispatcherInterface $eventDispatcher;
-    protected Dispatcher $dispatcher;
-    protected FormRegistryInterface $formRegistry;
-
     private array $availableConstraints;
     private array $availableFormTypes;
 
     public function __construct(
-        Configuration $configuration,
-        EventDispatcherInterface $eventDispatcher,
-        Dispatcher $dispatcher,
-        FormRegistryInterface $formRegistry
+        protected Configuration $configuration,
+        protected EventDispatcherInterface $eventDispatcher,
+        protected Dispatcher $dispatcher,
+        protected FormRegistryInterface $formRegistry,
+        protected DataInjectionRegistry $dataInjectionRegistry
     ) {
-        $this->configuration = $configuration;
-        $this->eventDispatcher = $eventDispatcher;
-        $this->dispatcher = $dispatcher;
-        $this->formRegistry = $formRegistry;
         $this->availableConstraints = $this->configuration->getAvailableConstraints();
         $this->availableFormTypes = $this->configuration->getConfig('types');
     }
@@ -204,15 +197,19 @@ private function addFormBuilderField(FormFieldDefinitionInterface $field, array
 
         // options enrichment: tweak preferred choice options
         if (in_array($field->getType(), $this->getChoiceFieldTypes(), true)) {
-            if (isset($options['multiple']) && $options['multiple'] === false
-                && isset($options['data'])
-                && is_array($options['data'])
-                && !empty($options['data'])
-            ) {
+            if (isset($options['multiple']) && $options['multiple'] === false && array_key_exists('data', $options) && is_array($options['data'])) {
                 $options['data'] = $options['data'][0];
             }
         }
 
+        if (array_key_exists('dataInjection', $options) && !empty($options['dataInjection'])) {
+            $dataInjection = json_decode($options['dataInjection'], true);
+            unset($options['dataInjection']);
+            if ($this->dataInjectionRegistry->has($dataInjection['injector'])) {
+                $options['data'] = $this->dataInjectionRegistry->get($dataInjection['injector'])->parseData($dataInjection['config']);
+            }
+        }
+
         // options enrichment: add constraints
         if (in_array('constraints', $availableOptions)) {
             $conditionalConstraintData = $this->dispatchConditionalLogicModule('constraints', $conditionalLogicOptions);

src/FormBuilderBundle/Form/DataInjector/DataInjectorInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace FormBuilderBundle\Form\DataInjector;
+
+interface DataInjectorInterface
+{
+    public function getName(): string;
+
+    public function getDescription(): ?string;
+
+    public function parseData(array $config): mixed;
+}

src/FormBuilderBundle/Form/DataInjector/ExpressionDataInjector.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace FormBuilderBundle\Form\DataInjector;
+
+use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+class ExpressionDataInjector implements DataInjectorInterface
+{
+    protected ExpressionLanguage $expressionLanguage;
+
+    public function __construct(protected RequestStack $requestStack)
+    {
+        $this->expressionLanguage = new ExpressionLanguage();
+    }
+
+    public function getName(): string
+    {
+        return 'Expression';
+    }
+
+    public function getDescription(): ?string
+    {
+        return 'Inject data from request object via expression language';
+    }
+
+    public function parseData(array $config): mixed
+    {
+        if (!array_key_exists('expression', $config)) {
+            return null;
+        }
+
+        $request = $this->requestStack->getMainRequest();
+
+        if (!$request instanceof Request) {
+            return null;
+        }
+
+        return $this->expressionLanguage->evaluate($config['expression'], ['request' => $request]);
+    }
+}

src/FormBuilderBundle/FormBuilderBundle.php

@@ -6,6 +6,7 @@
 use Doctrine\DBAL\Types\Type;
 use FormBuilderBundle\DependencyInjection\CompilerPass\ApiProviderPass;
 use FormBuilderBundle\DependencyInjection\CompilerPass\ChoiceBuilderPass;
+use FormBuilderBundle\DependencyInjection\CompilerPass\DataInjectionPass;
 use FormBuilderBundle\DependencyInjection\CompilerPass\DispatcherPass;
 use FormBuilderBundle\DependencyInjection\CompilerPass\DynamicMultiFileAdapterPass;
 use FormBuilderBundle\DependencyInjection\CompilerPass\DynamicObjectResolverPass;
@@ -69,6 +70,7 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new ApiProviderPass());
         $container->addCompilerPass(new FieldTransformerPass());
         $container->addCompilerPass(new StorageProviderPass());
+        $container->addCompilerPass(new DataInjectionPass());
     }
 
     public function getInstaller(): Install
@@ -111,6 +113,7 @@ public function getJsPaths(): array
             '/bundles/formbuilder/js/extjs/_form/config-fields/select.js',
             '/bundles/formbuilder/js/extjs/_form/config-fields/tagfield.js',
             '/bundles/formbuilder/js/extjs/_form/config-fields/textfield.js',
+            '/bundles/formbuilder/js/extjs/_form/data-injection/expression.js',
             '/bundles/formbuilder/js/extjs/extensions/formMetaData.js',
             '/bundles/formbuilder/js/extjs/extensions/formMailEditor.js',
             '/bundles/formbuilder/js/extjs/extensions/formApiMappingEditor.js',