FFWEB-2676: Export category for suggest

Author: grzegorz-jamroz

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## Unreleased
+### Add
+- Export category for suggest
+
 ## [v4.4.1] - 2023.03.08
 ### Add
 - Add add option to send the SID as userId when user not logged in

README.md

@@ -218,6 +218,10 @@ For category export:
 
     [YOUR_SHOP_URL]?cl=http_category_feed&fnc=export
 
+For suggest category export:
+
+    [YOUR_SHOP_URL]?cl=http_suggest_category_feed&fnc=export
+
 **Note:** Please keep in mind that the feed file is not directly available under the location. There is an export mechanism that does it on demand, so the whole process may take some time.
 
 #### Basic Authentication

composer.json

@@ -32,7 +32,7 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "Tests\\": "tests/"
+      "FactFinderTests\\": "tests/"
     }
   },
   "extra": {

phpunit.xml

@@ -17,11 +17,4 @@
             <directory>tests/Unit</directory>
         </testsuite>
     </testsuites>
-
-    <coverage cacheDirectory=".phpunit.cache/code-coverage"
-              processUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">src</directory>
-        </include>
-    </coverage>
 </phpunit>

src/Controller/SuggestCategoryFeedController.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\FactFinder\Oxid\Controller;
+
+use Omikron\FactFinder\Oxid\Export\SuggestCategoryFeed;
+
+class SuggestCategoryFeedController extends ArticleFeedController
+{
+    protected $exportedType = SuggestCategoryFeed::class;
+}

src/Export/AbstractFeed.php

@@ -4,7 +4,6 @@
 
 namespace Omikron\FactFinder\Oxid\Export;
 
-use Omikron\FactFinder\Oxid\Export\Field\FieldInterface;
 use Omikron\FactFinder\Oxid\Export\Stream\StreamInterface;
 use OxidEsales\Eshop\Core\Registry;
 use ReflectionClass;
@@ -28,9 +27,4 @@ protected function getChannel(string $lang): string
     {
         return Registry::getConfig()->getConfigParam('ffChannel')[$lang];
     }
-
-    protected function getFieldName(FieldInterface $field): string
-    {
-        return $field->getName();
-    }
 }

src/Export/ArticleFeed.php

@@ -6,10 +6,10 @@
 
 use Omikron\FactFinder\Oxid\Export\Data\ArticleCollection;
 use Omikron\FactFinder\Oxid\Export\Entity\DataProvider;
+use Omikron\FactFinder\Oxid\Export\Field\Article\FieldInterface;
 use Omikron\FactFinder\Oxid\Export\Field\Attribute as AttributeField;
 use Omikron\FactFinder\Oxid\Export\Field\Brand;
 use Omikron\FactFinder\Oxid\Export\Field\CategoryPath;
-use Omikron\FactFinder\Oxid\Export\Field\FieldInterface;
 use Omikron\FactFinder\Oxid\Export\Field\FilterAttributes;
 use Omikron\FactFinder\Oxid\Export\Field\Keywords;
 use Omikron\FactFinder\Oxid\Export\Stream\StreamInterface;
@@ -62,4 +62,9 @@ protected function getConfigFields(): array
             return oxNew(AttributeField::class, $attribute);
         }, array_values(oxNew(ExportConfig::class)->getSingleFields()));
     }
+
+    protected function getFieldName(FieldInterface $field): string
+    {
+        return $field->getName();
+    }
 }

src/Export/CategoryFeed.php

@@ -6,7 +6,7 @@
 
 use Omikron\FactFinder\Oxid\Export\Data\CategoryCollection;
 use Omikron\FactFinder\Oxid\Export\Entity\DataProvider;
-use Omikron\FactFinder\Oxid\Export\Field\FieldInterface;
+use Omikron\FactFinder\Oxid\Export\Field\Article\FieldInterface;
 use Omikron\FactFinder\Oxid\Export\Stream\StreamInterface;
 
 class CategoryFeed extends AbstractFeed
@@ -44,4 +44,9 @@ protected function getAdditionalFields(): array
     {
         return [];
     }
+
+    protected function getFieldName(FieldInterface $field): string
+    {
+        return $field->getName();
+    }
 }

src/Export/Entity/ArticleEntity.php

@@ -4,7 +4,7 @@
 
 namespace Omikron\FactFinder\Oxid\Export\Entity;
 
-use Omikron\FactFinder\Oxid\Export\Field\FieldInterface;
+use Omikron\FactFinder\Oxid\Export\Field\Article\FieldInterface;
 use OxidEsales\Eshop\Application\Model\Article;
 
 class ArticleEntity implements ExportEntityInterface, DataProviderInterface

src/Export/Entity/DataProvider.php

@@ -5,18 +5,19 @@
 namespace Omikron\FactFinder\Oxid\Export\Entity;
 
 use Omikron\FactFinder\Oxid\Export\Data\CollectionInterface;
-use Omikron\FactFinder\Oxid\Export\Field\FieldInterface;
+use Omikron\FactFinder\Oxid\Export\Field\Article\FieldInterface as ArticleField;
+use Omikron\FactFinder\Oxid\Export\Field\Category\FieldInterface as CategoryField;
 use OxidEsales\Eshop\Core\Model\MultiLanguageModel;
 
 class DataProvider implements DataProviderInterface
 {
-    /** @var FieldInterface[] */
+    /** @var ArticleField[]|CategoryField[] */
     private $fields;
 
     /** @var CollectionInterface */
     private $collection;
 
-    public function __construct(CollectionInterface $collection, FieldInterface ...$fields)
+    public function __construct(CollectionInterface $collection, ...$fields)
     {
         $this->collection = $collection;
         $this->fields     = $fields;