"subform" 中的 Symfony2 更新项目

Question

我的问题的简短版本：

如何在 Symfony2 中编辑子表单的实体？

=-=-=-=-=-=-= 又长又详细的版本=-=-=-=-=-=-=-=

我有实体订单

<?php

class Order
{
    /**
     * @var integer
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @ORM\ManyToOne(targetEntity="Customer")
     * @ORM\JoinColumn(name="customer_id", referencedColumnName="id", nullable=false)
     **/
    private $customer;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="date", type="date")
     */
    private $date;

    /**
     * @ORM\ManyToOne(targetEntity="\AppBundle\Entity\OrderStatus")
     * @ORM\JoinColumn(name="order_status_id", referencedColumnName="id", nullable=false)
     **/
    private $orderStatus;

    /**
     * @var string
     *
     * @ORM\Column(name="reference", type="string", length=64)
     */
    private $reference;

    /**
     * @var string
     *
     * @ORM\Column(name="comments", type="text")
     */
    private $comments;

    /**
     * @var array
     *
     * @ORM\OneToMany(targetEntity="OrderRow", mappedBy="Order", cascade={"persist"})
     */
    private $orderRows;

    ...
}

MySQL

_____________________________________________________________
|id                           | order id                    |
|customer_id                  | fk customer.id NOT NULL     |
|date                         | order date                  |
|order_status_id              | fk order_status.id NOT NULL |
|reference                    | varchar order reference     |
|comments                     | text comments               |
|___________________________________________________________|

还有一个实体OrderRow（一个订单可以有一行或多行）

<?php

class OrderRow
{
    /**
     * @var integer
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @ORM\ManyToOne(targetEntity="Order", inversedBy="orderRows", cascade={"persist"})
     * @ORM\JoinColumn(name="order_id, referencedColumnName="id", nullable=false)
     **/
    private $order;

    /**
     * @ORM\ManyToOne(targetEntity="[MyShop\Bundle\ProductBundle\Entity\Product")
     * @ORM\JoinColumn(name="product_id", referencedColumnName="id", nullable=true)
     **/
    private $product;

    /**
     * @var string
     *
     * @ORM\Column(name="description", type="string", length=255)
     */
    private $description;

    /**
     * @var integer
     *
     * @ORM\Column(name="count", type="integer")
     */
    private $count = 1;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="date", type="date")
     */
    private $date;

    /**
     * @var decimal
     *
     * @ORM\Column(name="amount", type="decimal", precision=5, scale=2)
     */
    private $amount;

    /**
     * @var string
     *
     * @ORM\Column(name="tax_amount", type="decimal", precision=5, scale=2)
     */
    private $taxAmount;

    /**
     * @var string
     *
     * @ORM\Column(name="discount_amount", type="decimal", precision=5, scale=2)
     */
    private $discountAmount;

    ...
}

MySQL

_____________________________________________________________
|id                           | order id                    |
|order_id                     | fk order.id NOT NULL        |
|product_id                   | fk product.id               |
|description                  | varchar product description |
|count                        | int count                   |
|date                         | date                        |
|amount                       | amount                      |
|taxAmount                    | tax amount                  |
|discountAmount               | discount amount             |
|___________________________________________________________|

我想创建一个允许编辑一个订单及其行的表单。

OrderType.php

