Install the Category Management + CMS feature
Edit on GitHubThis document describes how to install the CMS + Category Management feature.
Prerequisites
Install the required features:
NAME | VERSION | CMS |
---|---|---|
Category Management | 202307.0 | 202307.0 |
1) Install the required modules
Install the required modules using Composer:
composer require spryker/cms-slot-block-category-connector:"^1.0.0" spryker/cms-slot-block-category-gui:"^1.0.0" --update-with-dependencies
Make sure that the following modules have been installed:
MODULE | EXPECTED DIRECTORY |
---|---|
CmsSlotBlock | vendor/spryker/cms-slot-block |
CmsSlotBlockCategoryConnector | vendor/spryker/cms-slot-block-category-connector |
CmsSlotBlockCategoryGui | vendor/spryker/cms-slot-block-category-gui |
2) Set up configuration
- Add a CMS slot template to the condition key relation:
Pyz\Zed\CmsSlotBlock\CmsSlotBlockConfig
<?php
namespace Pyz\Zed\CmsSlotBlock;
use Spryker\Shared\CmsSlotBlockCategoryConnector\CmsSlotBlockCategoryConnectorConfig;
use Spryker\Zed\CmsSlotBlock\CmsSlotBlockConfig as SprykerCmsSlotBlockConfig;
class CmsSlotBlockConfig extends SprykerCmsSlotBlockConfig
{
/**
* @return string[][]
*/
public function getTemplateConditionsAssignment(): array
{
return [
'@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig' => [
CmsSlotBlockCategoryConnectorConfig::CONDITION_KEY,
],
];
}
}
- Expand the category template list in the project-level configuration:
\Pyz\Zed\Category\CategoryConfig
<?php
namespace Pyz\Zed\Category;
use Spryker\Zed\Category\CategoryConfig as CategoryCategoryConfig;
use Spryker\Zed\CmsBlockCategoryConnector\CmsBlockCategoryConnectorConfig;
class CategoryConfig extends CategoryCategoryConfig
{
/**
* @return string[]
*/
public function getTemplateList()
{
$templateList = [
CmsBlockCategoryConnectorConfig::CATEGORY_TEMPLATE_ONLY_CMS_BLOCK => '@CatalogPage/views/simple-cms-block/simple-cms-block.twig',
CmsBlockCategoryConnectorConfig::CATEGORY_TEMPLATE_WITH_CMS_BLOCK => '@CatalogPage/views/catalog-with-cms-block/catalog-with-cms-block.twig',
];
$templateList += parent::getTemplateList();
return $templateList;
}
}
3) Set up behavior
1. Prepare the Zed UI form plugins:
PLUGIN | SPECIFICATION | NAMESPACE |
---|---|---|
CategorySlotBlockConditionFormPlugin | Extends the CMS slot block form with a category condition form. | Spryker\Zed\CmsSlotBlockCategoryGui\Communication\Plugin |
Pyz\Zed\CmsSlotBlockGui\CmsSlotBlockGuiDependencyProvider
<?php
namespace Pyz\Zed\CmsSlotBlockGui;
use Spryker\Zed\CmsSlotBlockGui\CmsSlotBlockGuiDependencyProvider as SprykerCmsSlotBlockGuiDependencyProvider;
use Spryker\Zed\CmsSlotBlockCategoryGui\Communication\Plugin\CategorySlotBlockConditionFormPlugin;
class CmsSlotBlockGuiDependencyProvider extends SprykerCmsSlotBlockGuiDependencyProvider
{
/**
* @return \Spryker\Zed\CmsSlotBlockGuiExtension\Communication\Plugin\CmsSlotBlockGuiConditionFormPluginInterface[]
*/
protected function getCmsSlotBlockFormPlugins(): array
{
return [
new CategorySlotBlockConditionFormPlugin(),
];
}
}
1. In the Back Office, go to Content > Slots.
-
In the List of Templates pane, select the template you’ve configured in 2) Set up configuration.
-
Make sure that you can see a List of Blocks for “{selected slot name}” Slot pane.
- Add the visibility resolver plugin to the
CmsSlotBlock
client:
PLUGIN | SPECIFICATION | NAMESPACE |
---|---|---|
CategoryCmsSlotBlockConditionResolverPlugin | Provides a visibility resolver for the CmsSlotBlock client. |
Spryker\Client\CmsSlotBlockCategoryConnector\Plugin\CmsSlotBlock |
Pyz\Zed\CmsSlotBlockGui\CmsSlotBlockGuiDependencyProvider
<?php
namespace Pyz\Zed\CmsSlotBlockGui;
use Spryker\Zed\CmsSlotBlockGui\CmsSlotBlockGuiDependencyProvider as SprykerCmsSlotBlockGuiDependencyProvider;
use Spryker\Zed\CmsSlotBlockCategoryGui\Communication\Plugin\CategorySlotBlockConditionFormPlugin;
class CmsSlotBlockGuiDependencyProvider extends SprykerCmsSlotBlockGuiDependencyProvider
{
/**
* @return \Spryker\Zed\CmsSlotBlockGuiExtension\Communication\Plugin\CmsSlotBlockGuiConditionFormPluginInterface[]
*/
protected function getCmsSlotBlockFormPlugins(): array
{
return [
new CategorySlotBlockConditionFormPlugin(),
];
}
}
Make sure that you can add visibility conditions to a CMS block and display it on the Storefront.
Thank you!
For submitting the form