Migration guide - CategoryGui
Edit on GitHubThis document describes how to upgrade the CategoryGui
module.
Upgrading from version 1.* to 2.*
In version 2.* of the CategoryGui
module, we:
- Increased the
Category
module version dependency. - Enabled the store assignment for
Category
to be changed in the Back Office.
Estimated migration time: 15 minutes.
Upgrade the CategoryGui
module from version 1.* to 2.*:
- To migrate the
Category
module to version 5.*, follow Upgrading from version 4.* to 5.*. - Update the
CategoryGui
module to version 2.0.0:
composer require spryker/category-gui:"^2.0.0" --update-with-dependencies
- Update the generated classes:
console transfer:generate
- Update navigation cache:
console navigation:build-cache
- From
Pyz\Zed\Category\CategoryDependencyProvider
, remove the following deprecated plugins:
CategoryImageFormPlugin
CategoryImageFormTabExpanderPlugin
ReadCmsBlockCategoryRelationsPlugin
ReadProductCategoryRelationPlugin
- To implement new plugins, update the related modules:
composer require spryker/category-image-gui:"^1.3.0" spryker/cms-block-category-connector:"^2.4.0" spryker/product-category:"^4.12.0" spryker/store-gui:"^1.1.0" --update-with-dependencies
- On the project level, register the new plugins:
\Pyz\Zed\CategoryGui\CategoryGuiDependencyProvider
<?php
namespace Pyz\Zed\CategoryGui;
use Spryker\Zed\CategoryGui\CategoryGuiDependencyProvider as SpykerCategoryGuiDependencyProvider;
use Spryker\Zed\CategoryImageGui\Communication\Plugin\CategoryGui\ImageSetCategoryFormTabExpanderPlugin;
use Spryker\Zed\CategoryImageGui\Communication\Plugin\CategoryGui\ImageSetSubformCategoryFormPlugin;
use Spryker\Zed\CmsBlockCategoryConnector\Communication\Plugin\CategoryGui\CmsBlockCategoryRelationReadPlugin;
use Spryker\Zed\CmsBlockCategoryConnector\Communication\Plugin\CategoryGui\CmsBlockSubformCategoryFormPlugin;
use Spryker\Zed\Kernel\Communication\Form\FormTypeInterface;
use Spryker\Zed\ProductCategory\Communication\Plugin\CategoryGui\ProductCategoryRelationReadPlugin;
use Spryker\Zed\StoreGui\Communication\Plugin\Form\StoreRelationDropdownFormTypePlugin;
/**
* @method \Spryker\Zed\CategoryGui\CategoryGuiConfig getConfig()
*/
class CategoryGuiDependencyProvider extends SpykerCategoryGuiDependencyProvider
{
/**
* @return \Spryker\Zed\Kernel\Communication\Form\FormTypeInterface
*/
protected function getStoreRelationFormTypePlugin(): FormTypeInterface
{
return new StoreRelationDropdownFormTypePlugin();
}
/**
* @return \Spryker\Zed\CategoryGuiExtension\Dependency\Plugin\CategoryFormTabExpanderPluginInterface[]
*/
protected function getCategoryFormTabExpanderPlugins(): array
{
return [
new ImageSetCategoryFormTabExpanderPlugin(),
];
}
/**
* @return \Spryker\Zed\CategoryGuiExtension\Dependency\Plugin\CategoryFormPluginInterface[]
*/
protected function getCategoryFormPlugins(): array
{
return [
new ImageSetSubformCategoryFormPlugin(),
new CmsBlockSubformCategoryFormPlugin(),
];
}
/**
* @return \Spryker\Zed\CategoryGuiExtension\Dependency\Plugin\CategoryRelationReadPluginInterface[]
*/
protected function getCategoryRelationReadPlugins(): array
{
return [
new ProductCategoryRelationReadPlugin(),
new CmsBlockCategoryRelationReadPlugin(),
];
}
}
Verification
Make sure that, in the Back Office:
- Category management is working correctly.
- You can change the store assignment of categories.
Thank you!
For submitting the form