Upgrade the ProductListGui module

Upgrading from version 2.* to version 3.*

Version 3.* of the ProductLabelGui module adds the possibility to assign stores to the product labels in the Back Office.

To upgrade to the new version of the module, do the following:

1. Upgrade the ProductLabelStorage module to the new version:

composer require spryker/product-label-gui:"^3.0.0" --update-with-dependencies

2. Regenerate the data transfer object:

console transfer:generate

3. Add the StoreRelationToggleFormTypePlugin plugin provided below in \Pyz\Zed\ProductLabelGui\ProductLabelGuiDependencyProvider:

<?php

namespace Pyz\Zed\ProductLabelGui;

use Spryker\Zed\Kernel\Communication\Form\FormTypeInterface;
use Spryker\Zed\ProductLabelGui\ProductLabelGuiDependencyProvider as SprykerProductLabelGuiDependencyProvider;
use Spryker\Zed\Store\Communication\Plugin\Form\StoreRelationToggleFormTypePlugin;

class ProductLabelGuiDependencyProvider extends SprykerProductLabelGuiDependencyProvider
{
    /**
     * @return \Spryker\Zed\Kernel\Communication\Form\FormTypeInterface
     */
    protected function getStoreRelationFormTypePlugin(): FormTypeInterface
    {
        return new StoreRelationToggleFormTypePlugin();
    }
}

Upgrading from version 1.* to version 2.0.0

The main point of the ProductListGui v2.0.0 is the following: exclusive ownership for product lists was removed from the merchant relations.

Instead of this, an enhanced ownership concept was introduced to allow multiple different domain entities to own a product list.

Other changes are listed below:

• Adjusted EditController::indexAction() to provide aggregation tabs for the twig template.
• Introduced ProductConcreteRelationConfigurableBundleTemplateSlotEditSubTabsProviderPlugin.
• Introduced ProductConcreteRelationConfigurableBundleTemplateSlotEditTablesProviderPlugin.
• Introduced ProductConcreteRelationCsvConfigurableBundleTemplateSlotEditFormFileUploadHandlerPlugin.
• Introduced ProductListManagementConfigurableBundleTemplateSlotEditFormDataProviderExpanderPlugin.
• Introduced ProductListManagementConfigurableBundleTemplateSlotEditFormExpanderPlugin.
• Introduced ProductListManagementConfigurableBundleTemplateSlotEditTabsExpanderPlugin.
• Replaced ProductListFacade::deleteProductList() usage with ProductListFacade::removeProductList() in DeleteController::confirmAction().
• Introduced extension point to inject buttons for the product list table.
• Adjusted UI to see the owner domain entities for each product list.
• Adjusted deletion logic so that it is not possible to delete a product list if it has any owner domain entity.
• Introduced extension point to define the ownership over product list by another domain entity.
• Deprecated ProductListOwnerTypeFormExpanderPluginInterface to allow multiple owners concept.

Estimated migration time: 1-2 hours

To upgrade to the new version of the module, do the following:

1. Update ProductListGui module version and its dependencies by running the following command:

composer require spryker/product-list-gui:"^2.0.0" --update-with-dependencies

2. Update the transfer objects:

console transfer:generate

3. Generate translator cache by running the following command to get the latest Zed translations:

console translator:generate-cache

4. Remove the following methods from src/Pyz/Zed/ProductListGui/ProductListGuiDependencyProvider.php (if any present):

• getProductListOwnerTypeFormExpanderPlugins
• getProductListTableConfigExpanderPlugins
• getProductListTableQueryCriteriaExpanderPlugins
• getProductListTableDataExpanderPlugins
• getProductListTableHeaderExpanderPlugins

5. If your project has any domain entities that use product list (e.g. Configurable Bundle, Merchant Relationship, etc), add the respective plugins to the dependency provider:

<?php

namespace Pyz\Zed\ProductListGui;

use Spryker\Zed\ConfigurableBundleGui\Communication\Plugin\ProductListGui\ConfigurableBundleTemplateListProductListTopButtonsExpanderPlugin;
use Spryker\Zed\ConfigurableBundleGui\Communication\Plugin\ProductListGui\ConfigurableBundleTemplateProductListUsedByTableExpanderPlugin;
use Spryker\Zed\MerchantRelationshipProductListGui\Communication\Plugin\ProductListGui\MerchantRelationListProductListTopButtonsExpanderPlugin;
use Spryker\Zed\MerchantRelationshipProductListGui\Communication\Plugin\ProductListGui\MerchantRelationshipProductListUsedByTableExpanderPlugin;
use Spryker\Zed\ProductListGui\ProductListGuiDependencyProvider as SprykerProductListGuiDependencyProvider;

class ProductListGuiDependencyProvider extends SprykerProductListGuiDependencyProvider
{
    /**
     * @return \Spryker\Zed\ProductListGuiExtension\Dependency\Plugin\ProductListTopButtonsExpanderPluginInterface[]
     */
    protected function getProductListTopButtonsExpanderPlugins(): array
    {
        return [
            new ConfigurableBundleTemplateListProductListTopButtonsExpanderPlugin(),
            new MerchantRelationListProductListTopButtonsExpanderPlugin(),
        ];
    }

    /**
     * @return \Spryker\Zed\ProductListGuiExtension\Dependency\Plugin\ProductListUsedByTableExpanderPluginInterface[]
     */
    protected function getProductListUsedByTableExpanderPlugins(): array
    {
        return [
            new ConfigurableBundleTemplateProductListUsedByTableExpanderPlugin(),
            new MerchantRelationshipProductListUsedByTableExpanderPlugin(),
        ];
    }
}

• ProductListTopButtonsExpanderPluginInterface[] plugins are responsible for adding the top button to the product list index page which leads to the domain entity page which uses the product list for its purpose.
• ProductListUsedByTableExpanderPluginInterface[] plugins are responsible for expanding table at Used By tab at Product List Edit page. This table contains a list of domain entities that use exact product list.

6. Run the following command to apply JS changes:

console frontend:zed:build