Migration guide - CustomerPage

Last updated:
Edit on GitHub

Upgrading from version 1.* to version 2.0.0

In this new version of the CustomerPage module, we have added support of split delivery. You can find more details about the changes on the CustomerPage module release page.

This release is a part of the Split delivery concept migration. When you upgrade this module version, you should also update all other installed modules in your project to use the same concept as well as to avoid inconsistent behavior. For more information, see Split Delivery Migration Concept.

Estimated migration time: 10 min

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

  1. Upgrade the CustomerPage module to the new version:
composer require spryker-shop/customer-page: "^2.0.0" --update-with-dependencies
  1. Generate the transfer objects:
console transfer:generate
  1. Enable the following expander plugins:
PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
CompanyUnitAddressExpanderPlugin Expands address transfer with company unit address data. None \SprykerShop\Yves\CompanyPage\Plugin\CheckoutPage\CompanyUnitAddressExpanderPlugin
CustomerAddressExpanderPlugin Expands address transfer with customer address data. None \SprykerShop\Yves\CustomerPage\Plugin\CheckoutPage\CustomerAddressExpanderPlugin

src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php

<?php

namespace Pyz\Yves\CheckoutPage;

use SprykerShop\Yves\CustomerPage\Plugin\CheckoutPage\CustomerAddressExpanderPlugin;
use SprykerShop\Yves\CompanyPage\Plugin\CheckoutPage\CompanyUnitAddressExpanderPlugin;
use SprykerShop\Yves\CheckoutPage\CheckoutPageDependencyProvider as SprykerShopCheckoutPageDependencyProvider;

/**
* @method \Pyz\Yves\CheckoutPage\CheckoutPageConfig getConfig()
*/
class CheckoutPageDependencyProvider extends SprykerShopCheckoutPageDependencyProvider
{
	/**
	* @return \SprykerShop\Yves\CheckoutPageExtension\Dependency\Plugin\AddressTransferExpanderPluginInterface[]
	*/
	protected function getAddressStepExecutorAddressExpanderPlugins(): array
	{
		return [
			new CustomerAddressExpanderPlugin(),
			new CompanyUnitAddressExpanderPlugin(),
		];
	}

	/**
	* @param \Spryker\Yves\Kernel\Container $container
	*
	* @return \Spryker\Yves\StepEngine\Dependency\Form\StepEngineFormDataProviderInterface
	*/
	protected function getAddressStepFormDataProvider(Container $container): StepEngineFormDataProviderInterface
	{
		return new CheckoutAddressFormDataProvider(
			$this->getCustomerClient($container),
			$this->getStore(),
			$this->getCustomerService($container),
			$this->getShipmentClient($container)
		);
	}

	/**
	* @param \Spryker\Yves\Kernel\Container $container
	*
	* @return \SprykerShop\Yves\CheckoutPage\Dependency\Client\CheckoutPageToShipmentClientInterface
	*/
	public function getShipmentClient(Container $container): CheckoutPageToShipmentClientInterface
	{
		return $container->get(static::CLIENT_SHIPMENT);
	}
}