Product Groups feature integration

Last updated:
Edit on GitHub

Install feature core

Follow the steps below to install Product group feature core.

Prerequisites

Install the required features:

NAME VERSION
Product 202311.0
Spryker Core 202311.0

1) Install the required modules

Install the required modules using Composer:

composer require spryker-feature/product-groups: "202311.0" --update-with-dependencies
Verification

Make sure that the following modules have been installed:

MODULE EXPECTED DIRECTORY
spryker/product-group vendor/spryker/product-group
spryker/product-group-storage vendor/spryker/product-group-storage

2) Set up database schema and transfer objects

  1. Adjust the schema definition so entity changes will trigger events.
AFFECTED ENTITY TRIGGERED EVENTS
spy_product_abstract_group Entity.spy_product_abstract_group.create
Entity.spy_product_abstract_group.update
Entity.spy_product_abstract_group.delete

src/Pyz/Zed/ProductGroup/Persistence/Propel/Schema/spy_product_group.schema.xml

<?xml version="1.0"?>
<database xmlns="spryker:schema-01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          name="zed"
          xsi:schemaLocation="spryker:schema-01 https://static.spryker.com/schema-01.xsd"
          namespace="Orm\Zed\ProductGroup\Persistence"
          package="src.Orm.Zed.ProductGroup.Persistence">

    <table name="spy_product_abstract_group">
        <behavior name="event">
            <parameter name="spy_product_abstract_group_all" column="*"/>
        </behavior>
    </table>

</database>
  1. Set up synchronization queue pools so non-multi-store entities (not store specific entities) will be synchronized among stores:

src/Pyz/Zed/ProductGroupStorage/Persistence/Propel/Schema/spy_product_group_storage.schema.xml

<?xml version="1.0"?>
<database xmlns="spryker:schema-01"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          name="zed"
          xsi:schemaLocation="spryker:schema-01 https://static.spryker.com/schema-01.xsd"
          namespace="Orm\Zed\ProductGroupStorage\Persistence"
          package="src.Orm.Zed.ProductGroupStorage.Persistence">

    <table name="spy_product_abstract_group_storage">
        <behavior name="synchronization">
            <parameter name="queue_pool" value="synchronizationPool"/>
        </behavior>
    </table>

</database>
  1. Apply database changes and generate entity and transfer changes:
console propel:install
console transfer:generate
Verification

Make sure that the following changes have been applied by checking your database:

DATABASE ENTITY TYPE EVENT
spy_product_group table created
spy_product_abstract_group table created
spy_product_abstract_group_storage table created
Verification

Make sure that the following changes took place in transfer objects:

TRANSFER TYPE EVENT PATH
ProductGroup class created src/Generated/Shared/Transfer/ProductGroupTransfer
ProductAbstractGroups class created src/Generated/Shared/Transfer/ProductAbstractGroupsTransfer
ProductAbstractGroupStorage class created src/Generated/Shared/Transfer/ProductAbstractGroupStorageTransfer
Verification

Make sure that the changes have been implemented successfully. To do it, trigger the following methods and make sure that the above events have been triggered:

PATH METHOD NAME
src/Orm/Zed/ProductGroup/Persistence/Base/SpyProductAbstractGroup.php prepareSaveEventName()
addSaveEventToMemory()
addDeleteEventToMemory()

3) Configure Export to Redis

This step will publish tables on change (create, edit, delete) to the spy_product_abstract_group_storage table and synchronize the data to Storage.

Set up Event Listeners

Set up the following plugin(s):

Plugin Specification Prerequisites Namespace
ProductGroupStorageEventSubscriber Registers listeners that are responsible to publish product abstract group storage entity changes when a related entity change event occurs. None Spryker\Zed\ProductGroupStorage\Communication\Plugin\Event\Subscriber 
<?php

namespace Pyz\Zed\Event;

use Spryker\Zed\Event\EventDependencyProvider as SprykerEventDependencyProvider;
use Spryker\Zed\ProductGroupStorage\Communication\Plugin\Event\Subscriber\ProductGroupStorageEventSubscriber;

class EventDependencyProvider extends SprykerEventDependencyProvider
{
    public function getEventSubscriberCollection()
    {
        $eventSubscriberCollection = parent::getEventSubscriberCollection();
        $eventSubscriberCollection->add(new ProductGroupStorageEventSubscriber());

        return $eventSubscriberCollection;
    }
}

Setup re-generate and re-sync features

