Freeform submission support

studioespresso · Dec 1, 2023 · 980112d · 980112d
1 parent 5549578
commit 980112d
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 36 deletions.
diff --git a/src/Exporter.php b/src/Exporter.php
@@ -14,7 +14,6 @@
 use craft\events\RegisterUserPermissionsEvent;
 use craft\services\Elements;
 use craft\services\Gc;
-use craft\services\Sections;
 use craft\services\UserPermissions;
 use craft\web\twig\variables\CraftVariable;
 use craft\web\UrlManager;
@@ -26,23 +25,21 @@
 use studioespresso\exporter\helpers\ElementTypeHelper;
 use studioespresso\exporter\helpers\FieldTypeHelper;
 use studioespresso\exporter\models\ExportableCategoryModel;
-use studioespresso\exporter\models\ExportableElementTypeModel;
 use studioespresso\exporter\models\ExportableEntryModel;
 use studioespresso\exporter\models\ExportableFormieSubmissionModel;
+use studioespresso\exporter\models\ExportableFreeformSubmissionModel;
 use studioespresso\exporter\models\Settings;
 use studioespresso\exporter\records\ExportRecord;
 use studioespresso\exporter\services\ExportQueryService;
 use studioespresso\exporter\services\MailService;
 use studioespresso\exporter\variables\CraftVariableBehavior;
 use studioespresso\exporter\variables\ExporterVariable;
-use verbb\formie\elements\Submission;
 use verbb\formie\fields\formfields\Agree;
 use verbb\formie\fields\formfields\Email;
 use verbb\formie\fields\formfields\MultiLineText;
 use verbb\formie\fields\formfields\Number;
 use verbb\formie\fields\formfields\Phone;
 use verbb\formie\fields\formfields\SingleLineText;
-use verbb\formie\Formie;
 use verbb\formie\integrations\feedme\fields\Name;
 use yii\base\Event;
 use yii\console\Application as ConsoleApplication;
@@ -91,7 +88,9 @@ public function init(): void
             $this->registerUserPermissions();
             $this->registerSupportedElementTypes();
             $this->registerFieldParsers();
+            // Register plugin support
             $this->registerFormie();
+            $this->registerFreeform();
         });
     }
 
@@ -205,22 +204,6 @@ function (RegisterExportableFieldTypes $event) {
             });
     }
 
-    private function registerFormie()
-    {
-        // Register support for Formie if the plugin is installed and Enabled
-        if (Craft::$app->getPlugins()->isPluginEnabled('formie')) {
-            Event::on(
-                ElementTypeHelper::class,
-                ElementTypeHelper::EVENT_REGISTER_EXPORTABLE_ELEMENT_TYPES,
-                function (RegisterExportableElementTypes $event) {
-                    $model = new ExportableFormieSubmissionModel();
-                    $event->elementTypes = array_merge($event->elementTypes, [
-                      Submission::class => $model
-                    ]);
-                });
-        }
-    }
-
     private function attachEventHandlers(): void
     {
         Event::on(
@@ -276,4 +259,37 @@ private function registerUserPermissions()
             ];
         });
     }
+
+    private function registerFormie()
+    {
+        // Register support for Formie if the plugin is installed and Enabled
+        if (Craft::$app->getPlugins()->isPluginEnabled('formie')) {
+            Event::on(
+                ElementTypeHelper::class,
+                ElementTypeHelper::EVENT_REGISTER_EXPORTABLE_ELEMENT_TYPES,
+                function (RegisterExportableElementTypes $event) {
+                    $model = new ExportableFormieSubmissionModel();
+                    $event->elementTypes = array_merge($event->elementTypes, [
+                        \verbb\formie\elements\Submission::class => $model
+                    ]);
+                });
+        }
+    }
+
+    private function registerFreeform()
+    {
+        // Register support for Formie if the plugin is installed and Enabled
+        if (Craft::$app->getPlugins()->isPluginEnabled('freeform')) {
+            Event::on(
+                ElementTypeHelper::class,
+                ElementTypeHelper::EVENT_REGISTER_EXPORTABLE_ELEMENT_TYPES,
+                function (RegisterExportableElementTypes $event) {
+                    $model = new ExportableFreeformSubmissionModel();
+                    $event->elementTypes = array_merge($event->elementTypes, [
+                        \Solspace\Freeform\Elements\Submission::class => $model
+                    ]);
+                });
+        }
+    }
+
 }
diff --git a/src/models/ExportableCategoryModel.php b/src/models/ExportableCategoryModel.php
@@ -2,12 +2,7 @@
 
 namespace studioespresso\exporter\models;
 
-use craft\base\Element;
-use craft\base\ElementInterface;
-use craft\base\Model;
 use craft\elements\Category;
-use craft\elements\Entry;
-use craft\services\Sections;
 
 class ExportableCategoryModel extends ExportableElementTypeModel
 {

diff --git a/src/models/ExportableElementTypeModel.php b/src/models/ExportableElementTypeModel.php
@@ -2,8 +2,6 @@
 
 namespace studioespresso\exporter\models;
 
-use craft\base\Element;
-use craft\base\ElementInterface;
 use craft\base\Model;
 
 abstract class ExportableElementTypeModel extends Model

diff --git a/src/models/ExportableEntryModel.php b/src/models/ExportableEntryModel.php
@@ -2,9 +2,6 @@
 
 namespace studioespresso\exporter\models;
 
-use craft\base\Element;
-use craft\base\ElementInterface;
-use craft\base\Model;
 use craft\elements\Entry;
 use craft\services\Sections;
 

diff --git a/src/models/ExportableFormieSubmissionModel.php b/src/models/ExportableFormieSubmissionModel.php
@@ -2,12 +2,6 @@
 
 namespace studioespresso\exporter\models;
 
-use craft\base\Element;
-use craft\base\ElementInterface;
-use craft\base\Model;
-use craft\elements\Category;
-use craft\elements\Entry;
-use craft\services\Sections;
 use verbb\formie\elements\Submission;
 use verbb\formie\Formie;
 

diff --git a/src/models/ExportableFreeformSubmissionModel.php b/src/models/ExportableFreeformSubmissionModel.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace studioespresso\exporter\models;
+
+use Solspace\Freeform\Elements\Submission;
+use Solspace\Freeform\Freeform;
+use verbb\formie\Formie;
+
+class ExportableFreeformSubmissionModel extends ExportableElementTypeModel
+{
+    public $elementType = Submission::class;
+
+    public string $elementLabel = "Freeform Submissions";
+
+    public function getGroup(): array
+    {
+        return [
+            "label" => "Form",
+            "parameter" => "formId",
+            "items" => Freeform::getInstance()->forms->getAllForms(), // @phpstan-ignore-line
+            "nameProperty" => "name",
+        ];
+    }
+
+    public function getSubGroup(): bool|array
+    {
+       return false;
+    }
+
+}
diff --git a/src/templates/sprig/element/step_1.twig b/src/templates/sprig/element/step_1.twig
@@ -69,6 +69,7 @@
         {% set subGroup = elementOptions.getSubGroup() %}
         {% if elementOptions.group is defined %}
             {% set groupOptions = elementOptions.getGroup() %}
+            {{ d(groupOptions) }}
             <div class="flex-fields">
                 <div class="field width-50" id="elementType-entry-subfields">
                     <div class="heading">