Skip to main content
Version: 2024.4

Installation and First Configuration

This section describes the installation of the E-Commerce Framework and the first steps of configuration.

Installation​

Minimum Requirements​

  • Pimcore >= 11.0

Install​

Install bundle via composer:

composer require pimcore/ecommerce-framework-bundle

Enable bundle via console or extensions manager:

php bin/console pimcore:bundle:install PimcoreEcommerceFrameworkBundle

Check if the bundle has been installed:

php bin/console pimcore:bundle:list
+---------------------------------+---------+-----------+----+-----+-----+
| Bundle                          | Enabled | Installed | I? | UI? | UP? |
+---------------------------------+---------+-----------+----+-----+-----+
| PimcoreEcommerceFrameworkBundle  | ✔     | ✔        | ❌  | ✔ | ❌ |
+---------------------------------+---------+-----------+----+-----+-----+

The installer does following tasks:

  • Install several field collections.
  • Install several object classes.
  • Install several object bricks.
  • Create additional tables for carts, pricing rules, vouchers, etc.
  • Import translations for Pimcore Admin UI and Order Backend.
  • Add additional permissions.

If either classes, field collections, object bricks or tables already exist, the installation cannot be started.

After this installation routine, additional configurations have to be made - most important Product and ProductCategory. Please see Configuration for further information on available options.

Configure Product and Product Category Class​

The E-Commerce Framework installation does not create classes for products and product categories. That is because the framework does not limit you on specific classes or class structures. Literally every class can act as a product or product category class, and it is also possible to have several product classes (if necessary).

The only requirement is, that the classes have to be 'prepared' for being products or product categories.

Product​

There are two ways of preparing a Pimcore class for product-usage in the E-Commerce Framework

  1. The Pimcore class needs to extend the abstract class \Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractProduct

    • This is useful, when both product index and checkout functionality are based on the E-Commerce Framework.

  2. Make sure that the Pimcore class implements either \Pimcore\Bundle\EcommerceFrameworkBundle\Model\IndexableInterface or \Pimcore\Bundle\EcommerceFrameworkBundle\Model\CheckoutableInterface - or both, depending on the use case it is used for.
    • This is useful, when e.g. only checkout functionality is based on the E-Commerce Framework, but not the product presentation.
    • The interfaces define methods that are needed for the two use cases and need to be implemented.

For the abstract class use the parent class functionality of Pimcore. For implementing the interfaces use either the parent class functionality or the overriding models functionality of Pimcore (see also Overriding Models).

If using the abstract class, also have a look at its implementation. You might need to override a few methods that cannot be implemented by the abstract class and throw an exception depending on the use case you are using it.

Product Category​

When a product category class is used, this class needs to extend the abstract class \Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractCategory.

For product categories only one Pimcore class should be used. For products, several Pimcore classes can be used. Possibly the index update scripts need to be adapted.

Configuring Pimcore Ecommerce Framework​

The E-Commerce Framework is split up into multiple components which can be configured individually. For further reading please see:

Please see the following sections for a description of each component and a configuration reference describing the configuration entries relevant to the component:

For detailed information see comments within the configuration file. Depending on your use case, you might not need all components configured in the configuration file.

During development, you will return to the configuration and adjust the settings multiple times.