如何在现有的 Symfony2 应用程序中实施 Sylius OrderBundle

How to implement Sylius OrderBundle in an existing Symfony2 application

我需要在我的 symfony2 应用程序中实现 syliusOrderBundle,我已经从他们的官方网站上一遍又一遍地阅读文档 http://docs.sylius.org/en/latest/bundles/SyliusOrderBundle/installation.html 我已经安装并启用了以下包

      new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),
        new Sylius\Bundle\MoneyBundle\SyliusMoneyBundle(),
        new Sylius\Bundle\OrderBundle\SyliusOrderBundle(),
        new Sylius\Bundle\CartBundle\SyliusCartBundle(),
        new Sylius\Bundle\ProductBundle\SyliusProductBundle(),
        new Sylius\Bundle\ArchetypeBundle\SyliusArchetypeBundle(),
        new Sylius\Bundle\AttributeBundle\SyliusAttributeBundle(),
        new Sylius\Bundle\AssociationBundle\SyliusAssociationBundle(),
        new Sylius\Bundle\VariationBundle\SyliusVariationBundle(),

问题是出于安全原因我不太愿意安装不必要的包,而且 sylius 文档也没有帮助。我所需要的只是能够将产品添加到订单中,如果您之前使用过它,请帮忙。谢谢

首先,您只需要 sylius/order-bundle 版本 0.17(在撰写本文时)

$ composer require sylius/order-bundle "^0.17"

然后将必要的包添加到 app/AppKernel.php:

public function registerBundles()
{
    $bundles = [
        // Bundles you've already registered go here.

        // The following bundles are dependencies of Sylius ResourceBundle.
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle($this),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new WhiteOctober\PagerfantaBundle\WhiteOctoberPagerfantaBundle(),

        // The following Sylius bundles are dependencies of Sylius OrderBundle 
        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),
        new Sylius\Bundle\MoneyBundle\SyliusMoneyBundle(),
        new Sylius\Bundle\SequenceBundle\SyliusSequenceBundle(),

        new Sylius\Bundle\OrderBundle\SyliusOrderBundle(),

        // Doctrine bundle MUST be the last bundle registered.

        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    ];

    //....

    return $bundles;
}

现在要将 OrderBundle 与您自己的实体一起使用,您需要创建一个 OrderOrderItem 实体来扩展 Sylius 提供的实体.

对于 Order,我们将添加一个字段来捕获访问者的电子邮件地址。您可以捕获当前用户,或者您喜欢的任何内容来确定谁下了订单。

<?php

namespace AppBundle\Entity;

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

class Order extends SyliusOrder
{
    /**
     * @var string
     */
    private $email;

    /**
     * @return string
     */
    public function getEmail()
    {
        return $this->email;
    }

    /**
     * @param string $email
     */
    public function setEmail($email)
    {
        $this->email = $email;
    }
}

出于演示目的,我们假设访问者想要订购音乐曲目以供下载。

否则,这可以是任何东西。在 Sylius 应用程序中,它是一个产品。在某些应用程序中,它可能不是产品,而是订阅或服务等。

因此对于 OrderItem,我们将添加一个字段来捕获访问者将订购的下载。

<?php

namespace AppBundle\Entity;

use Sylius\Component\Order\Model\OrderItem as SyliusOrderItem;

class OrderItem extends SyliusOrderItem
{
    /**
     * @var Download
     */
    private $download;

    /**
     * @return Download
     */
    public function getDownload()
    {
        return $this->download;
    }

    /**
     * @param Download $download
     */
    public function setDownload(Download $download)
    {
        $this->download = $download;
    }
}

现在你有了你的实体,你可以添加 Doctrine 映射。在此示例中,我们使用 XML(丑陋,但它验证了配置)但它可以是 YAML 或注释。

src/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="AppBundle\Entity\Order" table="app_order">
    <field name="email" column="email" type="string" nullable="true" />

    <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>

src/AppBundle/Resources/config/doctrine/OrderItem.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="AppBundle\Entity\OrderItem" table="app_order_item">
        <many-to-one field="download" target-entity="AppBundle\Entity\Download">
            <join-column name="download_id" referenced-column-name="id" nullable="false" />
        </many-to-one>

    </entity>

</doctrine-mapping>

然后我们需要让 Sylius OrderBundle 知道我们的新实体,这样它就不会使用默认实体。

