Installing the product CMS block

Last updated:
Edit on GitHub

Product blocks are blocks that can be embedded in the product template, for which we can specify on which specific product we want them to be rendered.

To install the Product CMS Block in your project, follow the steps described in this procedure:

  1. Install the CMS Block Product Connector module with composer: 
"spryker/cms-block-product-connector": "^1.0.0"
  1. Register the form plugin by adding CmsBlockProductFormPlugin to the CMS Block GUI dependency provider \Pyz\Zed\CmsBlockGui\CmsBlockGuiDependencyProvider.
<?php
namespace Pyz\Zed\CmsBlockGui;

use Spryker\Zed\CmsBlockProductConnector\Communication\Plugin\CmsBlockProductFormPlugin;

class CmsBlockGuiDependencyProvider extends CmsBlockGuiCmsBlockGuiDependencyProvider
{
    /**
    * @return array
    */
    protected function getCmsBlockFormPlugins()
    {
        return = array_merge(parent::getCmsBlockFormPlugins(), [
            new CmsBlockProductFormPlugin(),
        ]);
    }
}
  1. Register the form handler plugin by adding CmsBlockProductConnectorUpdatePlugin to the CMS Block dependency provider Pyz\Zed\CmsBlock\CmsBlockDependencyProvider.
<?php
namespace Pyz\Zed\CmsBlock;

use Spryker\Zed\CmsBlockProductConnector\Communication\Plugin\CmsBlockProductConnectorUpdatePlugin;


class CmsBlockDependencyProvider extends CmsBlockCmsBlockDependencyProvider
{
    protected function getCmsBlockUpdatePlugins()
    {
        return array_merge(parent::getCmsBlockUpdatePlugins(), [
            new CmsBlockProductConnectorUpdatePlugin()
        ]);
    }
}
  1. Register the collector plugin by adding CmsBlockProductConnectorCollectorPlugin to the Collector dependency provider \Pyz\Zed\Collector\CollectorDependencyProvider.
<?php
namespace Pyz\Zed\Collector;

...

class CollectorDependencyProvider extends SprykerCollectorDependencyProvider
{
    public function provideBusinessLayerDependencies(Container $container)
    {
        ...
        $container[self::STORAGE_PLUGINS] = function (Container $container) {
            return [
                ...
                CmsBlockProductConnectorConstants::RESOURCE_TYPE_CMS_BLOCK_PRODUCT_CONNECTOR => new CmsBlockProductConnectorCollectorPlugin(),
            ];
        };
    }
}
  1. Register the product list plugin (optional). To show which product abstracts are assigned to a block on a block view page, add CmsBlockProductAbstractListViewPlugin to the CMS Block GUI dependency provider.
<?php
namespace Pyz\Zed\CmsBlockGui;

...

class CmsBlockGuiDependencyProvider extends CmsBlockGuiCmsBlockGuiDependencyProvider
{
    ...

    /**
    * @return array
    */
    protected function getCmsBlockViewPlugins()
    {
       return array_merge(parent::getCmsBlockViewPlugins(), [
           new CmsBlockProductAbstractListViewPlugin(),
       ]);
    }
}
  1. Register the block list to the product abstract view (optional). To show which blocks are assigned to a product abstract on a product abstract view page, add CmsBlockProductAbstractBlockListViewPlugin to the Product Management dependency provider.
<?php
namespace Pyz\Zed\ProductManagement;

...

class ProductManagementDependencyProvider extends SprykerProductManagementDependencyProvider
{
    protected function getProductAbstractViewPlugins()
    {
        return array_merge(parent::getProductAbstractViewPlugins(), [
            new CmsBlockProductAbstractBlockListViewPlugin()
        ]);
    }
}