class OrderType extends AbstractType
{
    /**
     * @param FormBuilderInterface $builder
     * @param array $options
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('customer', 'entity', array(
                'class' => 'Customer',
                'multiple' => false
            ))
            ->add('orderStatus', 'entity', array(
                'class' => 'AppBundle\Entity\OrderStatus',
                'multiple' => false
            ))
            ->add('date')
            ->add('reference')
            ->add('comments')
            ->add('orderRows', 'collection', [
                'type' => new OrderRowType(),
                'allow_add' => true,
                'by_reference' => false,
            ])
        ;
    }

    ...
}

OrderRowType.php

class OrderRowType extends AbstractType
{
    /**
     * @param FormBuilderInterface $builder
     * @param array $options
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('order', 'entity', array(
                'class' => 'MyShop\Bundle\OrderBundle\Entity\Order',
                'multiple' => false
            ))
            ->add('product', 'product_selector') // service
            ->add('orderRowStatus', 'entity', array(
                'class' => 'AppBundle\Entity\OrderRowStatus',
                'multiple' => false
            ))
            ->add('description')
            ->add('count')
            ->add('startDate')
            ->add('endDate')
            ->add('amount')
            ->add('taxAmount')
            ->add('discountAmount')
        ;
    }

    ...
}

更新订单是通过向我的 API:

发送请求来完成的

请求Url：https://api.example.net/admin/orders/update/37
请求方式：POST

状态码：200

Params: {

"order[customer]": "3",
"order[orderStatus]": "1",
"order[date][month]:": "5",
"order[date][day]": "18",
"order[date][year]": "2015",
"order[reference]": "Testing",
"order[comments]": "I have nothing to say!",
"order[orderRows][0][order]": "32",
"order[orderRows][0][product]": "16721",
"order[orderRows][0][orderRowStatus]:1": "1",
"order[orderRows][0][description]": "8 GB memory",
"order[orderRows][0][count]": "12",
"order[orderRows][0][startDate][month]": "5",
"order[orderRows][0][startDate][day]": "18",
"order[orderRows][0][startDate][year]": "2015",
"order[orderRows][0][endDate][month]": "5",
"order[orderRows][0][endDate][day]": "18",
"order[orderRows][0][endDate][year]": "2015",
"order[orderRows][0][amount]": "122.03",
"order[orderRows][0][taxAmount]": "25.63",
"order[orderRows][0][discountAmount]": "0",
"order[orderRows][1][order]": "32",
"order[orderRows][1][product]": "10352",
"order[orderRows][1][orderRowStatus]": "2",
"order[orderRows][1][description]": "12 GB MEMORY",
"order[orderRows][1][count]": "1",
"order[orderRows][1][startDate][month]": "5",
"order[orderRows][1][startDate][day]": "18",
"order[orderRows][1][startDate][year]": "2015",
"order[orderRows][1][endDate][month]": "5",
"order[orderRows][1][endDate][day]": "18",
"order[orderRows][1][endDate][year]": "2015",
"order[orderRows][1][amount]": "30.8",
"order[orderRows][1][taxAmount]": "6.47",
"order[orderRows][1][discountAmount]": "0",
"order[orderRows][2][order]": "32",
"order[orderRows][2][product]": "2128",
"order[orderRows][2][orderRowStatus]": "3",
"order[orderRows][2][description]": "4GB MEMORY",
"order[orderRows][2][count]": "5",
"order[orderRows][2][startDate][month]": "5",
"order[orderRows][2][startDate][day]": "18",
"order[orderRows][2][startDate][year]": "2015",
"order[orderRows][2][endDate][month]": "5",
"order[orderRows][2][endDate][day]": "18",
"order[orderRows][2][endDate][year]": "2015",
"order[orderRows][2][amount]": "35.5",
"order[orderRows][2][taxAmount]": "7.46",
"order[orderRows][2][discountAmount]": "0"
}

上面的请求编辑订单详细信息并创建新的 order_rows，因为没有提供 order_row_id。在 Symfony2 中，我发现我应该只将 $builder->add('id') 添加到我的 OrderRowType，我的实体也没有列 ID 的设置器。

看了很多资料，有一个很短的问题。我应该如何更新此表单中的 order_rows 记录？

Answer 1

我不认为这是可能的，原因如下：

OrderRows 仅由它们的 id 标识，因此为了让 Doctrine 知道哪个实体实际更新了，需要知道 id。但是随后您需要将 OrderRow id 添加为字段，您不想这样做，因为这将允许更改不属于订单的 'foreign' OrderRows。（没有复杂的权限检查）

解决方案是完全删除旧的 OrderRows 并插入新的。 插入已经有效:-).

删除实体在原则下的the cookbook中有描述：确保数据库持久性

只有一个小缺点：订单更新时 OrderRows 会获得新的 ID。

Answer 2

mappedBy 应该是 order 而不是 Order 因为它指向属性而不是类名.

    /**
 * @var array
 *
 * @ORM\OneToMany(targetEntity="OrderRow", mappedBy="order", cascade={"persist"})
 */
private $orderRows;

Answer 3

如果您不了解内部结构，处理集合和 Doctrine 有时会很复杂。我将首先为您提供一些有关内部结构的信息，以便您更清楚地了解幕后所做的工作。

很难根据您提供的详细信息估计实际问题，但我给您一些建议可以帮助您调试问题。我给出了广泛的答案，因此它可能对其他人有所帮助。

TL;DR 版本

这是我的猜测：即使您将 by_reference 设置为 false，您也正在通过引用修改实体。这可能是因为您没有定义 addOrderRow 和 removeOrderRow 方法（这两个）或者因为您没有使用 doctrine collection object

一些内部结构

表格

当您在控制器中创建一个表单对象时，您将它与您从数据库中检索到的实体（即具有 ID）或您刚刚创建的实体绑定：这意味着表单不要需要主要实体的 ID，也不需要集合对象的 ID。为方便起见，您可以将它添加到表单中，但如果您确实确保它们是不可变的（例如 hidden 类型和 disabled => true 选项）。

创建集合表单时，Symfony 会自动为实体集合中已存在的每个实体创建一个子表单；这就是为什么在 entity/<id>/edit 操作中你（应该）总是看到集合元素的可编辑表单已经存在。

allow_add 和 allow_delete 选项控制生成的子表单是否可以通过删除集合中的某些元素或添加新元素来动态调整大小（请参阅 ResizeFormListener class)。请注意，当您将 prototype 与 javascript 一起使用时，必须小心使用 __prototype__ 占位符：这是用于重新映射对象服务器端的实际 key，因此如果您更改它，表单将在集合中创建一个新元素。

