Upgrade the ContentBanner module

Last updated:
Edit on GitHub

Upgrading from version 1.* to version 2.*

Version 2.0.0 of the ContentGui module introduces the Content Items functionality that allows creating and managing content and later selecting where it should be inserted.

With the ContentBanner version 2.0, the following changes have been made:

  • Removed the deprecated ContentBannerTransfer definition.
  • Removed deprecated ContentBannerClient::execute().
  • Removed ContentBannerClient::executeBannerTypeById().
  • Introduced ContentProductClient::executeBannerTypeByKey() to find content with a type banner by content key.
  • Introduced the ContentTypeContextTransfer::$key transfer object property.
  • Removed URL validation for clickUrl and imageUrl ContentBannerFacade::validateContentBannerTerm().
  • Increased the version of spryker/content-storage in composer.json.

You can find more details about the changes on the ContentBanner module release notes page.

Estimated migration time: 30minutes-1h

To upgrade to the new version of the module, do the following:

  1. Perform the steps provided in Upgrade the ContentStorage module.

  2. Upgrade the ContentBanner module to version 2.0.0:

composer require spryker/content-banner:"^2.0.0" --update-with-dependencies
  1. Run the following command to re-generate transfer objects:
console transfer:generate

  1. Remove any usage of \Spryker\Client\ContentBanner\Plugin\ContentStorage\BannerTermExecutorPlugin.

  2. The ContentBannerClient::execute() method has been removed, the replacement is ContentBannerClient::executeBannerTypeByKey().