[feat] GraphQl support

Author: tuyennn

Model/AdditionalAttribute.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Ghoster\OutOfStockAtLast\Model;
+
+class AdditionalAttribute
+{
+    public const ATTRIBUTE_CODE = 'out_of_stock_at_last';
+}

Model/Elasticsearch/Adapter/DataMapper/Stock.php

@@ -3,6 +3,7 @@
 
 namespace GhoSter\OutOfStockAtLast\Model\Elasticsearch\Adapter\DataMapper;
 
+use Ghoster\OutOfStockAtLast\Model\AdditionalAttribute;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\StoreManagerInterface;
 use GhoSter\OutOfStockAtLast\Model\ResourceModel\Inventory;
@@ -49,14 +50,14 @@ public function map($entityId, $storeId): array
         $sku = $this->inventory->getSkuRelation((int)$entityId);
 
         if (!$sku) {
-            return ['out_of_stock_at_last' => 1];
+            return [AdditionalAttribute::ATTRIBUTE_CODE => 1];
         }
 
         $value = $this->inventory->getStockStatus(
             $sku,
             $this->storeManager->getStore($storeId)->getWebsite()->getCode()
         );
 
-        return ['out_of_stock_at_last' => $value];
+        return [AdditionalAttribute::ATTRIBUTE_CODE => $value];
     }
 }

Plugin/DataProvider/Product/SearchCriteriaBuilder/AddDefaultOrders.php

@@ -0,0 +1,35 @@
+<?php
+namespace GhoSter\OutOfStockAtLast\Plugin\DataProvider\Product\SearchCriteriaBuilder;
+
+use Ghoster\OutOfStockAtLast\Model\AdditionalAttribute;
+
+class AddDefaultOrders
+{
+    /**
+     * Add default sorting
+     *
+     * phpcs:disable Magento2.Annotation.MethodArguments.NoTypeSpecified
+     *
+     * @param $subject
+     * @param array $args
+     * @param bool $includeAggregation
+     * @return array
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function beforeBuild(
+        $subject,
+        array $args,
+        bool $includeAggregation
+    ): array {
+        if (!isset($args['sort'])) {
+            $args['sort'] = [];
+        }
+
+        if (!isset($args['sort'][AdditionalAttribute::ATTRIBUTE_CODE])
+        ) {
+            $args['sort'][AdditionalAttribute::ATTRIBUTE_CODE] = 'DESC';
+        }
+
+        return [$args, $includeAggregation];
+    }
+}

Plugin/Model/Adapter/AdditionalFieldMapperPlugin.php

@@ -3,6 +3,8 @@
 
 namespace GhoSter\OutOfStockAtLast\Plugin\Model\Adapter;
 
+use Ghoster\OutOfStockAtLast\Model\AdditionalAttribute;
+
 /**
  * Class AdditionalFieldMapperPlugin for es attributes mapping
  */
@@ -12,7 +14,7 @@ class AdditionalFieldMapperPlugin
      * @var string[]
      */
     protected $allowedFields = [
-        'out_of_stock_at_last' => 'integer'
+        AdditionalAttribute::ATTRIBUTE_CODE => 'integer'
     ];
 
     /**

Plugin/Model/Adapter/BatchDataMapper/ProductDataMapperPlugin.php

@@ -39,22 +39,22 @@ public function __construct(StockDataMapper $stockDataMapper, Inventory $invento
      * Map more attributes
      *
      * @param ProductDataMapper $subject
-     * @param mixed $documents
-     * @param mixed $documentData
+     * @param array $documents
+     * @param array $documentData
      * @param mixed $storeId
-     * @param mixed $context
-     * @return mixed
+     * @param array $context
+     * @return array
      * @throws NoSuchEntityException
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function afterMap(
         ProductDataMapper $subject,
-        $documents,
-        $documentData,
+        array $documents,
+        array $documentData,
         $storeId,
-        $context
-    ) {
+        array $context
+    ): array {
         $this->inventory->saveRelation(array_keys($documents));
 
         foreach ($documents as $productId => $document) {

Plugin/Model/ResourceModel/Product/CollectionPlugin.php

@@ -3,6 +3,7 @@
 
 namespace GhoSter\OutOfStockAtLast\Plugin\Model\ResourceModel\Product;
 
+use Ghoster\OutOfStockAtLast\Model\AdditionalAttribute;
 use Magento\Catalog\Model\ResourceModel\Product\Collection;
 use Magento\Framework\DB\Select;
 
@@ -87,7 +88,7 @@ private function applyOutOfStockAtLastOrders(Collection $collection)
     {
         if (!$collection->getFlag('sorted_by_oos_flag')) {
             $collection->setFlag('sorted_by_oos_flag', true);
-            $collection->setOrder('out_of_stock_at_last', Select::SQL_DESC);
+            $collection->setOrder(AdditionalAttribute::ATTRIBUTE_CODE, Select::SQL_DESC);
         }
     }
 

composer.json

@@ -2,8 +2,8 @@
     "name": "ghoster/module-outofstockatlast",
     "description": "Magento 2.4.x module Sort Out Of Stock Product At last the product list",
     "require": {
-        "php": "~7.4.0||~8.0.0||~8.1.0||~8.2.0||~8.3.0||~8.4.0",
-        "magento/framework": "^102.0|^103.0"
+        "php": ">=8.1.0",
+        "magento/framework": ">=102.0.0"
     },
     "minimum-stability": "stable",
     "archive": {

etc/graphql/di.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <type name="Magento\CatalogGraphQl\DataProvider\Product\SearchCriteriaBuilder">
+        <plugin name="GhoSter_OutOfStockAtLast::add-default-orders" type="GhoSter\OutOfStockAtLast\Plugin\DataProvider\Product\SearchCriteriaBuilder\AddDefaultOrders" sortOrder="10" />
+    </type>
+</config>

etc/module.xml

@@ -1,10 +1,15 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="GhoSter_OutOfStockAtLast" setup_version="1.0.0">
+    <module name="GhoSter_OutOfStockAtLast">
         <sequence>
             <module name="Magento_Catalog"/>
             <module name="Magento_Elasticsearch7"/>
+            <module name="Magento_ConfigurableProduct"/>
+            <module name="Magento_CatalogGraphQl"/>
+            <module name="Magento_Store"/>
+            <module name="Magento_Elasticsearch"/>
+            <module name="Magento_CatalogInventory"/>
         </sequence>
     </module>
 </config>