学说

在 Doctrine 中你需要好好照顾映射的 owning side 和 inverse side。 owning 端是将关联保存到数据库的实体，反面是另一个实体。坚持时， owning 方是唯一触发关系被保存的方。在对象修改期间保持两个关系同步是模型的责任。

在处理一对多关系时，owning端是many（比如你的情况是OrderRow），one端是inverse 一侧。

最后，应用程序需要明确标记要持久化的实体。关系的两边都可以标记为 persist cascading，这样所有通过关系可达的实体也会被持久化。在此过程中，所有新实体都会自动保留，并且（在标准配置中）所有 "dirty" 个实体都会更新。

脏实体的概念在 the official docs 中有很好的解释。默认情况下，Doctrine 通过将每个属性与原始状态进行比较，自动检测更新的实体，并在刷新期间生成 UPDATE 语句。如果这是明确的性能改进（即 @ChangeTrackingPolicy("DEFERRED_EXPLICIT")），则必须手动保留所有实体，即使关系被标记为级联。

另请注意，当从数据库重新加载实体时，Doctrine 使用 PersistenCollection 实例来处理集合，因此您需要使用 doctrine 集合接口来处理实体集合。

检查什么

总而言之，这是一份（希望完整的）要检查正确的集合更新的事项列表。

Doctrine 关系的双方设置正确

owning side 和 inverse side 都应该标记为 cascade persist（如果不是，controller 必须手动级联...不推荐，除非太慢）；
集合属性必须是Doctrine\Common\Collection的实现，而不是简单的数组；
模型必须在每次更改时相互更新，因此这意味着
集合对象不应该return按原样编辑以避免引用修改。

你的情况：

<?php

class Order
{
    /**
    * @var integer
    *
    * @ORM\Column(name="id", type="integer")
    * @ORM\Id
    * @ORM\GeneratedValue(strategy="AUTO")
    */
    private $id;

    /**
     * @var \Doctrine\Common\Collections\Collection
     * @ORM\OneToMany(targetEntity="OrderRow", mappedBy="Order", cascade={"persist"})
     */
    private $orderRows;

    public function __construct()
    {
        // this is required, as Doctrine will replace it by a PersistenCollection on load
        $this->orderRows = new \Doctrine\Common\Collections\ArrayCollection();
    }

