Add checker/fixer to plugin settings

Author: engram-design

src/SuperTable.php

@@ -11,8 +11,11 @@
 use Craft;
 use craft\base\Plugin;
 use craft\events\RegisterComponentTypesEvent;
+use craft\events\RegisterUrlRulesEvent;
+use craft\helpers\UrlHelper;
 use craft\services\Elements;
 use craft\services\Fields;
+use craft\web\UrlManager;
 use craft\web\twig\variables\CraftVariable;
 
 use NerdsAndCompany\Schematic\Schematic;
@@ -28,6 +31,7 @@ class SuperTable extends Plugin
     // =========================================================================
 
     public $schemaVersion = '2.0.8';
+    public $hasCpSettings = true;
 
     // Traits
     // =========================================================================
@@ -46,16 +50,32 @@ public function init()
 
         $this->_setPluginComponents();
         $this->_setLogging();
+        $this->_registerCpRoutes();
         $this->_registerVariables();
         $this->_registerFieldTypes();
         $this->_registerElementTypes();
         $this->_registerIntegrations();
         $this->_registerConfigListeners();
     }
 
+    public function getSettingsResponse()
+    {
+        Craft::$app->getResponse()->redirect(UrlHelper::cpUrl('super-table/settings'));
+    }
+
+
     // Private Methods
     // =========================================================================
 
+    private function _registerCpRoutes()
+    {
+        Event::on(UrlManager::class, UrlManager::EVENT_REGISTER_CP_URL_RULES, function(RegisterUrlRulesEvent $event) {
+            $event->rules = array_merge($event->rules, [
+                'super-table/settings' => 'super-table/plugin/settings',
+            ]);
+        });
+    }
+
 
     private function _registerVariables()
     {

src/controllers/PluginController.php

@@ -21,6 +21,13 @@ class PluginController extends Controller
     // Public Methods
     // =========================================================================
 
+    public function actionSettings()
+    {
+        return $this->renderTemplate('super-table/plugin-settings', [
+            'settings' => true,
+        ]);
+    }
+
     public function actionFixContentTables()
     {
         // Backup!
@@ -36,11 +43,14 @@ public function actionFixContentTables()
 
         ob_end_clean();
 
-        echo nl2br($output);
+        $output = nl2br($output);
 
-        echo '<br>Fixes complete.';
+        $output .= '<br>Fixes complete.';
 
-        exit;
+        return $this->renderTemplate('super-table/plugin-settings', [
+            'fixed' => true,
+            'output' => $output,
+        ]);
     }
 
     public function actionCheckContentTables()
@@ -154,18 +164,62 @@ public function actionCheckContentTables()
             }
         }
 
+        // Check each table for missing field columns in their content tables
+        $superTableBlockTypes = (new Query())
+            ->select(['*'])
+            ->from(['{{%supertableblocktypes}}'])
+            ->all();
+
+        foreach ($superTableBlockTypes as $superTableBlockType) {
+            $correctFieldColumns = [];
+            $dbFieldColumns = [];
+
+            $fieldLayout = $fieldsService->getLayoutById($superTableBlockType['fieldLayoutId']);
+
+            // Find what the columns should be according to the block type fields
+            if ($fieldLayout) {
+                foreach ($fieldLayout->getFields() as $field) {
+                    if ($field::hasContentColumn()) {
+                        $correctFieldColumns[] = 'field_' . $field->handle;
+                    }
+                }
+            }
+
+            $field = $fieldsService->getFieldById($superTableBlockType['fieldId']);
+
+            if ($field) {
+                $contentTable = $field->contentTable;
+
+                if ($contentTable) {
+                    $columns = Craft::$app->getDb()->getTableSchema($contentTable)->columns;
+
+                    foreach ($columns as $key => $column) {
+                        if (strstr($key, 'field_')) {
+                            $dbFieldColumns[] = $key;
+                        }
+                    }
+
+                    if ($correctFieldColumns != $dbFieldColumns) {
+                        $errors = true;
+                        echo "    > ERROR: {$contentTable} has missing field columns ...\n";
+                    }
+                }
+            }
+        }
+
         $output = ob_get_contents();
         ob_end_clean();
 
-        echo nl2br($output);
+        $output = nl2br($output);
 
-        if ($errors) {
-            echo '<br>Fix the above errors by running the <a href="' . UrlHelper::actionUrl('super-table/plugin/fix-content-tables') . '">Super Table content table fixer.';
-        } else {
-            echo 'No errors found.';
+        if (!$errors) {
+            $output .= 'No errors found.';
         }
 
-        exit;
+        return $this->renderTemplate('super-table/plugin-settings', [
+            'checkErrors' => $errors,
+            'output' => $output,
+        ]);
     }
 
 }

src/templates/plugin-settings.html

@@ -0,0 +1,38 @@
+{% extends '_layouts/cp' %}
+{% import '_includes/forms' as forms %}
+
+{% set title = 'Super Table' | t('super-table') %}
+
+{% block content %}
+
+<h2>{{ 'Check Content Tables' | t('isuper-table') }}</h2>
+
+<p>{{ 'If you\'re updating from Craft 3.0.x, or are experiencing error messages with content tables, please use this tool to check for errors or inconsistencies.' | t('super-table') | md }}</p>
+
+<p>{{ 'This tool will first check to see if there are any errors, then advise if you want to go ahead and fix them.' | t('super-table') | md }}</p>
+
+{% if output is defined %}
+    <hr>
+
+    <code>{{ output | raw }}</code>
+
+    <hr>
+{% endif %}
+
+{% if settings is defined %}
+    <a class="btn submit" href="{{ actionUrl('super-table/plugin/check-content-tables') }}">{{ 'Check Content Tables' | t('super-table') }}</a>
+{% endif %}
+
+{% if checkErrors is defined %}
+    {% if checkErrors %}
+        <a class="btn submit" href="{{ actionUrl('super-table/plugin/fix-content-tables') }}">{{ 'Fix Content Tables' | t('super-table') }}</a>
+    {% else %}
+        <a class="btn submit" href="{{ cpUrl('super-table/settings') }}">{{ 'Done' | t('super-table') }}</a>
+    {% endif %}
+{% endif %}
+
+{% if fixed is defined %}
+    <a class="btn submit" href="{{ cpUrl('super-table/settings') }}">{{ 'Done' | t('super-table') }}</a>
+{% endif %}
+
+{% endblock %}