Product Set feature integration

The Product Sets feature allows you to put together multiple products for the purpose to emphasize that the set of products can be bought together. Product Sets usually have their separate list and detail pages in the shop frontend where customers can add containing products to the cart.

Prerequisites

To prepare your project to work with Product Sets:

1. Require the Product Set modules in your composer.json by running:

composer require spryker/product-set spryker/product-set-collector spryker/product-set-gui

2. Install the new database tables by running:

vendor/bin/console propel:diff

Propel should generate a migration file with the changes.

3. Apply the database changes. For this, run:

vendor/bin/console propel:migrate

4. To generate ORM models, run:

vendor/bin/console propel:model:build

5. After running this command, new classes are added.

The classes are located in your project under the \Orm\Zed\ProductSet\Persistence namespace.

6. To get the new transfer objects, run the following command:

vendor/bin/console transfer:generate

7. To rebuild Zed navigation, run the following command:

vendor/bin/console navigation:build-cache

8. Activate the Product Set collectors:

Adding ProductSetCollectorStoragePlugin to the storage collector plugin stack and ProductSetCollectorSearchPlugin to the search collector plugin stack, see the example below.

<?php

namespace Pyz\Zed\Collector;

use Spryker\Shared\ProductSet\ProductSetConfig;
use Spryker\Zed\Kernel\Container;
use Spryker\Zed\ProductSetCollector\Communication\Plugin\ProductSetCollectorSearchPlugin;
use Spryker\Zed\ProductSetCollector\Communication\Plugin\ProductSetCollectorStoragePlugin;
// ...

class CollectorDependencyProvider extends SprykerCollectorDependencyProvider
{
	/**
	 * @param \Spryker\Zed\Kernel\Container $container
	 *
	 * @return \Spryker\Zed\Kernel\Container
	 */
	public function provideBusinessLayerDependencies(Container $container)
	{
		// ...

		$container[self::SEARCH_PLUGINS] = function (Container $container) {
			return [
				// ...
				ProductSetConfig::RESOURCE_TYPE_PRODUCT_SET => new ProductSetCollectorSearchPlugin(),
			];
		};
       
		$container[self::STORAGE_PLUGINS] = function (Container $container) {
			return [
				// ...
				ProductSetConfig::RESOURCE_TYPE_PRODUCT_SET => new ProductSetCollectorStoragePlugin(),
			];
		};
        
		// ...
	}
}

Data Setup

You should now be able to use the ProductSet module Zed API to manage Product Sets, and the collectors should also be able to export them to the KV storage and Elasticsearch. In Zed you can also manage Product Sets under Products > Product Sets menu point.

This is a good time to implement an installer in your project to put products together in sets representing how you want them to be displayed in your shop frontend. Check out our Demoshop implementation for examples and ideas.

Listing Products Sets in Yves

The KV storage and Elasticsearch should by now have some Product Sets you can list and display in your shop. The exported documents in Search by default do not support the configurable search features as products (full-text search, faceted navigation, sorting, and pagination). However, since their data structure is the same it is possible to implement the same features with a custom implementation.

For simple listing the ProductSet module provides a Client API to list Product Sets from Elasticsearch. By calling the ProductSetClient::getProductSetList() method, a limited set of documents can be listed in Yves. The results are sorted in descending order by the Product Set’s weight attribute.

The executed search query works the same way as described in Search Query. If you need to extend the query, for example, by filtering current store and locale, you will need to add the necessary query expander plugins, like in the example below. Also, to format the raw response from Elasticsearch we also need to provide a result formatter plugin that is also provided by the ProductSet module.

Take a look at the following example to see how to activate the plugins:

<?php

namespace Pyz\Client\ProductSet;

use Spryker\Client\ProductSet\Plugin\Elasticsearch\ResultFormatter\ProductSetListResultFormatterPlugin;
use Spryker\Client\ProductSet\ProductSetDependencyProvider as SprykerProductSetDependencyProvider;
use Spryker\Client\Search\Plugin\Elasticsearch\QueryExpander\LocalizedQueryExpanderPlugin;
use Spryker\Client\Search\Plugin\Elasticsearch\QueryExpander\StoreQueryExpanderPlugin;

class ProductSetDependencyProvider extends SprykerProductSetDependencyProvider
{

	/**
	 * @return array
	 */
	protected function getProductSetListResultFormatterPlugins()
	{
		return [
			new ProductSetListResultFormatterPlugin(),
		];
	}

	/**
	 * @return array
	 */
	protected function getProductSetListQueryExpanderPlugins()
	{
		return [
			new LocalizedQueryExpanderPlugin(),
			new StoreQueryExpanderPlugin(),
		];
	}

}