Fix the JSON Decode issue and added settings

Author: mblode

composer.json

@@ -2,7 +2,7 @@
     "name": "mblode/sprout-forms-tables",
     "description": "Tables Field for Sprout Forms",
     "type": "craft-plugin",
-    "version": "1.0.3",
+    "version": "1.0.4",
     "keywords": [
         "craft",
         "cms",
@@ -32,7 +32,7 @@
     "extra": {
         "name": "Tables Field for Sprout Forms",
         "handle": "sprout-forms-tables",
-        "hasCpSettings": false,
+        "hasCpSettings": true,
         "hasCpSection": false,
         "changelogUrl": "https://raw.githubusercontent.com/mblode/sprout-forms-tables/master/CHANGELOG.md",
         "class": "mblode\\sproutformstables\\SproutFormsTables"

src/SproutFormsTables.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Sprout Forms Tables plugin for Craft CMS 3.x
+ * Tables Field for Sprout Forms for Craft CMS 3.x
  *
  * Custom Tables field for Sprout Forms plugin
  *
@@ -10,9 +10,11 @@
 
 namespace mblode\sproutformstables;
 
+use mblode\sproutformstables\integrations\sproutforms\fields\Table;
+use mblode\sproutformstables\models\Settings;
+
 use barrelstrength\sproutforms\services\Fields;
 use barrelstrength\sproutforms\events\RegisterFieldsEvent;
-use mblode\sproutformstables\integrations\sproutforms\fields\Table;
 
 use Craft;
 use craft\base\Plugin;
@@ -24,19 +26,8 @@
 use yii\base\InvalidConfigException;
 
 /**
- * Craft plugins are very much like little applications in and of themselves. We’ve made
- * it as simple as we can, but the training wheels are off. A little prior knowledge is
- * going to be required to write a plugin.
- *
- * For the purposes of the plugin docs, we’re going to assume that you know PHP and SQL,
- * as well as some semi-advanced concepts like object-oriented programming and PHP namespaces.
- *
- * https://craftcms.com/docs/plugins/introduction
- *
- * @author    Matthew Blode
- * @package   SproutFormsTables
- * @since     1.0.0
- *
+ * @property  Settings    $settings
+ * @method    Settings getSettings()
  */
 class SproutFormsTables extends Plugin
 {
@@ -85,30 +76,12 @@ public function __construct($id, $parent = null, array $config = [])
             ];
         }
 
-        // Base template directory
-        // Event::on(View::class, View::EVENT_REGISTER_CP_TEMPLATE_ROOTS, function (RegisterTemplateRootsEvent $e) {
-        //     if (is_dir($baseDir = $this->getBasePath().DIRECTORY_SEPARATOR.'templates')) {
-        //         $e->roots[$this->id] = $baseDir;
-        //     }
-        // });
-
         // Set this as the global instance of this module class
         static::setInstance($this);
 
         parent::__construct($id, $parent, $config);
     }
 
-    /**
-     * Set our $plugin static property to this class so that it can be accessed via
-     * SproutFormsTables::$plugin
-     *
-     * Called after the plugin class is instantiated; do any one-time initialization
-     * here such as hooks and events.
-     *
-     * If you have a '/vendor/autoload.php' file, it will be loaded for you automatically;
-     * you do not need to load it in your init() method.
-     *
-     */
     public function init()
     {
         parent::init();
@@ -131,24 +104,6 @@ function (PluginEvent $event) {
             }
         );
 