Set up the following plugin(s):

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
ProductGroupSynchronizationDataPlugin Allows synchronizing the whole storage table content into Storage. None Spryker\Zed\ProductGroupStorage\Communication\Plugin\Synchronization 
<?php

namespace Pyz\Zed\ProductGroupStorage;

use Pyz\Zed\Synchronization\SynchronizationConfig;
use Spryker\Zed\ProductGroupStorage\ProductGroupStorageConfig as SprykerProductGroupStorageConfig;

class ProductGroupStorageConfig extends SprykerProductGroupStorageConfig
{
    /**
     * @return string|null
     */
    public function getProductGroupSynchronizationPoolName(): ?string
    {
        return SynchronizationConfig::DEFAULT_SYNCHRONIZATION_POOL_NAME;
    }
}

<?php

namespace Pyz\Zed\Synchronization;

use Spryker\Zed\ProductGroupStorage\Communication\Plugin\Synchronization\ProductGroupSynchronizationDataPlugin;
use Spryker\Zed\Synchronization\SynchronizationDependencyProvider as SprykerSynchronizationDependencyProvider;

class SynchronizationDependencyProvider extends SprykerSynchronizationDependencyProvider
{
    /**
     * @return \Spryker\Zed\SynchronizationExtension\Dependency\Plugin\SynchronizationDataPluginInterface[]
     */
    protected function getSynchronizationDataPlugins(): array
    {
        return [
            new ProductGroupSynchronizationDataPlugin(),
        ];
    }
}

4) Import data

Follow the steps to import product group data:

Demo data

The following imported entities will be used as a product group in Spryker OS.

  1. Prepare data according to your requirements using the following demo data:

data/import/product_group.csv

>group_key,abstract_sku,position
group_key_1,001,0
group_key_1,002,1
group_key_1,003,2
group_key_2,004,0
group_key_2,005,1
COLUMN REQUIRED DATA TYPE DATA EXAMPLE DATA EXPLANATION
group_key Yes string group_key_1 Unique product group identifier.
abstract_sku Yes string 001 SKU of an abstract product.
position Yes integer 0 The position of a product in the group.
  1. Run the following console commands to import data:
console data:import:product-group
Verification

Make sure that the configured data has been added to the spy_product_group and spy_product_abstract_group tables in the database.

Install feature front end

Follow the steps below to install Product group feature front end.

Prerequisites

Install the required features:

NAME VERSION
Product 202311.0
Spryker Core 202311.0

1) Install the required modules

Install the required modules using Composer:

composer require spryker-feature/product-groups: "202311.0" --update-with-dependencies
Verification

Make sure that the following modules have been installed:

MODULE EXPECTED DIRECTORY
spryker-shop/product-group-widget vendor/spryker-shop/product-group-widget

2) Set up widgets

  1. Register the following plugins to enable widgets:
PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
ProductGroupWidget Displays product group. None SprykerShop\Yves\ProductGroupWidget\Widget
ProductGroupColorWidget Displays product group with color selector. None SprykerShop\Yves\ProductGroupWidget\Widget 
<?php

namespace Pyz\Yves\ShopApplication;

use SprykerShop\Yves\ProductGroupWidget\Widget\ProductGroupColorWidget;
use SprykerShop\Yves\ProductGroupWidget\Widget\ProductGroupWidget;
use SprykerShop\Yves\ShopApplication\ShopApplicationDependencyProvider as SprykerShopApplicationDependencyProvider;

class ShopApplicationDependencyProvider extends SprykerShopApplicationDependencyProvider
{
    /**
     * @return string[]
     */
    protected function getGlobalWidgets(): array
    {
        return [
            ProductGroupWidget::class,
            ProductGroupColorWidget::class,
        ];
    }
}
  1. Run the following command to enable Javascript and CSS changes:
console frontend:yves:build
Verification

Make sure that ProductGroupWidget has been registered:

  1. Open `http://mysprykershop.com/en/product-sets`.

  2. Pick one of the product sets with more than one abstract product in it.

  3. You can see the product card of every product in the product set.
Verification

Make sure that ProductGroupColorWidget has been registered:

  1. Open `http://mysprykershop.com/`.

  2. Product cards on the homepage have circles showing the available colors.

  3. Hovering over a color circle changes the abstract product image, title, rating, label, and the price.
FEATURE FEATURE INTEGRATION GUIDE
Product Group + Product Labels Install the Product group + Product Labels feature
Product Group + Product Rating & Reviews Install the Product Group + Product Rating & Reviews feature
Product Group + Cart Install the Product Group + Cart feature