Install the Merchant Product Restrictions feature

Last updated:
Edit on GitHub

Install feature core

Prerequisites

Install the required features:

NAME VERSION
Spryker Core 202404.0
Product Lists 202404.0
Merchant 202404.0

1) Install the required modules

Install the required modules using Composer:

composer require spryker-feature/merchant-product-restrictions:"202404.0" --update-with-dependencies
Verification

Make sure the following modules have been installed:

MODULE EXPECTED DIRECTORY
MerchantRelationshipProductList vendor/spryker/merchant-relationship-product-list
MerchantRelationshipProductListDataImport `vendor/spryker/merchant-relationship-product-list-data-import
MerchantRelationshipProductListGui vendor/spryker/merchant-relationship-product-list-gui

2) Set up database schema

Run the following commands to apply database changes, as well as generate entity and transfer changes:

console propel:install
console transfer:generate
Verification

Make sure the following changes have been applied in the database:

DATABASE ENTITY TYPE EVENT
spy_product_list.fk_merchant_relationship column created
Verification

Make sure the following changes have been applied in transfer objects:

TRANSFER TYPE EVENT TYPE
MerchantRelationshipFilter class created src/Generated/Shared/Transfer/MerchantRelationshipFilterTransfer

3) Import data

Import merchant relationship to product lists

Prepare your data according to your requirements using our demo data:

merchant_relation_key,product_list_key
mr-008,pl-001
mr-008,pl-002
mr-008,pl-003
mr-009,pl-004
mr-010,pl-005
mr-011,pl-006
mr-011,pl-007
mr-011,pl-008
COLUMN REQUIRED DATA TYPE DATA EXAMPLE DATA EXPLANATION
merchant_relation_key ✓ string mr-008 Identifier of merchant relations. The merchant relations must exist already.
product_list_key mandatory string pl-001 Identifier of product lists. The product lists must exist already.

Register the following plugin to enable data import:

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
MerchantRelationshipProductListDataImportPlugin Imports basic product list data into the database.
  • Merchant relations must be imported first.
  • Product lists must be imported first.
 Spryker\Zed\MerchantRelationshipProductListDataImport\Communication\Plugin

src/Pyz/Zed/DataImport/DataImportDependencyProvider.php

<?php

namespace Pyz\Zed\DataImport;

use Spryker\Zed\DataImport\DataImportDependencyProvider as SprykerDataImportDependencyProvider;
use Spryker\Zed\MerchantRelationshipProductListDataImport\Communication\Plugin\MerchantRelationshipProductListDataImportPlugin;

class DataImportDependencyProvider extends SprykerDataImportDependencyProvider
{
    /**
     * @return array
     */
    protected function getDataImporterPlugins(): array
    {
        return [
            new MerchantRelationshipProductListDataImportPlugin(),
        ];
    }
}

Import data:

console data:import merchant-relationship-product-list
Verification

Make sure that the configured data are added to the spy_product_list table in the database.

4) Set up behavior

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
ProductListCustomerTransferExpanderPlugin
  • Expands the customer transfer object with their assigned product lists.
  • The product list information is based on the customer’s merchant relationship.
 None Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\Customer

src/Pyz/Zed/Customer/CustomerDependencyProvider.php

<?php

namespace Pyz\Zed\Customer;

use Spryker\Zed\Customer\CustomerDependencyProvider as SprykerCustomerDependencyProvider;
use Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\Customer\ProductListCustomerTransferExpanderPlugin;

class CustomerDependencyProvider extends SprykerCustomerDependencyProvider
{
    /**
     * @return \Spryker\Zed\Customer\Dependency\Plugin\CustomerTransferExpanderPluginInterface[]
     */
    protected function getCustomerTransferExpanderPlugins()
    {
        return [
            new ProductListCustomerTransferExpanderPlugin(),
        ];
    }
}
Verification

Make sure, that when a customer (with an assigned merchant relationship that has assigned product lists) logs in, sees products only according their product list restrictions.

Register post-create and post-update plugins for MerchantRelationship module

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
ProductListMerchantRelationshipPostCreatePlugin Assigns Product Lists to Merchant Relationship after its creation. None Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\MerchantRelationship
ProductListMerchantRelationshipPostUpdatePlugin Assigns/unassigns Product Lists to Merchant Relationship after its update. None Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\MerchantRelationship
ProductListRelationshipMerchantRelationshipPreDeletePlugin Cleanups relations to merchant from product list on merchant relationship removing. None Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\MerchantRelationship

src/Pyz/Zed/MerchantRelationship/MerchantRelationshipDependencyProvider.php

<?php

namespace Pyz\Zed\MerchantRelationship;

use Spryker\Zed\MerchantRelationship\MerchantRelationshipDependencyProvider as SprykerMerchantRelationshipDependencyProvider;
use Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\MerchantRelationship\ProductListMerchantRelationshipPostCreatePlugin;
use Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\MerchantRelationship\ProductListMerchantRelationshipPostUpdatePlugin;
use Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\MerchantRelationship\ProductListRelationshipMerchantRelationshipPreDeletePlugin;

class MerchantRelationshipDependencyProvider extends SprykerMerchantRelationshipDependencyProvider
{
    /**
     * @return \Spryker\Zed\MerchantRelationshipExtension\Dependency\Plugin\MerchantRelationshipPreDeletePluginInterface[]
     */
    protected function getMerchantRelationshipPreDeletePlugins(): array
    {
        return [
            new ProductListRelationshipMerchantRelationshipPreDeletePlugin(),
        ];
    }
    /**
     * @return \Spryker\Zed\MerchantRelationshipExtension\Dependency\Plugin\MerchantRelationshipPostCreatePluginInterface[]
     */
    protected function getMerchantRelationshipPostCreatePlugins(): array
    {
        return [
            new ProductListMerchantRelationshipPostCreatePlugin(),
        ];
    }

    /**
     * @return \Spryker\Zed\MerchantRelationshipExtension\Dependency\Plugin\MerchantRelationshipPostUpdatePluginInterface[]
     */
    protected function getMerchantRelationshipPostUpdatePlugins(): array
    {
        return [
            new ProductListMerchantRelationshipPostUpdatePlugin(),
        ];
    }
}
your title goes here

Make sure that fk_merchant_relationship field of the spy_product_list table was changed while assigning product lists at merchant relationship create/update pages.

Make sure that fk_merchant_relationship field of the spy_product_list will be set to null after merchant relationship deletion.

Register delete pre-check plugins for the ProductList module

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
MerchantRelationshipProductListDeletePreCheckPlugin Finds merchant relationships that use given Product List. Disallows Product List deleting if any usage cases found. None Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\ProductList

src/Pyz/Zed/ProductList/ProductListDependencyProvider.php

<?php

namespace Pyz\Zed\ProductList;

use Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\ProductList\MerchantRelationshipProductListDeletePreCheckPlugin;
use Spryker\Zed\ProductList\ProductListDependencyProvider as SprykerProductListDependencyProvider;

class ProductListDependencyProvider extends SprykerProductListDependencyProvider
{
    /**
     * @return \Spryker\Zed\ProductListExtension\Dependency\Plugin\ProductListDeletePreCheckPluginInterface[]
     */
    protected function getProductListDeletePreCheckPlugins(): array
    {
        return [
            new MerchantRelationshipProductListDeletePreCheckPlugin(),
        ];
    }
}
Verification

Make sure that it’s impossible to delete a Product List if it’s used by Merchant Relation.

8) Configure Zed UI

Register Form Expander Plugins for the MerchantRelationshipGui module

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
ProductListMerchantRelationshipCreateFormExpanderPlugin Adds Product List multi-select field to merchant relationship create form. None Spryker\Zed\MerchantRelationshipProductListGui\Communication\Plugin\MerchantRelationshipGui
ProductListMerchantRelationshipEditFormExpanderPlugin Adds Product List multi-select field to merchant relationship create form. None Spryker\Zed\MerchantRelationshipProductListGui\Communication\Plugin\MerchantRelationshipGui
Verification

Make sure that additional field Assigned Product Lists is present at Merchant Relationship create/edit pages.

Register plugins for the ProductListGui module

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
MerchantRelationListProductListTopButtonsExpanderPlugin Expands buttons list with Merchant Relations list page button. Spryker\Zed\MerchantRelationshipProductListGui\Communication\Plugin\ProductListGui
MerchantRelationshipProductListUsedByTableExpanderPlugin Expands table data with Merchant Relationships which use Product List. Spryker\Zed\MerchantRelationshipProductListGui\Communication\Plugin\ProductListGui

src/Pyz/Zed/ProductListGui/ProductListGuiDependencyProvider.php

<?php

namespace Pyz\Zed\ProductListGui;

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 MerchantRelationListProductListTopButtonsExpanderPlugin(),
        ];
    }

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

Make sure that Merchant Relations button exists on the Overview of Product lists page.

Make sure that Used by table was populated by merchant relationships (in cases of relationship) on the Edit Product List page.