-/**
- * Logging in Craft involves using one of the following methods:
- *
- * Craft::trace(): record a message to trace how a piece of code runs. This is mainly for development use.
- * Craft::info(): record a message that conveys some useful information.
- * Craft::warning(): record a warning message that indicates something unexpected has happened.
- * Craft::error(): record a fatal error that should be investigated as soon as possible.
- *
- * Unless `devMode` is on, only Craft::warning() & Craft::error() will log to `craft/storage/logs/web.log`
- *
- * It's recommended that you pass in the magic constant `__METHOD__` as the second parameter, which sets
- * the category to the method (prefixed with the fully qualified class name) where the constant appears.
- *
- * To enable the Yii debug toolbar, go to your user account in the AdminCP and check the
- * [] Show the debug toolbar on the front end & [] Show the debug toolbar on the Control Panel
- *
- * http://www.yiiframework.com/doc-2.0/guide-runtime-logging.html
- */
         Craft::info(
             Craft::t(
                 'sprout-forms-tables',
@@ -162,4 +117,20 @@ function (PluginEvent $event) {
     // Protected Methods
     // =========================================================================
 
+    /**
+     * @return Settings
+     */
+    protected function createSettingsModel(): Settings
+    {
+        return new Settings();
+    }
+    /**
+     * @return string The rendered settings HTML
+     */
+    protected function settingsHtml(): string
+    {
+        return Craft::$app->view->renderTemplate('sprout-forms-tables/settings', [
+            'settings' => $this->getSettings(),
+        ]);
+    }
 }

src/integrations/sproutforms/fields/Table.php

@@ -66,7 +66,11 @@ public function getSettingsHtml()
      */
     public function getInputHtml($value, ElementInterface $element = null): string
     {
-        $value = json_decode($value, true);
+        $settings = Craft::$app->getPlugins()->getPlugin('sprout-forms-tables')->getSettings();
+
+        if (!$settings->decodeValue) {
+            $value = json_decode($value, true);
+        }
 
         return Craft::$app->getView()->renderTemplate('sprout-forms-tables/_integrations/sproutforms/formtemplates/fields/table/cpinput',
             [
@@ -127,24 +131,14 @@ public function getTemplatesPath()
         return Craft::getAlias('@mblode/sproutformstables/templates/_integrations/sproutforms/formtemplates/fields/');
     }
 
-
     public function normalizeValue($value, ElementInterface $element = null)
     {
         // String value when retrieved from db
         if (is_string($value)) {
-            $tableArray = json_decode($value, true);
-
-            $value = [];
+            $settings = Craft::$app->getPlugins()->getPlugin('sprout-forms-tables')->getSettings();
 
-            foreach($tableArray as $item) {
-                $row = "";
-                foreach($item as $key => $val) {
-                    if (strlen($val) > 0) {
-                        $row .= $key . ': ' . $val . ', ';
-                    }
-                }
-                $row = substr($row, 0, -2);
-                array_push($value, $row);
+            if ($settings->decodeValue) {
+                $value = json_decode($value, true);
             }
         }
 

src/models/Settings.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace mblode\sproutformstables\models;
+
+use craft\base\Model;
+
+class Settings extends Model
+{
+    // Public Properties
+    // =========================================================================
+    /**
+     * JSON Decode the table value that is used on the notification email. (Only turn on with a custom notification email template).
+     *
+     * @var boolean
+     */
+    public $decodeValue = true;
+}

src/templates/_integrations/sproutforms/formtemplates/fields/table/input.html

@@ -40,7 +40,7 @@
                         {% for col in cols %}
                             <td>
                                 <input type="text"
-                                    {%- if name %} name="{{ name }}[{{ row }}][{{ col.value }}]"{% endif %}
+                                    {%- if name %} name="{{ name }}[row-{{ row }}][{{ col.value }}]"{% endif %}
                                     {%- if id %} id="{{ id }}"{% endif %}
                                     {%- if class %} class="{{ class }} sprout-forms-tables-input"{% endif %}
                                     {%- if required %} required aria-required="true"{% endif %}

src/templates/_integrations/sproutforms/formtemplates/fields/table/settings.html

@@ -1,20 +1,20 @@
 {% import "_includes/forms" as forms %}
 
 {{ forms.editableTableField({
-    label: "Table",
-    instructions: 'Define the table contents.',
+    label: "Table" | t,
+    instructions: 'Define the table contents.' | t,
     id: 'cols',
     name: 'cols',
-    addRowLabel: 'Add a row',
+    addRowLabel: 'Add a row' | t,
     value: field.cols,
     cols: {
         label: {
-            heading: 'Table Column',
+            heading: 'Table Column' | t,
             type: 'singleline',
             autopopulate: 'value',
         },
         value: {
-            heading: 'Value',
+            heading: 'Value' | t,
             type: 'singleline',
             class: 'code'
         },
@@ -23,7 +23,7 @@
 }) }}
 
 {{ forms.textField({
-    label: "Size",
+    label: "Number of rows" | t,
     id: 'size',
     name: 'size',
     value: field.size,

src/templates/settings.html

@@ -0,0 +1,9 @@
+{% import "_includes/forms" as forms %}
+
+{{ forms.lightswitchField({
+    id: 'decodeValue',
+    name: 'decodeValue',
+    label: 'JSON Decode Table Values' | t,
+    on: settings.decodeValue,
+    instructions: 'JSON Decode the table value that is used on the notification email. (Only turn on with a custom notification email template).' | t
+}) }}