Configuration

Controllers

The plugin provides controllers for cart, orders, and address operations. Choose one of the options below.

Option A: Use Plugin Controllers

If you haven't customized these controllers in your project, use them directly.

Add to config/packages/_sylius.yaml:

sylius_order:
    resources:
        order:
            classes:
                controller: Sylius\LegacyShopBridgePlugin\Controller\OrderController
        order_item:
            classes:
                controller: Sylius\LegacyShopBridgePlugin\Controller\OrderItemController

sylius_addressing:
    resources:
        province:
            classes:
                controller: Sylius\LegacyShopBridgePlugin\Controller\ProvinceController

Option B: Use Traits

If you have existing custom controllers, add traits to them:

// src/Controller/OrderController.php
namespace App\Controller;

use Sylius\Bundle\CoreBundle\Controller\OrderController as BaseOrderController;
use Sylius\LegacyShopBridgePlugin\Controller\Trait\OrderTrait;

class OrderController extends BaseOrderController
{
    use OrderTrait;
}

// src/Controller/OrderItemController.php
namespace App\Controller;

use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
use Sylius\LegacyShopBridgePlugin\Controller\Trait\OrderItemTrait;

class OrderItemController extends ResourceController
{
    use OrderItemTrait;
}

// src/Controller/ProvinceController.php
namespace App\Controller;

use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
use Sylius\LegacyShopBridgePlugin\Controller\Trait\ProvinceTrait;

class ProvinceController extends ResourceController
{
    use ProvinceTrait;
}

Twig Paths

Add to config/packages/twig.yaml:

twig:
    paths:
        # Your custom templates (if any) - higher priority
        '%kernel.project_dir%/templates/bundles/SyliusShopBundle': 'SyliusShop'
        '%kernel.project_dir%/templates/bundles/SyliusUiBundle': 'SyliusUi'

        # Plugin templates - must be last
        '%kernel.project_dir%/vendor/sylius/legacy-shop-bridge-plugin/templates/bundles/SyliusShopBundle': 'SyliusShop'
        '%kernel.project_dir%/vendor/sylius/legacy-shop-bridge-plugin/templates/bundles/SyliusUiBundle': 'SyliusUi'

Note: The first lines are only needed if you have customized SyliusShopBundle or SyliusUiBundle templates in your templates/bundles/ directory. The last two lines pointing to the plugin's templates are always required and have to be placed at the end.

FOSRestBundle

If not already configured, create config/packages/fos_rest.yaml:

fos_rest:
    exception: true
    view:
        formats:
            json: true
            xml: true
        empty_content: 204
    format_listener:
        rules:
            - { path: '^/api/.*', priorities: ['json', 'xml'], fallback_format: json, prefer_extension: true }
            - { path: '^/', stop: true }

Webpack Encore

Add to webpack.config.js:

const path = require('path');

// ... your existing configurations ...

// Legacy Shop Configuration
Encore.reset();

Encore
    .setOutputPath('public/build/legacy/shop')
    .setPublicPath('/build/legacy/shop')
    .addEntry('legacy-shop-entry', path.resolve(__dirname, './vendor/sylius/legacy-shop-bridge-plugin/assets/shop/entrypoint.js'))
    .addAliases({
        'semantic-ui-css': path.resolve(__dirname, 'node_modules/semantic-ui-css'),
        'jquery': path.resolve(__dirname, 'node_modules/jquery'),
        'lightbox2': path.resolve(__dirname, 'node_modules/lightbox2'),
        'slick-carousel': path.resolve(__dirname, 'node_modules/slick-carousel'),
    })
    .disableSingleRuntimeChunk()
    .cleanupOutputBeforeBuild()
    .enableSourceMaps(!Encore.isProduction())
    .enableVersioning(Encore.isProduction())
    .enableSassLoader()
;

const legacyShopConfig = Encore.getWebpackConfig();
legacyShopConfig.externals = { window: 'window', document: 'document' };
legacyShopConfig.name = 'legacy.shop';

module.exports = [
    // ... your existing configs
    legacyShopConfig,
];

Build assets:

npm run build
# or
yarn build

Template Updates

Encore Entry Points

Update your shop layout template:

{# Before #}
{{ encore_entry_link_tags('shop-entry', null, 'shop') }}
{{ encore_entry_script_tags('shop-entry', null, 'shop') }}

{# After #}
{{ encore_entry_link_tags('legacy-shop-entry', null, 'legacy.shop') }}
{{ encore_entry_script_tags('legacy-shop-entry', null, 'legacy.shop') }}

Asset Paths

Update asset references:

{# Before #}
{{ asset('build/shop/images/logo.png', 'shop') }}

{# After #}
{{ asset('build/legacy/shop/images/logo.png', 'legacy.shop') }}

Regex for bulk replacement:

Find:

(\{\{\s*asset\(\s*['"])build/shop/([^'"]+)(['"]\s*,\s*['"])shop(['"]\s*\)\s*\}\})

Replace:

$1build/legacy/shop/$2$3legacy.shop$4

Note: These regexes work within PHPStorm: Cmd+Shift+R (Find and Replace in Files), enable Regex, paste both patterns.

Menu Names

{# Before #}
{{ knp_menu_render('sylius.shop.account', ...) }}

{# After #}
{{ knp_menu_render('sylius_shop.account', ...) }}

Twig Functions

Before (Sylius 1.x)	After
sylius_order_items_subtotal(order)	order.getItemsSubtotal()
sylius_order_tax_included(order)	order.getTaxIncludedTotal()
sylius_order_tax_excluded(order)	order.getTaxExcludedTotal()
sylius_product_variant_prices(product, channel)	sylius_product_variants_map(product, {'channel': channel})

UI Events Migration

If you have custom sylius_ui events configuration, rename the root key:

# Before
sylius_ui:
    events:
        # ...

# After
sylius_legacy_shop_bridge:
    events:
        # ...