1. Installation¶

1.1. Adding required bundles to the kernel¶

First, you need to enable the bundle inside the kernel.

If you’re not using any other Sylius bundles, you will also need to add SyliusResourceBundle and its dependencies to the kernel. Don’t worry, everything was automatically installed via Composer.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle($this),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new WhiteOctober\PagerfantaBundle\WhiteOctoberPagerfantaBundle(),

        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),
        new Sylius\Bundle\MoneyBundle\SyliusMoneyBundle(),
        new Sylius\Bundle\OrderBundle\SyliusOrderBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

1.2. Creating your entities¶

You have to create your own Order entity, living inside your application code. We think that keeping the app-specific bundle structure simple is a good practice, so let’s assume you have your AppBundle registered under App\Bundle\AppBundle namespace.

<?php

// src/App/AppBundle/Entity/Order.php
namespace App\AppBundle\Entity;

use Sylius\Component\Order\Model\Order as BaseOrder;

class Order extends BaseOrder
{
}

Now we need to define simple mapping for this entity, because it only extends the Doctrine mapped superclass. You should create a mapping file in your AppBundle, put it inside the doctrine mapping directory src/App/AppBundle/Resources/config/doctrine/Order.orm.xml.

<?xml version="1.0" encoding="UTF-8"?>

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                         xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
                                             http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">

    <entity name="App\AppBundle\Entity\Order" table="app_order">
        <id name="id" column="id" type="integer">
            <generator strategy="AUTO" />
        </id>
        <one-to-many field="items" target-entity="Sylius\Component\Order\Model\OrderItemInterface" mapped-by="order" orphan-removal="true">
            <cascade>
                <cascade-all/>
            </cascade>
        </one-to-many>

        <one-to-many field="adjustments" target-entity="Sylius\Component\Order\Model\AdjustmentInterface" mapped-by="order" orphan-removal="true">
            <cascade>
                <cascade-all/>
            </cascade>
        </one-to-many>
    </entity>

</doctrine-mapping>

Now let’s assume you have a Product entity, which represents your main merchandise in your webshop.

All you need to do is making your Product entity to implement ProductInterface and configure it inside Symfony settings.

<?php

// src/App/AppBundle/Entity/Product.php
namespace App\AppBundle\Entity;

use Sylius\Component\Product\Model\ProductInterface;

class Product implements ProductInterface
{
    // Your code...

    public function getName()
    {
        // Here you just have to return the nice display name of your merchandise.
        return $this->name;
    }
}

Now, you do not even have to map your Product model to the order items. It is all done automatically. And that would be all about entities.

1.3. Container configuration¶

Put this configuration inside your app/config/config.yml.

sylius_order:
    driver: doctrine/orm # Configure the doctrine orm driver used in documentation.
    classes:
        order:
            model: App\AppBundle\Entity\Order # The order entity.
        order_item:
            model: App\AppBundle\Entity\OrderItem # Your order item entity, if you need to override it

sylius_product:
    driver: doctrine/orm # Configure the doctrine orm driver used in documentation.
    classes:
        product:
            model: App\AppBundle\Entity\Product

1.4. Updating database schema¶

Remember to update your database schema.

For “doctrine/orm” driver run the following command.

$ php app/console doctrine:schema:update --force