Form object refactoring

app/bundles/FormBundle/Assets/js/form.js

@@ -107,7 +107,42 @@ Mautic.formBuilderNewComponentInit = function () {
         mQuery(this).val('');
         mQuery(this).trigger('chosen:updated');
     });
-}
+};
+
+Mautic.changeSelectOptions = function(selectEl, options) {
+    selectEl.empty();
+    mQuery.each(options, function(key, field) {
+        selectEl.append(
+            mQuery('<option></option>')
+                .attr('value', field.value)
+                .attr('data-list-type', field.isListType ? 1 : 0)
+                .text(field.label)
+        );
+    });
+    selectEl.trigger('chosen:updated');
+};
+
+Mautic.fetchFieldsOnObjectChange = function() {
+    var fieldSelect = mQuery('select#formfield_mappedField');
+    fieldSelect.attr('disable', true);
+    mQuery.ajax({
+        url: mauticAjaxUrl + "?action=form:getFieldsForObject",
+        data: {
+            mappedObject: mQuery('select#formfield_mappedObject').val(),
+            mappedField: mQuery('input#formfield_originalMappedField').val(),
+            formId: mQuery('input#mauticform_sessionId').val()
+        },
+        success: function (response) {
+            Mautic.changeSelectOptions(fieldSelect, response.fields);
+        },
+        error: function (response, textStatus, errorThrown) {
+            Mautic.processAjaxError(response, textStatus, errorThrown);
+        },
+        complete: function () {
+            fieldSelect.removeAttr('disable');
+        }
+    });
+};
 
 Mautic.updateFormFields = function () {
     Mautic.activateLabelLoadingIndicator('campaignevent_properties_field');
@@ -344,4 +379,4 @@ Mautic.selectFormType = function(formType) {
 
     mQuery('.form-type-modal').remove();
     mQuery('.form-type-modal-backdrop').remove();
-};
+};

app/bundles/FormBundle/Collection/FieldCollection.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collection;
+
+use Mautic\FormBundle\Crate\FieldCrate;
+use Mautic\FormBundle\Exception\FieldNotFoundException;
+
+/**
+ * @extends \ArrayIterator<int,FieldCrate>
+ */
+final class FieldCollection extends \ArrayIterator
+{
+    /**
+     * @return array<string,string>
+     */
+    public function toChoices(): array
+    {
+        $choices = [];
+
+        /** @var FieldCrate $field */
+        foreach ($this as $field) {
+            $choices[$field->getName()] = $field->getKey();
+        }
+
+        return $choices;
+    }
+
+    public function getFieldByKey(string $key): FieldCrate
+    {
+        /** @var FieldCrate $field */
+        foreach ($this as $field) {
+            if ($key === $field->getKey()) {
+                return $field;
+            }
+        }
+
+        throw new FieldNotFoundException("Field with key {$key} was not found.");
+    }
+
+    /**
+     * @param string[] $keys
+     */
+    public function removeFieldsWithKeys(array $keys, string $keyToKeep = null): FieldCollection
+    {
+        return new self(
+            array_filter(
+                $this->getArrayCopy(),
+                function (FieldCrate $field) use ($keys, $keyToKeep) {
+                    return ($keyToKeep && $field->getKey() === $keyToKeep) || !in_array($field->getKey(), $keys, true);
+                }
+            )
+        );
+    }
+}

app/bundles/FormBundle/Collection/MappedObjectCollection.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collection;
+
+/**
+ * @extends \ArrayIterator<string,FieldCollection>
+ */
+final class MappedObjectCollection extends \ArrayIterator
+{
+}

app/bundles/FormBundle/Collection/ObjectCollection.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collection;
+
+use Mautic\FormBundle\Crate\ObjectCrate;
+
+/**
+ * @extends \ArrayIterator<int,ObjectCrate>
+ */
+final class ObjectCollection extends \ArrayIterator
+{
+    /**
+     * @return array<string,string>
+     */
+    public function toChoices(): array
+    {
+        $choices = [];
+
+        /** @var ObjectCrate $object */
+        foreach ($this as $object) {
+            $choices[$object->getName()] = $object->getKey();
+        }
+
+        return $choices;
+    }
+}