    /**
     * Add order row
     *
     * @param  OrderRow $row
     */
    public function addOrderRow(OrderRow $row)
    {
        if (! $this->orderRows->contains($row))
            $this->orderRows[] = $row;

        $row->setOrder($this);
    }

    /**
     * Remove order row
     *
     * @param OrderRow $row
     */
    public function removeOrderRow(OrderRow $row)
    {
        $removed = $this->orderRows->removeElement($row);
        /*
        // you may decide to allow your domain to have spare rows, with order set to null
        if ($removed)
            $row->setOrder(null);
        */

        return $removed;
    }

    /**
     * Get order rows
     * @return OrderRow[]
     */
    public function getOrders()
    {
        // toArray prevent edit by reference, which breaks encapsulation
        return $this->orderRows->toArray();
    }
}

class OrderRows
{
    /**
     * @var integer
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @var Order
     * @ORM\ManyToOne(targetEntity="Order", inversedBy="orderRows", cascade={"persist"})
     * @ORM\JoinColumn(name="order_id, referencedColumnName="id", nullable=false)
     */
    private $order;


    /**
     * Set order
     *
     * @param  Order $order
     */
    public function setOrder(Order $order)
    {
        // avoid infinite loops addOrderRow -> setOrder -> addOrderRow
        if ($this->order === $order) {
            return;
        }

        if (null !== $this->order) {
            // see the comment above about spare order rows
            $this->order->removeOrderRow($this);
        }

        $this->order = $order;
    }

    /**
     * Get order
     *
     * @return Order
     */
    public function getOrder()
    {
        return $this->order;
    }
}

表单集合配置正确

确保订单 id 没有暴露在表单中（但在模板中包含路由器操作的正确 GET 参数）
确保 OrderRow order 不存在，因为这将由模型自动更新 class
确保 by_reference 设置为 false
确保 addOrderRow 和 removeOrderRow 都在 Order class
为了加快调试速度，请确保Order::getOrderRows不要return直接收集

这里是片段：

class OrderType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('orderRows', 'collection', [
                'type'           => new OrderRowType(),
                'allow_add'      => true,  // without, new elements are ignored
                'allow_delete'   => true,  // without, deleted elements are not updated
                'by_reference'   => false, // hint Symfony to use addOrderRow and removeOrderRow
                                          // NOTE: both method MUST exist, or Symfony will ignore the option
            ])
        ;
    }
}

class OrderRowType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            // ->add('order') NOT required, the model will handle the setting
            ->add('product', 'product_selector') // service
        ;
    }
}

控制器必须正确更新实体

确保表单创建正确；
如果使用 Form::handleRequest 确保 HTTP 方法与表单方法属性相匹配
如果表单有效，请处理集合中已删除的元素
如果表单有效，持久化实体然后刷新

在您的情况下，您应该执行如下操作：

public function updateAction(Request $request, $id)
{
    $em = $this->getDoctrine()->getManager();

    $order = $em->getRepository('YourBundle:Order')->find($id);

    if (! $order) {
        throw $this->createNotFoundException('Unable to find Order entity.');
    }

    $previousRows = $order->getOrderRows();

// is a PUT request, so make sure that <input type="hidden" name="_method" value="PUT" /> is present in the template
    $editForm = $this->createForm(new OrderType(), $order, array(
        'method' => 'PUT',
        'action' => $this->generateUrl('order_update', array('id' => $id))
    ));
    $editForm->handleRequest($request);

    if ($editForm->isValid()) {
        // removed rows = previous rows - current rows
        $rowsRemoved = array_udiff($previousRows, $order->getOrderRows(), function ($a, $b) { return $a === $b ? 0 : -1; });

        // removed rows must be deleted manually
        foreach ($rowsRemoved as $row) {
            $em->remove($row);
        }

        // if not cascading, all rows must be persisted as well
        $em->flush();
    }

    return $this->render('YourBundle:Order:edit.html.twig', array(
        'entity'      => $order,
        'edit_form'   => $editForm->createView(),
    ));
}

希望对您有所帮助！

"subform" 中的 Symfony2 更新项目

Symfony2 updating items in "subform"

php

symfony-forms

symfony

doctrine-orm