MC-15250: Explicit product sorting in PageBuilder Products Content type

eug123 · eug123 · commit e1218872266c · 2019-07-31T13:34:47.000-05:00
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting.php
@@ -4,34 +4,31 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog;
 
 /**
  * Sorting of Catalog Widget Products
- *
- * @package Magento\PageBuilder\Model
  */
 class Sorting
 {
     /**
      * @var array
      */
-    private $sortClasses = [
-        'date_newest_top' => Sorting\Date\NewestTop::class
-    ];
+    private $sortClasses;
 
     /**
      * @var Sorting\Factory
      */
     private $factory;
 
     /**
-     * @var array
+     * @var Sorting\SortInterface[]
      */
     private $sortInstances = [];
 
     /**
-     * Sorting constructor.
      * @param Sorting\Factory $factory
      * @param array $sortClasses
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -40,7 +37,7 @@ public function __construct(
         Sorting\Factory $factory,
         array $sortClasses
     ) {
-        $this->sortClasses = array_merge($this->sortClasses, $sortClasses);
+        $this->sortClasses = $sortClasses;
         $this->factory = $factory;
         foreach ($this->sortClasses as $key => $className) {
             $this->sortInstances[$key] = $this->factory->create($className);
@@ -65,14 +62,13 @@ public function getSortingOptions(): array
      * Get the instance of the first option which is None
      *
      * @param string $sortOption
-     * @return Sorting\SortInterface|null
+     * @return Sorting\SortInterface
      */
     public function getSortingInstance($sortOption): Sorting\SortInterface
     {
         if (isset($this->sortInstances[$sortOption])) {
             return $this->sortInstances[$sortOption];
         }
-        return $this->sortInstances['date_newest_top'];
     }
 
     /**
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/AttributeAbstract.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/AttributeAbstract.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting;
 
-use \Magento\Framework\DB\Select;
+use Magento\Framework\DB\Select;
 
 /**
  * Class AttributeAbstract
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting
  */
 abstract class AttributeAbstract extends SortAbstract implements SortInterface
 {
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Date/NewestTop.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Date/NewestTop.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting\Date;
 
-use \Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
+use Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
 
 /**
  * Class NewestTop
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting\Date
  */
 class NewestTop extends AttributeAbstract
 {
@@ -34,7 +34,7 @@ protected function getSortDirection()
     /**
      * @inheritdoc
      */
-    public function getLabel(): string
+    public function getLabel(): \Magento\Framework\Phrase
     {
         return __('Newest products first');
     }
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Date/OldestTop.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Date/OldestTop.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting\Date;
 
-use \Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
+use Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
 
 /**
  * Class OldestTop
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting\Date
  */
 class OldestTop extends AttributeAbstract
 {
@@ -34,7 +34,7 @@ protected function getSortDirection()
     /**
      * @inheritdoc
      */
-    public function getLabel(): string
+    public function getLabel(): \Magento\Framework\Phrase
     {
         return __('Oldest products first');
     }
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Factory.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Factory.php
@@ -4,12 +4,12 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting;
 
 /**
  * Class Factory
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting
  */
 class Factory
 {
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Name/Ascending.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Name/Ascending.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting\Name;
 
-use \Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
+use Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
 
 /**
  * Class Name\Ascending
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting\Name
  */
 class Ascending extends AttributeAbstract
 {
@@ -34,7 +34,7 @@ protected function getSortDirection()
     /**
      * @inheritdoc
      */
-    public function getLabel(): string
+    public function getLabel(): \Magento\Framework\Phrase
     {
         return __('Name: A - Z');
     }
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Name/Descending.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Name/Descending.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting\Name;
 
-use \Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
+use Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
 
 /**
  * Class Name\Descending
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting\Name
  */
 class Descending extends AttributeAbstract
 {
@@ -34,7 +34,7 @@ protected function getSortDirection()
     /**
      * @inheritdoc
      */
-    public function getLabel(): string
+    public function getLabel(): \Magento\Framework\Phrase
     {
         return __('Name: Z - A');
     }
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Options.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Options.php
@@ -3,12 +3,13 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting;
 
 /**
  * Class Sorting Options
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting
  */
 class Options implements \Magento\Framework\Data\OptionSourceInterface
 {
@@ -18,8 +19,6 @@ class Options implements \Magento\Framework\Data\OptionSourceInterface
     private $sorting;
 
     /**
-     * Options constructor.
-     *
      * @param \Magento\PageBuilder\Model\Catalog\Sorting $sorting
      */
     public function __construct(
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Price/HighToLow.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Price/HighToLow.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting\Price;
 
-use \Magento\PageBuilder\Model\Catalog\Sorting\PriceAbstract;
+use Magento\PageBuilder\Model\Catalog\Sorting\PriceAbstract;
 
 /**
  * Class Price\HighToLow
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting\Price
  */
 class HighToLow extends PriceAbstract
 {
@@ -26,7 +26,7 @@ protected function getSortDirection()
     /**
      * @inheritdoc
      */
-    public function getLabel(): string
+    public function getLabel(): \Magento\Framework\Phrase
     {
         return __('Price: high to low');
     }
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Price/LowToHigh.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Price/LowToHigh.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting\Price;
 
-use \Magento\PageBuilder\Model\Catalog\Sorting\PriceAbstract;
+use Magento\PageBuilder\Model\Catalog\Sorting\PriceAbstract;
 
 /**
  * Class Price\LowToHigh
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting\Price
  */
 class LowToHigh extends PriceAbstract
 {
@@ -26,7 +26,7 @@ protected function getSortDirection()
     /**
      * @inheritdoc
      */
-    public function getLabel(): string
+    public function getLabel(): \Magento\Framework\Phrase
     {
         return __('Price: low to high');
     }
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/PriceAbstract.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/PriceAbstract.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting;
 
-use \Magento\Framework\DB\Select;
+use Magento\Framework\DB\Select;
 
 /**
  * Class PriceAbstract
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting
  */
 abstract class PriceAbstract extends SortAbstract implements SortInterface
 {
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Sku/Ascending.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Sku/Ascending.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting\Sku;
 
-use \Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
+use Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
 
 /**
  * Class Sku\Ascending
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting\Sku
  */
 class Ascending extends AttributeAbstract
 {
@@ -34,7 +34,7 @@ protected function getSortDirection()
     /**
      * @inheritdoc
      */
-    public function getLabel(): string
+    public function getLabel(): \Magento\Framework\Phrase
     {
         return __('SKU: ascending');
     }
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Sku/Descending.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Sku/Descending.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting\Sku;
 
-use \Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
+use Magento\PageBuilder\Model\Catalog\Sorting\AttributeAbstract;
 
 /**
  * Class Sku\Descending
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting\Sku
  */
 class Descending extends AttributeAbstract
 {
@@ -34,7 +34,7 @@ protected function getSortDirection()
     /**
      * @inheritdoc
      */
-    public function getLabel(): string
+    public function getLabel(): \Magento\Framework\Phrase
     {
         return __('SKU: descending');
     }
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/SortAbstract.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/SortAbstract.php
@@ -4,41 +4,15 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog\Sorting;
 
 /**
  * Class SortAbstract
- *
- * @package Magento\PageBuilder\Model\Catalog\Sorting
  */
 class SortAbstract
 {
-    /**
-     * @var \Magento\Framework\Module\ModuleManagerInterface
-     */
-    protected $moduleManager;
-
-    /**
-     * SortAbstract constructor.
-     *
-     * @param \Magento\Framework\Module\ModuleManagerInterface $moduleManager
-     */
-    public function __construct(
-        \Magento\Framework\Module\ModuleManagerInterface $moduleManager
-    ) {
-        $this->moduleManager = $moduleManager;
-    }
-
-    /**
-     * Stock ID
-     *
-     * @return int
-     */
-    protected function getStockId(): int
-    {
-        return \Magento\CatalogInventory\Model\Stock::DEFAULT_STOCK_ID;
-    }
-
     /**
      * Sorting ascending order
      *
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/SortInterface.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/SortInterface.php
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Stock/Ascending.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Stock/Ascending.php
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Stock/Descending.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Stock/Descending.php
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/StockAbstract.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/StockAbstract.php
diff --git a/app/code/Magento/PageBuilder/Plugin/Catalog/Block/Product/ProductsListPlugin.php b/app/code/Magento/PageBuilder/Plugin/Catalog/Block/Product/ProductsListPlugin.php
diff --git a/app/code/Magento/PageBuilder/etc/di.xml b/app/code/Magento/PageBuilder/etc/di.xml