我们还想为我们的 Order 实体生成订单号,这是由 Sylius SequenceBundle 完成的。

app/config/config.yml中添加这个配置:

sylius_sequence:
    generators:
        AppBundle\Entity\Order: sylius.sequence.sequential_number_generator

sylius_order:
    resources:
        order:
            classes:
                model: AppBundle\Entity\Order
        order_item:
            classes:
                model: AppBundle\Entity\OrderItem

然后更新您的数据库模式:

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

现在,为了在持久化新实体时实际生成订单号并将其分配给 Order,我们需要注册一个侦听器。

app/config/services.yml 或您的包的 Resources/config/services.yml 中,添加此配置:

parameters:
  sylius.model.sequence.class: Sylius\Component\Sequence\Model\Sequence

services:
  app.order_number_listener:
    class: Sylius\Bundle\OrderBundle\EventListener\OrderNumberListener
    arguments:
      - "@sylius.sequence.doctrine_number_listener"
    tags:
      - { name: kernel.event_listener, event: app.download_ordered, method: generateOrderNumber }

事件的名称app.download_ordered在这里很重要,您可以随意命名,但必须在创建新订单时发送。

这是一个创建新订单的示例,我们在其中发送 app.download_ordered 事件。

    use AppBundle\Entity\Download;
    use AppBundle\Entity\OrderItem;
    use AppBundle\Form\OrderType;
    use Sensio\Bundle\FrameworkExtraBundle\Configuration as Framework;
    use AppBundle\Entity\Order;
    use Symfony\Bundle\FrameworkBundle\Controller\Controller;
    use Symfony\Component\EventDispatcher\GenericEvent;
    use Symfony\Component\HttpFoundation\Request;

    const STATE_BEGIN    = 'begin';
    const STATE_COMPLETE = 'complete';

    /**
     * @Framework\Route("/begin-order-for-download/{id}", name="begin_order_for_download")
     */
    public function beginOrderForDownloadAction(Request $request, $id)
    {
        $download = $this->getDoctrine()->getRepository(Download::class)->findOneBy(['id' => $id]);

        $order = new Order();
        $form = $this->createForm(new OrderType(), $order);

        if ('POST' === $request->getMethod()) {
            $order->setState(self::STATE_BEGIN);

            $orderItem = new OrderItem();
            $orderItem->setDownload($download);
            $orderItem->setOrder($order);
            $orderItem->setUnitPrice(59);
            // $orderItem->setImmutable(true); // Need to verify how this affects behavior.

            $this->get('event_dispatcher')->dispatch('app.download_ordered', new GenericEvent($order));

            $form->handleRequest($request);

            $em = $this->getDoctrine()->getManager();

            if ($form->isValid()) {
                $order->setState(self::STATE_COMPLETE);
                $this->addFlash('order.state', self::STATE_COMPLETE);

                $em->persist($order);
                $em->flush();

                return $this->redirectToRoute('complete_order', [
                    'id' => $order->getId(),
                ]);
            }
        }

        return $this->render('AppBundle::begin_order_for_download.html.twig', [
            'form'     => $form->createView(),
            'download' => $download,
        ]);
    }

OrderType 表单如下所示,为了演示目的保持简单。根据您的需要进行编辑。

    <?php

    namespace AppBundle\Form;

    use Symfony\Component\Form\AbstractType;
    use Symfony\Component\Form\FormBuilderInterface;

    class OrderType extends AbstractType
    {
        /**
         * {@inheritdoc}
         */
        public function getName()
        {
            return 'order';
        }

        /**
         * {@inheritdoc}
         */
        public function buildForm(FormBuilderInterface $builder, array $options)
        {
            $builder->add('email', 'repeated', [
                'type'            => 'email',
                'first_options'   => ['label' => 'Email'],
                'second_options'  => ['label' => 'Repeat Email'],
                'invalid_message' => 'The email fields must match.',
            ]);
            $builder->add('proceed', 'submit', ['attr' => ['class' => 'button']]);
        }
    }

如果表单有效,我们的订单将被持久化,监听器会为其分配一个订单号,然后我们将重定向 complete_order 路由。在这里,您需要提供付款详情,或者在本例中,提供 link 来下载歌曲。

就是这样。您可以在 https://github.com/adamelso/orda

查看完整工作示例的代码