Install the Prices feature + Dynamic Multistore

Last updated:
Edit on GitHub

Dynamic Multistore is currently running under an Early Access Release. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features.

This document describes how to install Dynamic Multistore + the Prices feature.

Install feature core

Prerequisites

Install the required features:

NAME VERSION
Spryker Core 202311.0
Prices 202311.0

1) Set up configuration

stores.php configuration

Since Dynamic Multistore is now enabled, configuration of stores is stored in the database, making config/Shared/stores.php deprecated.

The default store configuration is imported using new data import modules, like CurrencyDataImport. These modules populate the store configuration in the database. The Currency module is responsible for extending store data and configuring it in the database. For upgrade instructions, see Upgrade the Currency module.

2) Set up the database schema and transfer objects

  1. Adjust the schema definition, so entity changes trigger events:

src/Pyz/Zed/Currency/Persistence/Propel/Schema/spy_currency.schema.xml


<?xml version="1.0"?>
<database xmlns="spryker:schema-01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="zed"
          xsi:schemaLocation="spryker:schema-01 https://static.spryker.com/schema-01.xsd"
          namespace="Orm\Zed\Currency\Persistence" package="src.Orm.Zed.Currency.Persistence">

    <table name="spy_currency_store" idMethod="native">
        <behavior name="event">
            <parameter name="spy_currency_store_all" column="*"/>
        </behavior>
    </table>

</database>
  1. Apply database changes and generate entity and transfer changes:
console propel:install
console transfer:generate
Verification

Make sure that the following changes have been applied in the database:

DATABASE ENTITY TYPE EVENT
spy_store.fk_currency column added
spy_currency_store table added
Verification

Make sure the following changes have been applied in transfer objects:

TRANSFER TYPE EVENT PATH
CurrencyCriteria class created src/Generated/Shared/Transfer/CurrencyCriteriaTransfer
Store.defaultCurrencyIsoCode property added src/Generated/Shared/Transfer/CustomerTransfer
Verification

Make sure you can add a currency to a store when editing a product in the Back Office.

3) Configure export to Redis

  1. Set up publisher plugins:
PLUGIN SPECIFICATION PRERQUISITES NAMESPACE
CurrencyStoreWritePublisherPlugin Publishes store’s currencies to the storage table. None Spryker\Zed\StoreStorage\Communication\Plugin\Publisher\CurrencyStore

src/Pyz/Zed/Publisher/PublisherDependencyProvider.php

<?php

namespace Pyz\Zed\Publisher;

use Spryker\Zed\Publisher\PublisherDependencyProvider as SprykerPublisherDependencyProvider;
use Spryker\Zed\StoreStorage\Communication\Plugin\Publisher\CurrencyStore\CurrencyStoreWritePublisherPlugin;

class PublisherDependencyProvider extends SprykerPublisherDependencyProvider
{
    protected function getPublisherPlugins(): array
    {
        return array_merge(
            // ...
            $this->getStoreStoragePlugins(),
        );
    }

    /**
     * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface>
     */
    protected function getStoreStoragePlugins(): array
    {
        return [
            ...
            new CurrencyStoreWritePublisherPlugin(),
            ...
        ];
    }
}
Verification

Using the following data, make sure that when you add, update, or delete a store currency, it is exported to or removed from Storage.

Storage type: Redis Target entity: Store

Example expected data identifier: kv:store:de

Example expected data fragment:

{
  "id_store": 1,
  "name": "DE",
  ...
  "default_currency_iso_code": "EUR",
  "available_currency_iso_codes": [
    "CHF",
    "EUR"
  ],
  ...
}

4) Import data

Import locale, store, and country data:

  1. Prepare your data according to your requirements using the demo data:

Example for the DE store currency-store configurations: data/import/common/DE/currency_store.csv

>currency_code,store_name,is_default
EUR,DE,1
CHF,DE,0
Column REQUIRED Data Type Data Example Data Explanation
currency_code ✓ string EUR Define currency code.
store_name mandatory string DE Defines the store name.
is_default mandatory bool 1 Defines if the currency is default.
Default currency

There can only be one default currency per store.

“Import
  • The .csv files must have an empty line in the end.
  • For each currency_code entry in the CSV files, there must be a respective code entry in the spy_currency database table.
  1. Update the following import action files with the following action:
    • data/import/common/commerce_setup_import_config_{REGION\_STORE}.yml
    • data/import/local/full\_{REGION\_STORE}.yml
    • data/import/production/full\_{SPRYKER\_STORE}.yml
