Merge pull request #3847 from craftcms/feature/pt-2373-4x-getgatewayb…

…yhandle-returns-archived-gateway [4.8] Show archived gateways table
craftcms · Jan 22, 2025 · b542f43 · b542f43
2 parents 259e662 + 27877db
commit b542f43
Show file tree

Hide file tree

Showing 5 changed files with 99 additions and 3 deletions.
diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md
@@ -1 +1,7 @@
-# Release Notes for Craft Commerce 4.8 (WIP)
+# Release Notes for Craft Commerce 4.8 (WIP)
+
+### Store Management
+- It is now possible to see archived gateways listed in the control panel. ([#3839](https://github.com/craftcms/commerce/issues/3839))
+
+### Extensibility
+- Added `craft\commerce\services\Gateways\getAllArchivedGateways()`.
diff --git a/src/controllers/GatewaysController.php b/src/controllers/GatewaysController.php
@@ -8,12 +8,16 @@
 namespace craft\commerce\controllers;
 
 use Craft;
+use craft\base\MissingComponentInterface;
 use craft\commerce\base\Gateway;
 use craft\commerce\base\GatewayInterface;
+use craft\commerce\db\Table;
 use craft\commerce\gateways\Dummy;
 use craft\commerce\helpers\DebugPanel;
 use craft\commerce\Plugin;
+use craft\db\Query;
 use craft\errors\DeprecationException;
+use craft\helpers\Html;
 use craft\helpers\Json;
 use yii\base\Exception;
 use yii\base\InvalidConfigException;
@@ -32,9 +36,33 @@ class GatewaysController extends BaseAdminController
     public function actionIndex(): Response
     {
         $gateways = Plugin::getInstance()->getGateways()->getAllGateways();
+        $archivedGateways = Plugin::getInstance()->getGateways()->getAllArchivedGateways();
+
+        if (!empty($archivedGateways)) {
+            $gatewayIdsWithTransactions = (new Query())
+                ->select(['gatewayId'])
+                ->from(Table::TRANSACTIONS)
+                ->groupBy(['gatewayId'])
+                ->column();
+
+            foreach ($archivedGateways as &$gateway) {
+                $missing = $gateway instanceof MissingComponentInterface;
+                $gateway = [
+                    'id' => $gateway->id,
+                    'title' => Craft::t('site', $gateway->name),
+                    'handle' => Html::encode($gateway->handle),
+                    'type' => [
+                        'missing' => $missing,
+                        'name' => $missing ? $gateway->expectedType : $gateway->displayName(),
+                    ],
+                    'hasTransactions' => in_array($gateway->id, $gatewayIdsWithTransactions),
+                ];
+            }
+        }
 
         return $this->renderTemplate('commerce/settings/gateways/index', [
             'gateways' => $gateways,
+            'archivedGateways' => array_values($archivedGateways),
         ]);
     }
 

diff --git a/src/services/Gateways.php b/src/services/Gateways.php
@@ -138,6 +138,17 @@ public function getAllGateways(): array
         return ArrayHelper::where($this->_getAllGateways(), 'isArchived', false);
     }
 
+    /**
+     * @return array
+     * @throws DeprecationException
+     * @throws InvalidConfigException
+     * @sine 4.8.0
+     */
+    public function getAllArchivedGateways(): array
+    {
+        return ArrayHelper::where($this->_getAllGateways(), 'isArchived', true);
+    }
+
     /**
      * Archives a gateway by its ID.
      *

diff --git a/src/templates/settings/gateways/index.twig b/src/templates/settings/gateways/index.twig
@@ -18,8 +18,25 @@
     <a href="{{ url('commerce/settings/gateways/new') }}" class="btn submit add icon">{{ 'New gateway'|t('commerce') }}</a>
 {% endblock %}
 
-{% block content %}
-    <div id="gateways-vue-admin-table"></div>
+{% block main %}
+  <div id="content">
+
+    <div class="content-pane">
+      <div id="gateways-vue-admin-table"></div>
+    </div>
+    {% if archivedGateways|length %}
+      <p>
+        <a class="fieldtoggle"
+           data-target="archived-gateways">{{ 'Show archived gateways'|t('commerce') }}</a>
+      </p>
+
+      <div id="archived-gateways" class="hidden" style="margin-top: 22px;">
+        <div class="content-pane">
+          <div id="gateways-archived-vue-admin-table"></div>
+        </div>
+      </div>
+    {% endif %}
+  </div>
 {% endblock %}
 
 {% set tableData = [] %}
@@ -73,4 +90,36 @@
         reorderFailMessage:    Craft.t('commerce', 'Couldn’t reorder gateways.'),
         tableData: {{ tableData|json_encode|raw }}
     });
+
+    {% if archivedGateways|length %}
+      new Craft.VueAdminTable({
+          columns: [
+        { name: 'id', title: Craft.t('commerce', 'ID') },
+        { name: '__slot:title', title: Craft.t('commerce', 'Name') },
+        { name: '__slot:handle', title: Craft.t('commerce', 'Handle') },
+        {
+            name: 'type',
+            title: Craft.t('commerce', 'Type'),
+            callback: function(value) {
+                if (value.missing) {
+                    return '<span class="error">'+value.name+'</span>';
+                }
+
+                return value.name;
+            }
+        },
+        {
+          name: 'hasTransactions',
+          title: Craft.t('commerce', 'Has Transactions?'),
+          callback: function(value) {
+                if (value) {
+                    return '<div data-icon="check" title="'+Craft.escapeHtml(Craft.t('commerce', 'Yes'))+'"></div>';
+                }
+            }
+        },
+    ],
+          container: '#gateways-archived-vue-admin-table',
+          tableData: {{ archivedGateways|json_encode|raw }}
+      });
+    {% endif %}
 {% endjs %}
diff --git a/src/translations/en/commerce.php b/src/translations/en/commerce.php
@@ -464,6 +464,7 @@
     'Has Emails?' => 'Has Emails?',
     'Has Orders' => 'Has Orders',
     'Has Purchasable' => 'Has Purchasable',
+    'Has Transactions?' => 'Has Transactions?',
     'Has Variants?' => 'Has Variants?',
     'Height ({unit})' => 'Height ({unit})',
     'Height' => 'Height',
@@ -894,6 +895,7 @@
     'Short Number' => 'Short Number',
     'Show Chart?' => 'Show Chart?',
     'Show Order Count?' => 'Show Order Count?',
+    'Show archived gateways' => 'Show archived gateways',
     'Show order count line on chart.' => 'Show order count line on chart.',
     'Show rule details' => 'Show rule details',
     'Show the Dimensions and Weight fields for products of this type' => 'Show the Dimensions and Weight fields for products of this type',