Skip to content

Latest commit

 

History

History
332 lines (231 loc) · 13.3 KB

UPGRADE.md

File metadata and controls

332 lines (231 loc) · 13.3 KB
Raw

UPGRADE

From 0.14.0 to 0.15.x

Multi Channel support

Sylius#2752

UserBundle

Sylius#2717

Database upgrade:

  • Call sylius:rbac:initialize to create new roles in your system
  • Execute migration script to migrate your data into the new model schema
    The migration script migrates only default data, if you have some customizations on any of affected entities you should take care of them yourself!

Codebase upgrade:

  • We no longer use FOSUserBundle
  • User provider has been changed https://github.com/Sylius/Sylius/pull/2717/files#diff-da1af97fca8a5fcb6fb7053584105ba7R6
  • Everything related to e-commerce (orders, addresses, groups and coupons) are now associated with Customer
  • Everything related to system account remains on User entity
  • Email no longer exist on Order
  • All order are associated with Customer (even guest orders - during guest checkout Customer is created based on email)
  • User must have associated Customer
  • Email no longer exist on User. It is on Customer now
  • In the checkout we depend on Customer not User
  • In templates in many places we use Customer instead of User entity now

API client

Sylius#2887

Codebase upgrade:

When you create server client in Sylius, it's public id was a combination of Client internal id and it's random id. E.g.

client_id: 1_mpO5ZJ35hx

now it is simply random id, so it will be changed to:

client_id: mpO5ZJ35hx

Remember to update your API clients using Sylius!

Related discussion FriendsOfSymfony/FOSOAuthServerBundle#328.

Translating country names using Symfony's Intl component

Removed CountryTranslation, using Intl Symfony component instead to provide translated country names based on ISO country code.

Database upgrade

  • Execute migration script to migrate your data into the new model schema

From 0.9.0 to 0.10.x

Version 0.10.x includes the new Sylius e-commerce components. All classes without Symfony dependency have been moved to separate Sylius\Component namespace.

VariableProductBundle has been merged into ProductBundle. Its functionality extracted into two separate bundles - SyliusAttributeBundle & SyliusVariationBundle.

Property model has been renamed to Attribute.

Before performing this procedure, please create a safe backup of your database. This upgrade changes significantly the way product attributes and options are stored in the database. We do provide a way to migrate your data, but no rollback will be possible in case of a problem.

In addition to the components split, we have switched to state-machine in order to deal with states, instead of hard-coded states. You can now configure all the states you want and the transitions between them. Please refer to state-machine.yml that you can find in the bundles using it. Most events have been replaced by state-machine events, much more powerful. Please update your listeners to make them callbacks of state-machine transitions. Again, please refer to the state-machine configuration files to do so.

The signature of PaymentInterface::setDetails method was changed. Now it allows either array or instance of \Traversable.

Addressing

Model classes and ZoneMatcher services have been moved to Sylius\Component\Addressing namespace.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\AddressingBundle\\Model/Sylius\\Component\\Addressing\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\AddressingBundle\\ZoneMatcher/Sylius\\Component\\Addressing\\ZoneMatcher/g' {} \;

Cart

Model classes and several services have been moved to Sylius\Component\Cart namespace.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\CartBundle\\Model/Sylius\\Component\\Cart\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\CartBundle\\Provider\\CartProviderInterface/Sylius\\Component\\Cart\\Provider\\CartProviderInterface/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\CartBundle\\Storage\\CartStorageInterface/Sylius\\Component\\Cart\\Storage\\CartStorageInterface/g' {} \;

Twig extension class name & service were changed:

  • SyliusCartExtension into CartExtension,
  • sylius.cart_twig into sylius.twig.extension.cart

Core

All Symfony independent code has been moved to Sylius\Component\Core namespace. Variant model has been renamed to ProductVariant and VariantImage to ProductVariantImage.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\CoreBundle\\Model\\Variant/Sylius\\Component\\Core\\Model\\ProductVariant/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\CoreBundle\\Model/Sylius\\Component\\Core\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\CoreBundle\\Calculator/Sylius\\Component\\Core\\Calculator/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\CoreBundle\\OrderProcessing/Sylius\\Component\\Core\\OrderProcessing/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\CoreBundle\\Promotion/Sylius\\Component\\Core\\Promotion/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\CoreBundle\\Uploader/Sylius\\Component\\Core\\Uploader/g' {} \;

Twig extension class name & service were changed:

  • SyliusMoneyExtension into SyliusMoneyExtension,
  • SyliusRestrictedZoneExtension into RestrictedZoneExtension,
  • sylius.twig.restricted_zone_extension into sylius.twig.extension.restricted_zone

Inventory

Model classes and all Symfony-agnostic services have been moved to Sylius\Component\Inventory namespace.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\InventoryBundle\\Model/Sylius\\Component\\Inventory\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\InventoryBundle\\Checker/Sylius\\Component\\Inventory\\Checker/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\InventoryBundle\\Factory/Sylius\\Component\\Inventory\\Factory/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\InventoryBundle\\Operator/Sylius\\Component\\Inventory\\Operator/g' {} \;

Twig extension class name & service were changed:

  • SyliusInventoryExtension into InventoryExtension,
  • sylius.inventory_twig into sylius.twig.extension.inventory

Money

Model classes and interfaces have been moved to Sylius\Component\Money namespace.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\MoneyBundle\\Model/Sylius\\Component\\Money\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\MoneyBundle\\Converter/Sylius\\Component\\Money\\Converter/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\MoneyBundle\\Context\\CurrencyContextInterface/Sylius\\Component\\Money\\Context\\CurrencyContextInterface/g' {} \;

