Catalog ProductList helper has coupling to Registry #27119

app/code/Magento/Catalog/Block/Product/ProductList/Toolbar.php

@@ -9,6 +9,7 @@
 use Magento\Catalog\Model\Product\ProductList\Toolbar as ToolbarModel;
 use Magento\Catalog\Model\Product\ProductList\ToolbarMemorizer;
 use Magento\Framework\App\ObjectManager;
+use Magento\Catalog\Model\Category\Toolbar\Config as ToolbarConfig;
 
 /**
  * Product list toolbar
@@ -138,6 +139,11 @@ class Toolbar extends \Magento\Framework\View\Element\Template
      */
     private $formKey;
 
+    /**
+     * @var ToolbarConfig
+     */
+    private $toolbarConfig;
+
     /**
      * @param \Magento\Framework\View\Element\Template\Context $context
      * @param \Magento\Catalog\Model\Session $catalogSession
@@ -150,6 +156,7 @@ class Toolbar extends \Magento\Framework\View\Element\Template
      * @param ToolbarMemorizer|null $toolbarMemorizer
      * @param \Magento\Framework\App\Http\Context|null $httpContext
      * @param \Magento\Framework\Data\Form\FormKey|null $formKey
+     * @param ToolbarConfig|null $toolbarConfig
      *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -164,7 +171,8 @@ public function __construct(
         array $data = [],
         ToolbarMemorizer $toolbarMemorizer = null,
         \Magento\Framework\App\Http\Context $httpContext = null,
-        \Magento\Framework\Data\Form\FormKey $formKey = null
+        \Magento\Framework\Data\Form\FormKey $formKey = null,
+        ToolbarConfig $toolbarConfig = null
     ) {
         $this->_catalogSession = $catalogSession;
         $this->_catalogConfig = $catalogConfig;
@@ -181,6 +189,10 @@ public function __construct(
         $this->formKey = $formKey ?: ObjectManager::getInstance()->get(
             \Magento\Framework\Data\Form\FormKey::class
         );
+        $this->toolbarConfig = $toolbarConfig ?: ObjectManager::getInstance()->get(
+            ToolbarConfig::class
+        );
+
         parent::__construct($context, $data);
     }
 
@@ -756,15 +768,16 @@ public function getWidgetOptionsJson(array $customOptions = [])
     }
 
     /**
-     * Get order field
+     * Returns an order field for a collection.
      *
      * @return null|string
      */
     protected function getOrderField()
     {
         if ($this->_orderField === null) {
-            $this->_orderField = $this->_productListHelper->getDefaultSortField();
+            $this->_orderField = $this->toolbarConfig->getOrderField();
         }
+
         return $this->_orderField;
     }
 

app/code/Magento/Catalog/Helper/Product/ProductList.php

@@ -7,11 +7,9 @@
 
 namespace Magento\Catalog\Helper\Product;
 
-use Magento\Catalog\Model\Config;
 use Magento\Framework\App\Config\ScopeConfigInterface;
-use Magento\Framework\App\ObjectManager;
-use Magento\Framework\Registry;
 use Magento\Store\Model\ScopeInterface;
+use Magento\Catalog\Model\Category\Toolbar\Config as ToolbarConfig;
 
 /**
  * Returns data for toolbars of Sorting and Pagination
@@ -32,11 +30,6 @@ class ProductList
      */
     protected $scopeConfig;
 