data_import:
    - data_entity: currency-store
      source: data/import/common/{REGION}/currency_store.csv
  1. To enable data import, register the following plugin:
PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
CurrencyStoreDataImportPlugin Imports currency-store relations. None \Spryker\Zed\CurrencyDataImport\Communication\Plugin\DataImport

src/Pyz/Zed/DataImport/DataImportDependencyProvider.php

namespace Pyz\Zed\DataImport;

use Spryker\Zed\DataImport\DataImportDependencyProvider as SprykerDataImportDependencyProvider;
use Spryker\Zed\CurrencyDataImport\Communication\Plugin\DataImport\CurrencyStoreDataImportPlugin;

class DataImportDependencyProvider extends SprykerDataImportDependencyProvider
{
    protected function getDataImporterPlugins(): array
    {
        return [
            ...
            new CurrencyStoreDataImportPlugin(),
            ...
        ];     
    }
}
  1. Enable behaviors by registering the console commands:

src/Pyz/Zed/Console/ConsoleDependencyProvider.php

<?php
namespace Pyz\Zed\Console;

use Spryker\Zed\Console\ConsoleDependencyProvider as SprykerConsoleDependencyProvider;
use Spryker\Zed\DataImport\Communication\Console\DataImportConsole;
use Spryker\Zed\CurrencyDataImport\CurrencyDataImportConfig;
use Spryker\Zed\Kernel\Container;

/**
 * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
 * @method \Pyz\Zed\Console\ConsoleConfig getConfig()
 */
class ConsoleDependencyProvider extends SprykerConsoleDependencyProvider
{
    /**
     * @var string
     */
    protected const COMMAND_SEPARATOR = ':';

    /**
     * @param \Spryker\Zed\Kernel\Container $container
     *
     * @return array<\Symfony\Component\Console\Command\Command>
     */
    protected function getConsoleCommands(Container $container): array
    {
        return [
            ...
            new DataImportConsole(DataImportConsole::DEFAULT_NAME . static::COMMAND_SEPARATOR . CurrencyDataImportConfig::IMPORT_TYPE_CURRENCY_STORE),
            ...
        ];
    }

}
  1. Import data:
vendor/bin/console data:import:currency-store
Verification

Make sure that the currency store data has been added to the spy_currency_store table.

5) Set up behavior

Register the following plugins:

PLUGIN SPECIFICATION NAMESPACE
CurrencyBackendGatewayApplicationPlugin Provides a currency service for the gateway request by getting it from the meta data. Spryker\Zed\Currency\Communication\Plugin\Application
DefaultCurrencyStorePreCreateValidationPlugin Validates default currency before store is created. Spryker\Zed\Currency\Communication\Plugin\Store
DefaultCurrencyStorePreUpdateValidationPlugin Validates default currency before store is updated. Spryker\Zed\Currency\Communication\Plugin\Store
CurrencyStorePostUpdatePlugin Update currency store data after store is updated. Spryker\Zed\Currency\Communication\Plugin\Store
CurrencyStoreCollectionExpanderPlugin Expands currency store collection. Spryker\Zed\Currency\Communication\Plugin\Store
CurrencyStoreFormExpanderPlugin Adds currency selection fields to the Store form. Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui
CurrencyStoreFormViewExpanderPlugin Adds rendered currency tabs and tables as variables in template. Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui
CurrencyStoreFormTabExpanderPlugin Expands Store form with Currencies tab. Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui
AssignedCurrenciesStoreViewExpanderPlugin Returns table with assigned currencies. Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui
CurrencyStoreTableExpanderPlugin Expands table data rows of store table with currency codes. Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui

src/Pyz/Zed/Application/ApplicationDependencyProvider.php

<?php

namespace Pyz\Zed\Application;

use Spryker\Zed\Application\ApplicationDependencyProvider as SprykerApplicationDependencyProvider;
use Spryker\Zed\Currency\Communication\Plugin\Application\CurrencyBackendGatewayApplicationPlugin;


class ApplicationDependencyProvider extends SprykerApplicationDependencyProvider
{
    /**
     * @return array<\Spryker\Shared\ApplicationExtension\Dependency\Plugin\ApplicationPluginInterface>
     */
    protected function getBackendGatewayApplicationPlugins(): array
    {
        return [
            ...
            new CurrencyBackendGatewayApplicationPlugin(),
            ...
        ];
    }
}
Verification

Make sure the service container has the currency service.

