SW-801 Export variants with different attribute values v1

src/Export/Adapters/AdapterFactory.php

@@ -38,6 +38,10 @@ class AdapterFactory
 
     private UserGroupsAdapter $userGroupsAdapter;
 
+    private VariantConfigurationAdapter $variantConfigurationAdapter;
+
+    private OptionsAdapter $optionsAdapter;
+
     public function __construct(
         AttributeAdapter $attributeAdapter,
         BonusAdapter $bonusAdapter,
@@ -54,7 +58,8 @@ public function __construct(
         SummaryAdapter $summaryAdapter,
         ShopwarePropertiesAdapter $shopwarePropertiesAdapter,
         UrlAdapter $urlAdapter,
-        UserGroupsAdapter $userGroupsAdapter
+        UserGroupsAdapter $userGroupsAdapter,
+        VariantConfigurationAdapter $variantConfigurationAdapter
     ) {
         $this->attributeAdapter = $attributeAdapter;
         $this->bonusAdapter = $bonusAdapter;
@@ -72,6 +77,7 @@ public function __construct(
         $this->shopwarePropertiesAdapter = $shopwarePropertiesAdapter;
         $this->urlAdapter = $urlAdapter;
         $this->userGroupsAdapter = $userGroupsAdapter;
+        $this->variantConfigurationAdapter = $variantConfigurationAdapter;
     }
 
     public function getAttributeAdapter(): AttributeAdapter
@@ -153,4 +159,14 @@ public function getUserGroupsAdapter(): UserGroupsAdapter
     {
         return $this->userGroupsAdapter;
     }
+
+    public function getVariantConfigurationAdapter(): VariantConfigurationAdapter
+    {
+        return $this->variantConfigurationAdapter;
+    }
+
+    public function getOptionsAdapter(): OptionsAdapter
+    {
+        return $this->optionsAdapter;
+    }
 }

src/Export/Adapters/AttributeAdapter.php

@@ -51,15 +51,13 @@ public function adapt(ProductEntity $product): array
         $categoryAttributes = $this->getCategoryAndCatUrlAttributes($product);
         $manufacturerAttributes = $this->getManufacturerAttributes($product);
         $propertyAttributes = $this->getPropertyAttributes($product);
-        $optionAttributes = $this->getOptionAttributes($product);
         $customFieldAttributes = $this->getCustomFieldAttributes($product);
         $additionalAttributes = $this->getAdditionalAttributes($product);
 
         return array_merge(
             $categoryAttributes,
             $manufacturerAttributes,
             $propertyAttributes,
-            $optionAttributes,
             $customFieldAttributes,
             $additionalAttributes,
         );
@@ -160,18 +158,6 @@ protected function getPropertyAttributes(ProductEntity $product): array
         return $this->getPropertyGroupOptionAttributes($product->properties);
     }
 
-    /**
-     * @return Attribute[]
-     */
-    protected function getOptionAttributes(ProductEntity $product): array
-    {
-        if (!$product->options || !$product->options->count()) {
-            return [];
-        }
-
-        return $this->getPropertyGroupOptionAttributes($product->options);
-    }
-
     /**
      * @return Attribute[]
      */

src/Export/Adapters/ExportItemAdapter.php

@@ -5,6 +5,7 @@
 namespace FINDOLOGIC\Shopware6Common\Export\Adapters;
 
 use FINDOLOGIC\Export\Data\Item;
+use FINDOLOGIC\Shopware6Common\Export\Config\PluginConfig;
 use FINDOLOGIC\Shopware6Common\Export\Events\AfterItemAdaptEvent;
 use FINDOLOGIC\Shopware6Common\Export\Events\AfterVariantAdaptEvent;
 use FINDOLOGIC\Shopware6Common\Export\Events\BeforeItemAdaptEvent;
@@ -24,15 +25,19 @@ class ExportItemAdapter
 
     private LoggerInterface $logger;
 