app/bundles/FormBundle/Collector/AlreadyMappedFieldCollector.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collector;
+
+use Mautic\CacheBundle\Cache\CacheProviderInterface;
+
+/**
+ * We need to store mapped fields in the form field builder so we could remove the used ones from the select box.
+ */
+final class AlreadyMappedFieldCollector implements AlreadyMappedFieldCollectorInterface
+{
+    private const EXPIRATION_IN_SECONDS = 18000; // 5 hours
+
+    private CacheProviderInterface $cacheProvider;
+
+    public function __construct(CacheProviderInterface $cacheProvider)
+    {
+        $this->cacheProvider = $cacheProvider;
+    }
+
+    public function getFields(string $formId, string $object): array
+    {
+        $cacheItem = $this->cacheProvider->getItem($this->buildCacheKey($formId, $object));
+
+        return json_decode($cacheItem->get() ?? '[]', true);
+    }
+
+    public function addField(string $formId, string $object, string $fieldKey): void
+    {
+        $this->fetchAndSave($formId, $object, function (array $fields) use ($fieldKey) {
+            if (!in_array($fieldKey, $fields, true)) {
+                $fields[] = $fieldKey;
+            }
+
+            return $fields;
+        });
+    }
+
+    public function removeField(string $formId, string $object, string $fieldKey): void
+    {
+        $this->fetchAndSave($formId, $object, function (array $fields) use ($fieldKey) {
+            $cacheKey = array_search($fieldKey, $fields, true);
+
+            if (false !== $cacheKey) {
+                unset($fields[$cacheKey]);
+
+                // Reset indexes.
+                $fields = array_values($fields);
+            }
+
+            return $fields;
+        });
+    }
+
+    public function removeAllForForm(string $formId): void
+    {
+        $this->cacheProvider->invalidateTags([$this->buildCacheTag($formId)]);
+    }
+
+    private function fetchAndSave(string $formId, string $object, callable $callback): void
+    {
+        $cacheItem = $this->cacheProvider->getItem($this->buildCacheKey($formId, $object));
+        $fields    = json_decode($cacheItem->get() ?? '[]', true);
+        $cacheItem->set(json_encode($callback($fields)));
+        $cacheItem->expiresAfter(self::EXPIRATION_IN_SECONDS);
+        $cacheItem->tag($this->buildCacheTag($formId));
+        $this->cacheProvider->save($cacheItem);
+    }
+
+    private function buildCacheKey(string $formId, string $object): string
+    {
+        return sprintf('mautic.form.%s.object.%s.fields.mapped', $formId, $object);
+    }
+
+    private function buildCacheTag(string $formId): string
+    {
+        return sprintf('mautic.form.%s.fields.mapped', $formId);
+    }
+}

app/bundles/FormBundle/Collector/AlreadyMappedFieldCollectorInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collector;
+
+interface AlreadyMappedFieldCollectorInterface
+{
+    /**
+     * @param string $formId can be a string hash for new forms
+     *
+     * @return mixed[]
+     */
+    public function getFields(string $formId, string $object): array;
+
+    public function addField(string $formId, string $object, string $fieldKey): void;
+
+    public function removeField(string $formId, string $object, string $fieldKey): void;
+
+    /**
+     * Removes all mapped fields for the specified form.
+     */
+    public function removeAllForForm(string $formId): void;
+}

app/bundles/FormBundle/Collector/FieldCollector.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collector;
+
+use Mautic\FormBundle\Collection\FieldCollection;
+use Mautic\FormBundle\Event\FieldCollectEvent;
+use Mautic\FormBundle\FormEvents;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+
+final class FieldCollector implements FieldCollectorInterface
+{
+    private EventDispatcherInterface $dispatcher;
+
+    /**
+     * @var FieldCollection[]
+     */
+    private array $fieldCollections = [];
+
+    public function __construct(EventDispatcherInterface $dispatcher)
+    {
+        $this->dispatcher = $dispatcher;
+    }
+
+    public function getFields(string $object): FieldCollection
+    {
+        if (!isset($this->fieldCollections[$object])) {
+            $this->collect($object);
+        }
+
+        return $this->fieldCollections[$object];
+    }
+
+    private function collect(string $object): void
+    {
+        $event = new FieldCollectEvent($object);
+        $this->dispatcher->dispatch(FormEvents::ON_FIELD_COLLECT, $event);
+        $this->fieldCollections[$object] = $event->getFields();
+    }
+}

app/bundles/FormBundle/Collector/FieldCollectorInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collector;
+
+use Mautic\FormBundle\Collection\FieldCollection;
+
+interface FieldCollectorInterface
+{
+    public function getFields(string $object): FieldCollection;
+}

app/bundles/FormBundle/Collector/MappedObjectCollector.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collector;
+
+use Mautic\FormBundle\Collection\MappedObjectCollection;
+
+final class MappedObjectCollector implements MappedObjectCollectorInterface
+{
+    private FieldCollectorInterface $fieldCollector;
+
+    public function __construct(FieldCollectorInterface $fieldCollector)
+    {
+        $this->fieldCollector = $fieldCollector;
+    }
+
+    public function buildCollection(string ...$objects): MappedObjectCollection
+    {
+        $mappedObjectCollection = new MappedObjectCollection();
+
+        foreach ($objects as $object) {
+            if ($object) {
+                $mappedObjectCollection->offsetSet($object, $this->fieldCollector->getFields($object));
+            }
+        }
+
+        return $mappedObjectCollection;
+    }
+}

app/bundles/FormBundle/Collector/MappedObjectCollectorInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collector;
+
+use Mautic\FormBundle\Collection\MappedObjectCollection;
+
+interface MappedObjectCollectorInterface
+{
+    public function buildCollection(string ...$objects): MappedObjectCollection;
+}

app/bundles/FormBundle/Collector/ObjectCollector.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\FormBundle\Collector;
+
+use Mautic\FormBundle\Collection\ObjectCollection;
+use Mautic\FormBundle\Event\ObjectCollectEvent;
+use Mautic\FormBundle\FormEvents;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+
+final class ObjectCollector implements ObjectCollectorInterface
+{
+    private EventDispatcherInterface $dispatcher;
+    private ?ObjectCollection $objects = null;
+
+    public function __construct(EventDispatcherInterface $dispatcher)
+    {
+        $this->dispatcher = $dispatcher;
+    }
+
+    public function getObjects(): ObjectCollection
+    {
+        if (null === $this->objects) {
+            $this->collect();
+        }
+
+        return $this->objects;
+    }
+
+    private function collect(): void
+    {
+        $event = new ObjectCollectEvent();
+        $this->dispatcher->dispatch(FormEvents::ON_OBJECT_COLLECT, $event);
+        $this->objects = $event->getObjects();
+    }
+}