Prevent accidentally saving Neo field as different type

#21
spicywebau · Jun 16, 2024 · a6bbf2c · a6bbf2c
1 parent aead997
commit a6bbf2c
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## Unreleased
+
+### Changed
+- The Neo field type is now listed in the field type selection dropdown, and the save buttons replaced with a message indicating lack of support for saving the field type, preventing the possibility of accidentally saving a Neo field as a different field type
+
 ## 2.0.7 - 2023-10-16
 
 ### Fixed

diff --git a/client/src/scripts/FieldModal.ts b/client/src/scripts/FieldModal.ts
@@ -16,8 +16,10 @@ interface FieldModalInterface extends GarnishModal {
   $deleteBtn: JQuery
   $deleteSpinner: JQuery
   $loadSpinner: JQuery
+  $cancelBtn: JQuery
   $saveBtn: JQuery
   $saveCopyBtn: JQuery
+  $unsupportedMessage: JQuery
   $saveSpinner: JQuery
   $observed: JQuery
   executedJs: Record<string, boolean>
@@ -44,6 +46,10 @@ interface SettingsEvent extends Event {
   $css: JQuery
 }
 
+const unsupportedFieldTypes = [
+  'benf\\neo\\Field'
+]
+
 /**
  * FieldModal class
  * Handles the modal window for creating new fields.
@@ -129,6 +135,7 @@ const FieldModal = Garnish.Modal.extend({
     this.$cancelBtn = $('<div class="btn disabled" role="button">').text(Craft.t('quick-field', 'Cancel')).appendTo(this.$rightButtons)
     this.$saveBtn = $('<div class="btn submit disabled" role="button">').text(Craft.t('quick-field', 'Save')).appendTo(this.$rightButtons)
     this.$saveCopyBtn = $('<div class="btn submit disabled hidden" role="button">').text(Craft.t('quick-field', 'Save as a new field')).appendTo(this.$rightButtons)
+    this.$unsupportedMessage = $('<p class="error hidden">').text(Craft.t('quick-field', 'Saving the selected field type is unsupported.')).appendTo(this.$rightButtons)
     this.$saveSpinner = $('<div class="spinner hidden">').appendTo(this.$rightButtons)
 
     this.setContainer($container)
@@ -341,6 +348,23 @@ const FieldModal = Garnish.Modal.extend({
 
     that.on('runExternalScripts', callback)
     that.runExternalScripts(Object.keys(that.executedJs))
+
+    const fieldTypeDropdown = that.$main.find('select[name="qf[type]"]')
+    const checkSupportedFieldType: () => void = () => {
+      const selectedFieldType = fieldTypeDropdown.val() as string
+
+      if (unsupportedFieldTypes.includes(selectedFieldType)) {
+        this.$saveBtn.detach()
+        this.$saveCopyBtn.detach()
+        this.$unsupportedMessage.removeClass('hidden')
+      } else {
+        this.$cancelBtn.after(this.$saveBtn)
+        this.$saveBtn.after(this.$saveCopyBtn)
+        this.$unsupportedMessage.addClass('hidden')
+      }
+    }
+    checkSupportedFieldType()
+    fieldTypeDropdown.on('change', checkSupportedFieldType)
   },
 
   /**

diff --git a/client/src/styles/modal.scss b/client/src/styles/modal.scss
@@ -47,5 +47,9 @@
                 margin: 0;
             }
         }
+
+        .error {
+            margin: 0;
+        }
     }
 }
diff --git a/src/controllers/QuickFieldController.php b/src/controllers/QuickFieldController.php
@@ -2,7 +2,6 @@
 
 namespace spicyweb\quickfield\controllers;
 
-use benf\neo\Field as NeoField;
 use Craft;
 use craft\base\Field;
 use craft\fieldlayoutelements\CustomField;
@@ -271,7 +270,7 @@ private function _getTemplate(Field $field = null): array
         }
 
         $fieldsService = Craft::$app->getFields();
-        $fieldTypes = $this->_getFieldTypes();
+        $fieldTypes = Craft::$app->getFields()->getAllFieldTypes();
         $fieldTypeOptions = [];
         $supportedTranslationMethods = [];
         $compatibleFieldTypes = [];
@@ -314,22 +313,4 @@ private function _getTemplate(Field $field = null): array
             'css' => $view->getHeadHtml(),
         ];
     }
-
-    /**
-     * Returns the field types that Quick Field supports creating.
-     *
-     * @return string[]
-     */
-    private function _getFieldTypes(): array
-    {
-        $fieldTypes = Craft::$app->getFields()->getAllFieldTypes();
-
-        if (Craft::$app->getPlugins()->getPlugin('neo')) {
-            return array_filter($fieldTypes, function($fieldType) {
-                return !($fieldType === NeoField::class);
-            });
-        }
-
-        return $fieldTypes;
-    }
 }
diff --git a/src/resources/css/main.css b/src/resources/css/main.css
diff --git a/src/resources/css/main.css.map b/src/resources/css/main.css.map
diff --git a/src/resources/js/main.js b/src/resources/js/main.js
diff --git a/src/resources/js/main.js.map b/src/resources/js/main.js.map
diff --git a/src/translations/en/quick-field.php b/src/translations/en/quick-field.php
@@ -19,6 +19,7 @@
     'Rename' => 'Rename',
     'Save' => 'Save',
     'Save as a new field' => 'Save as a new field',
+    'Saving the selected field type is unsupported.' => 'Saving the selected field type is unsupported.',
     'Settings' => 'Settings',
     'The field requested to delete no longer exists.' => 'The field requested to delete no longer exists.',
     'The field requested to edit no longer exists.' => 'The field requested to edit no longer exists.',