-    /**
-     * @var Registry
-     */
-    private $coreRegistry;
-
     /**
      * Default limits per page
      *
@@ -45,15 +38,21 @@ class ProductList
     protected $_defaultAvailableLimit = [10 => 10, 20 => 20, 50 => 50];
 
     /**
+     * @var ToolbarConfig
+     */
+    private $toolbarConfig;
+
+    /**
+     * ProductList constructor.
      * @param ScopeConfigInterface $scopeConfig
-     * @param Registry $coreRegistry
+     * @param ToolbarConfig $toolbarConfig
      */
     public function __construct(
         ScopeConfigInterface $scopeConfig,
-        Registry $coreRegistry = null
+        ToolbarConfig $toolbarConfig
     ) {
         $this->scopeConfig = $scopeConfig;
-        $this->coreRegistry = $coreRegistry ?? ObjectManager::getInstance()->get(Registry::class);
+        $this->toolbarConfig = $toolbarConfig;
     }
 
     /**
@@ -100,17 +99,11 @@ public function getDefaultViewMode($options = [])
     /**
      * Get default sort field
      *
-     * @FIXME Helper should be context-independent
      * @return null|string
      */
     public function getDefaultSortField()
     {
-        $currentCategory = $this->coreRegistry->registry('current_category');
-        if ($currentCategory) {
-            return $currentCategory->getDefaultSortBy();
-        }
-
-        return $this->scopeConfig->getValue(Config::XML_PATH_LIST_DEFAULT_SORT_BY, ScopeInterface::SCOPE_STORE);
+        return $this->toolbarConfig->getOrderField();
     }
 
     /**

app/code/Magento/Catalog/Model/Category/Config.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\Category;
+
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Catalog\Model\Config as CatalogConfig;
+use Magento\Store\Model\ScopeInterface;
+
+class Config
+{
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * Config constructor.
+     * @param ScopeConfigInterface $scopeConfig
+     */
+    public function __construct(ScopeConfigInterface $scopeConfig)
+    {
+        $this->scopeConfig = $scopeConfig;
+    }
+
+    /**
+     * Returns a sort field from the configuration
+     *
+     * @param string|int|null $scopeCode
+     * @return string
+     */
+    public function getDefaultSortField($scopeCode = null): string
+    {
+        return (string) $this->scopeConfig->getValue(
+            CatalogConfig::XML_PATH_LIST_DEFAULT_SORT_BY,
+            ScopeInterface::SCOPE_STORE,
+            $scopeCode
+        );
+    }
+}

app/code/Magento/Catalog/Model/Category/Toolbar/Config.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\Category\Toolbar;
+
+use Magento\Catalog\Model\Category\Config as CategoryConfig;
+use Magento\Catalog\Model\CurrentCategory;
+use Magento\Framework\Exception\NoSuchEntityException;
+
+class Config
+{
+    /**
+     * @var CurrentCategory
+     */
+    private $currentCategory;
+
+    /**
+     * @var CategoryConfig
+     */
+    private $categoryConfig;
+
+    /**
+     * Config constructor.
+     * @param CurrentCategory $currentCategory
+     * @param CategoryConfig $categoryConfig
+     */
+    public function __construct(
+        CurrentCategory $currentCategory,
+        CategoryConfig $categoryConfig
+    ) {
+        $this->currentCategory = $currentCategory;
+        $this->categoryConfig = $categoryConfig;
+    }
+
+    /**
+     * Returns a category default_sort_by attribute, or default sort field from the configuration.
+     *
+     * @return string
+     */
+    public function getOrderField(): string
+    {
+        try {
+            $category = $this->currentCategory->get();
+        } catch (NoSuchEntityException $exception) {
+            return $this->categoryConfig->getDefaultSortField();
+        }
+
+        if ($category->getDefaultSortBy()) {
+            return $category->getDefaultSortBy();
+        }
+
+        return $this->categoryConfig->getDefaultSortField();
+    }
+}

app/code/Magento/Catalog/Model/CurrentCategory.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model;
+
+use Magento\Catalog\Api\CategoryRepositoryInterface;
+use Magento\Catalog\Api\Data\CategoryInterface;
+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\Exception\NoSuchEntityException;
+
+class CurrentCategory
+{
+    /**
+     * @var RequestInterface
+     */
+    private $request;
+
+    /**
+     * @var CategoryRepositoryInterface
+     */
+    private $repository;
+
+    /**
+     * CurrentCategory constructor.
+     * @param RequestInterface $request
+     * @param CategoryRepositoryInterface $categoryRepository
+     */
+    public function __construct(
+        RequestInterface $request,
+        CategoryRepositoryInterface $categoryRepository
+    ) {
+        $this->request = $request;
+        $this->repository = $categoryRepository;
+    }
+
+    /**
+     * Returns a category based on an id request parameter.
+     *
+     * @param int|null $storeId
+     *
+     * @return CategoryInterface|Category
+     * @throws NoSuchEntityException
+     */
+    public function get($storeId = null): CategoryInterface
+    {
+        return $this->repository->get((int) $this->request->getParam('id'), $storeId);
+    }
+}