+    protected PluginConfig $pluginConfig;
+
     private ?EventDispatcherInterface $eventDispatcher;
 
     public function __construct(
         AdapterFactory $adapterFactory,
         LoggerInterface $logger,
+        PluginConfig $pluginConfig,
         ?EventDispatcherInterface $eventDispatcher = null
     ) {
         $this->adapterFactory = $adapterFactory;
         $this->logger = $logger;
+        $this->pluginConfig = $pluginConfig;
         $this->eventDispatcher = $eventDispatcher;
     }
 
@@ -142,16 +147,27 @@ public function adaptProduct(Item $item, ProductEntity $product): ?Item
     public function adaptVariant(Item $item, ProductEntity $product): ?Item
     {
         if ($this->eventDispatcher) {
-            $this->eventDispatcher->dispatch(new BeforeVariantAdaptEvent($product, $item), BeforeVariantAdaptEvent::NAME);
+            $this->eventDispatcher->dispatch(
+                new BeforeVariantAdaptEvent($product, $item),
+                BeforeVariantAdaptEvent::NAME,
+            );
         }
 
         try {
             foreach ($this->adapterFactory->getOrderNumbersAdapter()->adapt($product) as $orderNumber) {
                 $item->addOrdernumber($orderNumber);
             }
 
-            foreach ($this->adapterFactory->getAttributeAdapter()->adapt($product) as $attribute) {
-                $item->addMergedAttribute($attribute);
+            if ($this->pluginConfig->getMainVariant() != 'default') {
+                foreach ($this->adapterFactory->getOptionsAdapter()->getOptionAttributes($product) as $attribute) {
+                    $item->addMergedAttribute($attribute);
+                }
+            } else {
+                $attributes = $this->adapterFactory->getVariantConfigurationAdapter()
+                    ->getOptionAttributes($product);
+                foreach ($attributes as $attribute) {
+                    $item->addMergedAttribute($attribute);
+                }
             }
 
             foreach ($this->adapterFactory->getShopwarePropertiesAdapter()->adapt($product) as $property) {

src/Export/Adapters/OptionsAdapter.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FINDOLOGIC\Shopware6Common\Export\Adapters;
+
+use FINDOLOGIC\Export\Data\Attribute;
+use FINDOLOGIC\Shopware6Common\Export\Config\PluginConfig;
+use FINDOLOGIC\Shopware6Common\Export\Utils\Utils;
+use Vin\ShopwareSdk\Data\Entity\Product\ProductEntity;
+use Vin\ShopwareSdk\Data\Entity\PropertyGroupOption\PropertyGroupOptionCollection;
+use Vin\ShopwareSdk\Data\Entity\PropertyGroupOption\PropertyGroupOptionEntity;
+
+class OptionsAdapter
+{
+
+    protected PluginConfig $pluginConfig;
+
+    public function __construct(
+        PluginConfig $pluginConfig,
+    ) {
+        $this->pluginConfig = $pluginConfig;
+    }
+
+    /**
+     * @return Attribute[]
+     */
+    public function getOptionAttributes(ProductEntity $product): array
+    {
+        if (!$product->options || !$product->options->count()) {
+            return [];
+        }
+
+        return Utils::getPropertyGroupOptionAttributes($product->options, $this->pluginConfig);
+    }
+}

src/Export/Adapters/VariantConfigurationAdapter.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FINDOLOGIC\Shopware6Common\Export\Adapters;
+
+use FINDOLOGIC\Export\Data\Attribute;
+use FINDOLOGIC\Shopware6Common\Export\Config\MainVariant;
+use FINDOLOGIC\Shopware6Common\Export\Config\PluginConfig;
+use FINDOLOGIC\Shopware6Common\Export\Utils\Utils;
+use Vin\ShopwareSdk\Data\Entity\Product\ProductEntity;
+use Vin\ShopwareSdk\Data\Entity\PropertyGroupOption\PropertyGroupOptionEntity;
+
+class VariantConfigurationAdapter
+{
+    protected PluginConfig $pluginConfig;
+
+    public function __construct(
+        PluginConfig $pluginConfig
+    ) {
+        $this->pluginConfig = $pluginConfig;
+    }
+
+    /**
+     * @return Attribute[]
+     */
+    public function getOptionAttributes(ProductEntity $product): array
+    {
+        $options = $product->options;
+
+        $isVariant = !is_null($product->parentId);
+
+        if (!$options->count()) {
+            return [];
+        }
+
+        if ($isVariant) {
+            $variantlisting = array_filter(
+                $product->variantListingConfig['configuratorGroupConfig'] ?? [],
+                function (array $listing) {
+                    return $listing['expressionForListings'];
+                }
+            );
+            $variantListingGroupId = array_map(fn($listing) => $listing['id'], $variantlisting);
+
+            if (
+                $this->pluginConfig->getMainVariant() === MainVariant::SHOPWARE_DEFAULT &&
+                count($variantlisting) &&
+                !$product->variantListingConfig['displayParent']
+            ) {
+                $options = $options->filter(function (PropertyGroupOptionEntity $option) use ($variantListingGroupId) {
+                    return !in_array($option->groupId, $variantListingGroupId);
+                });
+            }
+        }
+
+        return Utils::getPropertyGroupOptionAttributes($options, $this->pluginConfig);
+    }
+}

src/Export/Utils/Utils.php

@@ -4,6 +4,10 @@
 
 namespace FINDOLOGIC\Shopware6Common\Export\Utils;
 
+use FINDOLOGIC\Export\Data\Attribute;
+use FINDOLOGIC\Shopware6Common\Export\Config\PluginConfig;
+use Vin\ShopwareSdk\Data\Entity\PropertyGroupOption\PropertyGroupOptionCollection;
+use Vin\ShopwareSdk\Data\Entity\PropertyGroupOption\PropertyGroupOptionEntity;
 use Vin\ShopwareSdk\Data\Entity\SalesChannelDomain\SalesChannelDomainCollection;
 use Vin\ShopwareSdk\Data\Entity\SalesChannelDomain\SalesChannelDomainEntity;
 
@@ -162,4 +166,65 @@ public static function getCurrencyPrice(array $prices, string $currencyId): ?arr
 
         return count($filteredProductPrice) ? $filteredProductPrice[array_key_first($filteredProductPrice)] : null;
     }
+
+    /**
+     * @return Attribute[]
+     */
+    public static function getPropertyGroupOptionAttributes(
+        PropertyGroupOptionCollection $collection,
+        PluginConfig $pluginConfig
+    ): array {
+        $attributes = [];
+
+        foreach ($collection as $propertyGroupOptionEntity) {
+            $group = $propertyGroupOptionEntity->group;
+            if ($group && !$group->filterable) {
+                continue;
+            }
+
+            $attributes = array_merge($attributes, static::getAttributePropertyAsAttribute(
+                $propertyGroupOptionEntity,
+                $pluginConfig
+            ));
+        }
+
+        return $attributes;
+    }
+
+    /**
+     * @return Attribute[]
+     */
+    protected static function getAttributePropertyAsAttribute(
+        PropertyGroupOptionEntity $propertyGroupOptionEntity,
+        PluginConfig $pluginConfig
+    ): array {
+        $attributes = [];
+
+        $group = $propertyGroupOptionEntity->group;
+        if ($group && $propertyGroupOptionEntity->getTranslation('name') && $group->getTranslation('name')) {
+            $groupName = static::getAttributeKey($group->getTranslation('name'), $pluginConfig);
+            $propertyGroupOptionName = $propertyGroupOptionEntity->getTranslation('name');
+            if (!Utils::isEmpty($groupName) && !Utils::isEmpty($propertyGroupOptionName)) {
+                $propertyGroupAttrib = new Attribute($groupName);
+                $propertyGroupAttrib->addValue(Utils::removeControlCharacters($propertyGroupOptionName));
+
+                $attributes[] = $propertyGroupAttrib;
+            }
+        }
+
+        return $attributes;
+    }
+
+    /**
+     * For API Integrations, we have to remove special characters from the attribute key as a requirement for
+     * sending data via API.
+     */
+    protected static function getAttributeKey(?string $key, PluginConfig $pluginConfig): ?string
+    {
+        if ($pluginConfig->isIntegrationTypeApi()) {
+            return Utils::removeSpecialChars($key);
+        }
+
+        return $key;
+    }
 }

tests/Export/Adapters/AttributeAdapterTest.php

@@ -345,7 +345,7 @@ public function testEmptyCategoryNameShouldStillExportCategory(): void
 
         $attributes = $this->attributeAdapter->adapt($productEntity);
 
-        $this->assertCount(7, $attributes);
+        $this->assertCount(5, $attributes);
         $this->assertSame('cat_url', $attributes[0]->getKey());
 
         $catUrls = $attributes[0]->getValues();
@@ -409,7 +409,6 @@ public function testOnlyUniqueCategoriesAreExported(bool $isParentAssigned, bool
         $exportItemAdapter = $this->getExportItemAdapter(null, $config);
 
         $item = $exportItemAdapter->adapt($initialItem, $productEntity);
-
         if ($item === null) {
             $item = $initialItem;
         }
@@ -419,7 +418,6 @@ public function testOnlyUniqueCategoriesAreExported(bool $isParentAssigned, bool
         $attributes = $reflector->getProperty('attributes');
         $attributes->setAccessible(true);
         $value = $attributes->getValue($item);
-
         $this->assertArrayHasKey('cat_url', $value);
         $categoryUrlAttributeValues = $value['cat_url']->getValues();
         $this->assertSame($expectedCatUrls, $categoryUrlAttributeValues);

tests/Export/Adapters/ExportItemAdapterTest.php

@@ -9,6 +9,7 @@
 use FINDOLOGIC\Export\XML\XMLItem;
 use FINDOLOGIC\Shopware6Common\Export\Adapters\AdapterFactory;
 use FINDOLOGIC\Shopware6Common\Export\Adapters\AttributeAdapter;
+use FINDOLOGIC\Shopware6Common\Export\Config\PluginConfig;
 use FINDOLOGIC\Shopware6Common\Export\Exceptions\Product\ProductHasNoCategoriesException;
 use FINDOLOGIC\Shopware6Common\Tests\Traits\AdapterHelper;
 use FINDOLOGIC\Shopware6Common\Tests\Traits\ProductHelper;
@@ -26,6 +27,13 @@ class ExportItemAdapterTest extends TestCase
     use ProductHelper;
     use ServicesHelper;
 
+    public PluginConfig $pluginConfig;
+
+    public function setUp(): void
+    {
+        $this->pluginConfig = $this->getPluginConfig();
+    }
+
     public function testEventsAreDispatched(): void
     {
         $xmlItem = new XMLItem(Uuid::randomHex());
@@ -39,6 +47,12 @@ public function testEventsAreDispatched(): void
         /** @var EventDispatcher $eventDispatcherMock */
         $adapter = $this->getExportItemAdapter(null, null, null, $eventDispatcherMock);
         $adapter->adapt($xmlItem, $product);
+        $id = Uuid::randomHex();
+        $product = $this->createTestProduct([
+            'id' => $id,
+            'categories' => [],
+        ]);
+        $xmlItem = new XMLItem($id);
         $adapter->adaptVariant($xmlItem, $product);
     }
 
@@ -64,7 +78,7 @@ public function testExceptionIsNotThrownForVariantWithNoCategories(): void
             'categories' => [],
         ]);
 
-        $adapter = $this->getExportItemAdapter();
+        $adapter = $this->getExportItemAdapter(null, $this->pluginConfig, null, null);
         $item = $adapter->adaptVariant(new XMLItem($id), $product);
 
         $this->assertEquals($id, $item->getId());