src/Pyz/Zed/Store/StoreDependencyProvider.php

<?php

namespace Pyz\Zed\Store;

use Spryker\Zed\Currency\Communication\Plugin\Store\CurrencyStoreCollectionExpanderPlugin;
use Spryker\Zed\Currency\Communication\Plugin\Store\CurrencyStorePostCreatePlugin;
use Spryker\Zed\Currency\Communication\Plugin\Store\CurrencyStorePostUpdatePlugin;
use Spryker\Zed\Currency\Communication\Plugin\Store\DefaultCurrencyStorePreCreateValidationPlugin;
use Spryker\Zed\Currency\Communication\Plugin\Store\DefaultCurrencyStorePreUpdateValidationPlugin;
use Spryker\Zed\Store\StoreDependencyProvider as SprykerStoreDependencyProvider;

class StoreDependencyProvider extends SprykerStoreDependencyProvider
{
    /**
     * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePreCreateValidationPluginInterface>
     */
    protected function getStorePreCreateValidationPlugins(): array
    {
        return [
            ...
            new DefaultCurrencyStorePreCreateValidationPlugin(),
            ...
        ];
    }

    /**
     * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePreUpdateValidationPluginInterface>
     */
    protected function getStorePreUpdateValidationPlugins(): array
    {
        return [
            ...
            new DefaultCurrencyStorePreUpdateValidationPlugin(),
            ...
        ];
    }

    /**
     * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePostCreatePluginInterface>
     */
    protected function getStorePostCreatePlugins(): array
    {
        return [
            ...
            new CurrencyStorePostCreatePlugin(),
            ...
        ];
    }

    /**
     * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePostUpdatePluginInterface>
     */
    protected function getStorePostUpdatePlugins(): array
    {
        return [
            ...
            new CurrencyStorePostUpdatePlugin(),
            ...
        ];
    }

    /**
     * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StoreCollectionExpanderPluginInterface>
     */
    protected function getStoreCollectionExpanderPlugins(): array
    {
        return [
            ...
            new CurrencyStoreCollectionExpanderPlugin(),
            ...
        ];
    }
}
Verification
  • Create or update a store with a default currency that is not assigned to the store. This should give you an error message.
  • Create or update a store. This should update the spy_currency_store database table with the default currency. Also, this should expand store transfers with currency codes.

src/Pyz/Zed/StoreGui/StoreGuiDependencyProvider.php

<?php

namespace Pyz\Zed\StoreGui;

use Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui\AssignedCurrenciesStoreViewExpanderPlugin;
use Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui\CurrencyStoreFormExpanderPlugin;
use Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui\CurrencyStoreFormTabExpanderPlugin;
use Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui\CurrencyStoreFormViewExpanderPlugin;
use Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui\CurrencyStoreTableExpanderPlugin;
use Spryker\Zed\StoreGui\StoreGuiDependencyProvider as SprykerStoreGuiDependencyProvider;

class StoreGuiDependencyProvider extends SprykerStoreGuiDependencyProvider
{
    /**
     * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreFormExpanderPluginInterface>
     */
    protected function getStoreFormExpanderPlugins(): array
    {
        return [
            ...
            new CurrencyStoreFormExpanderPlugin(),
            ...
        ];
    }

    /**
     * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreFormViewExpanderPluginInterface>
     */
    protected function getStoreFormViewExpanderPlugins(): array
    {
        return [
            ...
            new CurrencyStoreFormViewExpanderPlugin(),
            ...
        ];
    }

    /**
     * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreFormTabExpanderPluginInterface>
     */
    protected function getStoreFormTabsExpanderPlugins(): array
    {
        return [
            ...
            new CurrencyStoreFormTabExpanderPlugin(),
            ...
        ];
    }

    /**
     * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreViewExpanderPluginInterface>
     */
    protected function getStoreViewExpanderPlugins(): array
    {
        return [
            ...
            new AssignedCurrenciesStoreViewExpanderPlugin(),
            ...

        ];
    }

    /**
     * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreTableExpanderPluginInterface>
     */
    protected function getStoreTableExpanderPlugins(): array
    {
        return [
            ...
            new CurrencyStoreTableExpanderPlugin(),
            ...
        ];
    }
}
Verification

Steps:

  • Make sure that you can see the currency selection fields on the Store form.
  • Make sure that you can see the currency tabs and tables on the Store form.
  • Make sure that you can see the Currencies tab on the Store form.
  • Make sure that you can see the table with assigned currencies on the Store form.