Twig extension class name & service were changed:

  • SyliusMoneyExtension into MoneyExtension,
  • sylius.twig.money into sylius.twig.extension.money

Order

Model classes and repository interfaces have been moved to Sylius\Component\Order namespace.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\OrderBundle\\Model/Sylius\\Component\\Order\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\OrderBundle\\Generator/Sylius\\Component\\Order\\Generator/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\OrderBundle\\Repository/Sylius\\Component\\Order\\Repository/g' {} \;

Payment

PaymentsBundle has been renamed to PaymentBundle. Model classes interfaces have been moved to Sylius\Component\Order namespace.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\PaymentsBundle\\Model/Sylius\\Component\\Payment\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/PaymentsBundle/PaymentBundle/g' {} \;

Configuration root node has been adjusted as well.

Before:

sylius_payments:
    driver: doctrine/orm

After:

sylius_payment:
    driver: doctrine/orm

Product

Previously, ProductBundle provided basic product model with properties support. VariableProductBundle, with its options and variants support, has been merged into the basic bundle. From now on, Sylius product catalog ships with variations support by default.

The concept of properties has been renamed to attributes.

  • Property model becomes Attribute.
  • ProductProperty becomes AttributeValue.

Attributes can be attached to any object and can be configured under sylius_attribute node. The product bundle configures its attributes automatically.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\VariableProductBundle\\Model/Sylius\\Component\\Product\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/sylius.repository.option/sylius.repository.product_option/g' {} \;
$ find ./src -type f -exec sed -i 's/sylius.repository.option_value/sylius.repository.product_option_value/g' {} \;
$ find ./src -type f -exec sed -i 's/sylius.repository.product_property/sylius.repository.product_attribute_value/g' {} \;
$ find ./src -type f -exec sed -i 's/sylius.repository.property/sylius.repository.product_attribute/g' {} \;
$ find ./src -type f -exec sed -i 's/sylius.repository.prototype/sylius.repository.product_prototype/g' {} \;
$ find ./src -type f -exec sed -i 's/sylius.repository.variant/sylius.repository.product_variant/g' {} \;

Beware, the Doctrine relationship name has changed as well between Variant (now, ProductVariant) and Product. If you use it in custom repository methods, you need to adapt accordingly:

Before:

variant.product

After:

product_variant.object

Promotion

PromotionsBundle has been renamed to PromotionBundle. Model classes interfaces have been moved to Sylius\Component\Promotion namespace.

$ find ./src -type f -exec sed -i 's/PromotionsBundle/PromotionBundle/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\PromotionBundle\\Model/Sylius\\Component\\Promotion\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\PromotionBundle\\Action/Sylius\\Component\\Promotion\\Action/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\PromotionBundle\\Checker/Sylius\\Component\\Promotion\\Checker/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\PromotionBundle\\Generator/Sylius\\Component\\Promotion\\Generator/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\PromotionBundle\\Processor/Sylius\\Component\\Promotion\\Processor/g' {} \;

Configuration root node has been adjusted as well.

Before:

sylius_promotions:
    driver: doctrine/orm

After:

sylius_promotion:
    driver: doctrine/orm

Resource

ResourceBundle model interfaces have been moved to Sylius\Component\Resource namespace. RepositoryInterface has been moved to Repository namespace under the component.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\ResourceBundle\\Model/Sylius\\Component\\Resource\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Component\\Resource\\Model\\RepositoryInterface/Sylius\\Component\\Resource\\Repository\\RepositoryInterface/g' {} \;

Twig extension class name & service were changed:

  • SyliusResourceExtension into SyliusResourceExtension,
  • sylius.twig.resource into sylius.twig.extension.resource

Settings

Twig extension class name & service were changed:

  • SyliusSettingsExtension into SettingsExtension,
  • sylius.settings.twig into sylius.twig.extension.settings

Shipping

Model classes and Symfony agnostic services & interfaces have been moved to Sylius\Component\Shipping namespace.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\ShippingBundle\\Model/Sylius\\Component\\Shipping\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\ShippingBundle\\Calculator/Sylius\\Component\\Shipping\\Calculator/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\ShippingBundle\\Checker/Sylius\\Component\\Shipping\\Checker/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\ShippingBundle\\Resolver/Sylius\\Component\\Shipping\\Resolver/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\ShippingBundle\\Processor/Sylius\\Component\\Shipping\\Processor/g' {} \;

Taxation

Model classes and Symfony agnostic services have been moved to Sylius\Component\Taxation namespace.

$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\TaxationBundle\\Model/Sylius\\Component\\Taxation\\Model/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\TaxationBundle\\Calculator/Sylius\\Component\\Taxation\\Calculator/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\TaxationBundle\\Resolver/Sylius\\Component\\Taxation\\Resolver/g' {} \;

Taxonomy

TaxonomiesBundle has been renamed to TaxonomyBundle. Model classes interfaces have been moved to Sylius\Component\Taxonomy namespace.

$ find ./src -type f -exec sed -i 's/TaxonomiesBundle/TaxonomyBundle/g' {} \;
$ find ./src -type f -exec sed -i 's/Sylius\\Bundle\\TaxonomyBundle\\Model/Sylius\\Component\\Taxonomy\\Model/g' {} \;

Configuration root node has been adjusted as well.

Before:

sylius_taxonomies:
    driver: doctrine/orm

After:

sylius_taxonomy:
    driver: doctrine/orm

Web

Twig extension service name was changed:

  • sylius.twig.text_extension into sylius.twig.extension.text