Refactor to aliases

putyourlightson · Apr 26, 2024 · b2d1c59 · b2d1c59
1 parent f17e702
commit b2d1c59
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 32 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 ### Added
 
-- Added the ability to link customers in the plugin settings.
+- Added the ability to define customer aliases in the plugin settings.
 
 ### Changed
 

diff --git a/src/controllers/SlideoutController.php b/src/controllers/SlideoutController.php
@@ -19,14 +19,14 @@ class SlideoutController extends Controller
     public function actionRender(): Response
     {
         $customer = $this->request->getRequiredParam('customer');
-        $linkedCustomers = PluginSales::$plugin->settings->getLinkedCustomers($customer);
+        $customerAliases = PluginSales::$plugin->settings->getCustomerAliases($customer);
         $url = $this->getUrlFromCustomer($customer);
         $sales = PluginSales::$plugin->reports->getSalesData($customer);
 
         return $this->asCpScreen()
             ->contentTemplate('plugin-sales/_slideout', [
                 'customer' => $customer,
-                'linkedCustomers' => $linkedCustomers,
+                'customerAliases' => $customerAliases,
                 'url' => $url,
                 'sales' => $sales,
             ]);

diff --git a/src/models/SettingsModel.php b/src/models/SettingsModel.php
@@ -44,27 +44,27 @@ class SettingsModel extends Model
     /**
      * @var array
      */
-    public array $linkedCustomers = [];
+    public array $customerAliases = [];
 
     /**
      * @var int
      */
     public int $refreshSalesJobTtr = 3600;
 
     /**
-     * Returns linked customers for the given customer.
+     * Returns customer aliases for the given customer.
      */
-    public function getLinkedCustomers(string $customer): array
+    public function getCustomerAliases(string $customer): array
     {
-        $linkedCustomers = [];
+        $customerAliases = [];
 
-        foreach ($this->linkedCustomers as $linkedCustomer) {
-            if ($linkedCustomer['canonical'] === $customer) {
-                $linkedCustomers[] = $linkedCustomer['linked'];
+        foreach ($this->customerAliases as $customerAlias) {
+            if ($customerAlias['customer'] === $customer) {
+                $customerAliases[] = $customerAlias['alias'];
             }
         }
 
-        return $linkedCustomers;
+        return $customerAliases;
     }
 
     /**

diff --git a/src/services/SalesService.php b/src/services/SalesService.php
@@ -211,7 +211,7 @@ public function refresh(callable $setProgressHandler = null): bool|int
             }
         }
 
-        $this->updateLinkedCustomers();
+        $this->updateCustomerAliases();
         $this->updateFirstSales();
 
         $refreshRecord = new RefreshRecord();
@@ -327,20 +327,20 @@ private function saveSales(array $sales): int
     }
 
     /**
-     * Updates all linked customers.
+     * Updates all customer aliases.
      */
-    private function updateLinkedCustomers(): void
+    private function updateCustomerAliases(): void
     {
-        $linkedCustomers = PluginSales::$plugin->settings->linkedCustomers;
+        $customerAliases = PluginSales::$plugin->settings->customerAliases;
 
-        foreach ($linkedCustomers as $linkedCustomer) {
+        foreach ($customerAliases as $customerAlias) {
             Db::update(
                 SaleRecord::tableName(),
                 [
-                    'customer' => $linkedCustomer['canonical'],
+                    'customer' => $customerAlias['customer'],
                 ],
                 [
-                    'customer' => $linkedCustomer['linked'],
+                    'customer' => $customerAlias['alias'],
                 ]
             );
         }

diff --git a/src/templates/_slideout.twig b/src/templates/_slideout.twig
@@ -1,10 +1,10 @@
 <h2>
     {{ customer }}
-    {% if linkedCustomers %}
+    {% if customerAliases %}
         <span class="info">
-            Linked to from
-            {% for linkedCustomer in linkedCustomers %}
-                <code>{{ linkedCustomer }}</code>
+            Customer aliases:
+            {% for customerAlias in customerAliases %}
+                <code>{{ customerAlias }}</code>
                 {{- not loop.last ? ',' }}
             {% endfor %}
         </span>

diff --git a/src/templates/settings.twig b/src/templates/settings.twig
@@ -117,22 +117,22 @@
 } %}
 
 {{ forms.editableTableField({
-    label: 'Linked Customers'|t('plugin-sales'),
-    instructions: 'Customers can be linked together, useful to ease the transition from Craft ID to Craft Console, which added support for organisations.'|t('plugin-sales'),
-    name: 'linkedCustomers',
-    id: 'linkedCustomers',
+    label: 'Customer Aliases'|t('plugin-sales'),
+    instructions: 'Customers can be assigned aliases, useful to ease the transition from Craft ID to Craft Console, which added support for organisations. Customer aliases will be replaced with the customer name on each refresh.'|t('plugin-sales'),
+    name: 'customerAliases',
+    id: 'customerAliases',
     cols: {
-        canonical: {
+        customer: {
             type: 'singleline',
-            heading: 'Canonical customer'|t('plugin-sales'),
+            heading: 'Customer'|t('plugin-sales'),
         },
-        linked: {
+        alias: {
             type: 'singleline',
-            heading: 'Linked customer'|t('plugin-sales'),
+            heading: 'Alias'|t('plugin-sales'),
         },
     },
-    rows: settings.linkedCustomers,
-    addRowLabel: 'Add a linked customer'|t('plugin-sales'),
+    rows: settings.customerAliases,
+    addRowLabel: 'Add customer alias'|t('plugin-sales'),
     allowAdd: true,
     allowDelete: true,
     allowReorder: true,