Fix default sort order option

Author: thomas-kl1

Plugin/ApplySortOrder.php

@@ -8,11 +8,9 @@
 namespace Opengento\CatalogSortOrder\Plugin;
 
 use Magento\Catalog\Block\Product\ProductList\Toolbar;
-use Magento\Catalog\Model\Config;
-use Magento\Eav\Model\Entity\Attribute;
 use Opengento\CatalogSortOrder\Model\Config\SortOrder as SortOrderConfig;
 use Opengento\CatalogSortOrder\Model\SortOrder\Direction;
-use Opengento\CatalogSortOrder\Model\SortOrder\Option;
+use Opengento\CatalogSortOrder\Provider\SortOrders;
 
 use function array_intersect_key;
 use function array_pad;
@@ -22,13 +20,12 @@ class ApplySortOrder
 {
     public function __construct(
         private SortOrderConfig $sortOrderConfig,
-        private Config $catalogConfig
+        private SortOrders $sortOrders
     ) {}
 
     public function beforeGetAvailableOrders(Toolbar $subject): array
     {
         if ($this->sortOrderConfig->isEnabled() && !$subject->hasData('_grid_advanced_available_orders_isset')) {
-            $subject->setData('_grid_advanced_available_orders_init', true);
             $subject->setAvailableOrders([]);
         }
 
@@ -38,9 +35,9 @@ public function beforeGetAvailableOrders(Toolbar $subject): array
     public function beforeSetAvailableOrders(Toolbar $subject, array $orders): array
     {
         if ($this->sortOrderConfig->isEnabled()) {
-            $orders = $this->sortOrderConfig->isCategoryOrdersOverridden() || $subject->hasData('_grid_advanced_available_orders_init')
-                ? $this->createSortByOptions()
-                : array_intersect_key($this->createSortByOptions(), $orders);
+            $orders = $this->sortOrderConfig->isCategoryOrdersOverridden() || $orders !== []
+                ? $this->sortOrders->getOptions()
+                : array_intersect_key($this->sortOrders->getOptions(), $orders);
             $subject->setData('_grid_advanced_available_orders_isset', true);
         }
 
@@ -71,29 +68,4 @@ public function afterGetCurrentOrder(Toolbar $subject, string $result): string
 
         return $result;
     }
-
-    private function createSortByOptions(): array
-    {
-        $attributesForSortBy = $this->catalogConfig->getAttributesUsedForSortBy();
-        $availableOrders = [];
-        foreach ($this->sortOrderConfig->getSortOptions() as $option) {
-            $attribute = $attributesForSortBy[$option->code] ?? null;
-            if ($option->includeDirection) {
-                foreach (Direction::cases() as $direction) {
-                    $availableOrders[$direction->appendValue($option->code)] = $direction->prependLabel(
-                        $this->resolveLabel($attribute, $option)
-                    );
-                }
-            } else {
-                $availableOrders[$option->code] = $this->resolveLabel($attribute, $option);
-            }
-        }
-
-        return $availableOrders;
-    }
-
-    private function resolveLabel(?Attribute $attribute, Option $option): string
-    {
-        return $option->label ?: $attribute?->getStoreLabel() ?? $option->code;
-    }
 }

Plugin/ResolveDefaultSort.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\CatalogSortOrder\Plugin;
+
+use Magento\Catalog\Helper\Product\ProductList;
+use Opengento\CatalogSortOrder\Model\Config\SortOrder as SortOrderConfig;
+use Opengento\CatalogSortOrder\Model\SortOrder\Direction;
+use Opengento\CatalogSortOrder\Provider\SortOrders;
+
+class ResolveDefaultSort
+{
+    public function __construct(
+        private SortOrders $sortOrders,
+        private SortOrderConfig $sortOrderConfig
+    ) {}
+
+    public function afterGetDefaultSortField(ProductList $subject, ?string $result): ?string
+    {
+        if ($result && $this->sortOrderConfig->isEnabled()) {
+            $options = $this->sortOrders->getOptions();
+            foreach (Direction::cases() as $direction) {
+                $sort = $direction->appendValue($result);
+                if (isset($options[$sort])) {
+                    return $sort;
+                }
+            }
+        }
+
+        return $result;
+    }
+}

Provider/SortOrders.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\CatalogSortOrder\Provider;
+
+use Magento\Catalog\Model\Config;
+use Magento\Eav\Model\Entity\Attribute;
+use Opengento\CatalogSortOrder\Model\Config\SortOrder as SortOrderConfig;
+use Opengento\CatalogSortOrder\Model\SortOrder\Direction;
+use Opengento\CatalogSortOrder\Model\SortOrder\Option;
+
+class SortOrders
+{
+    private ?array $options = null;
+
+    public function __construct(
+        private SortOrderConfig $sortOrderConfig,
+        private Config $catalogConfig
+    ) {}
+
+    public function getOptions(): array
+    {
+        return $this->options ??= $this->createOptions();
+    }
+
+    private function createOptions(): array
+    {
+        $attributesForSortBy = $this->catalogConfig->getAttributesUsedForSortBy();
+        $availableOrders = [];
+        foreach ($this->sortOrderConfig->getSortOptions() as $option) {
+            $attribute = $attributesForSortBy[$option->code] ?? null;
+            if ($option->includeDirection) {
+                foreach (Direction::cases() as $direction) {
+                    $availableOrders[$direction->appendValue($option->code)] = $direction->prependLabel(
+                        $this->resolveLabel($attribute, $option)
+                    );
+                }
+            } else {
+                $availableOrders[$option->code] = $this->resolveLabel($attribute, $option);
+            }
+        }
+
+        return $availableOrders;
+    }
+
+    private function resolveLabel(?Attribute $attribute, Option $option): string
+    {
+        return $option->label ?: $attribute?->getStoreLabel() ?? $option->code;
+    }
+}

etc/frontend/di.xml

@@ -9,4 +9,7 @@
     <type name="Magento\Catalog\Block\Product\ProductList\Toolbar">
         <plugin name="Opengento_CatalogSortOrder::advanced_sort_order" type="Opengento\CatalogSortOrder\Plugin\ApplySortOrder"/>
     </type>
+    <type name="Magento\Catalog\Helper\Product\ProductList">
+        <plugin name="Opengento_CatalogSortOrder::resolve_default_sort" type="Opengento\CatalogSortOrder\Plugin\ResolveDefaultSort"/>
+    </type>
 </config>