php - Symfony2更新 “subform”中的项目

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

And an entity OrderRow (an order can have one or more rows)

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

I'd like to create one form which allows editing one order and it's rows.

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发送请求来完成订单更新:

请求网址: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中的Nowere中，我发现我应该只将$ builder-> add('id')添加到我的OrderRowType中，而我的实体也没有用于列ID的 setter 。

在获得大量信息之后，我有一个非常简短的问题。我应该如何更新此表单中的order_rows记录？

Answer 1

如果您不了解内部原理，那么处理收集和主义有时可能会很复杂。首先，我将向您提供有关内部结构的一些信息，以便您更清楚地了解内部操作。

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

TL; DR版本

这是我的猜测:即使将by_reference设置为false，也要通过引用修改实体。这可能是因为您尚未定义addOrderRow和removeOrderRow方法(两者都定义)，或者因为您未使用主义集合对象

一些内部

形式

在 Controller 中创建Form对象时，将其与从数据库中检索到的实体(即具有ID)或刚创建的实体绑定(bind):这意味着Form不需要主要实体的ID，也不需要收集对象的ID。为了方便起见，可以将其添加到表单中，但如果要确保它们是不可变的(例如，带有hidden选项的disabled => true类型)。

创建集合表单后，Symfony会为实体集合中已经存在的每个实体自动创建一个子表单。这就是为什么在entity/<id>/edit操作中，您(应该)始终会看到已经存在的集合元素的可编辑形式的原因。
allow_add和allow_delete选项控制是否可以通过删除集合中的某些元素或添加新元素来动态调整生成的子表单的大小(请参见ResizeFormListener类)。请注意，当将prototype与javascript一起使用时，必须谨慎使用__prototype__占位符:这是用于重新映射对象服务器端的实际key，因此，如果更改它，则Form将在集合中创建一个新元素。

教义

在Doctrine中，您需要注意映射的owning side和inverse side。 owning端是将实体与数据库保持关联的实体，而相反端是另一实体。当持久化时，owning端是唯一会触发关系被保存的端。在对象修改过程中，使两个关系保持同步是模型责任。

在处理一对多关系时，owning端是many(例如您的情况下的OrderRow)，而one端是inverse端。

最后，应用程序需要显式标记实体以持久化。关系的两侧都可以标记为persist cascading，因此通过关系的所有可访问实体也将被保留。在此过程中，所有新实体都会自动保留，并且(在标准配置中)所有“脏”实体都会更新。

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

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

检查什么

总结一下，这里是一个(希望完成的)事情 list ，用于检查集合更新是否正确。

教义关系的双方都已正确设置

拥有方和相反方都应标记为级联持久(如果不是，则 Controller 必须手动级联...不建议这样做，除非太慢)；

集合属性必须是Doctrine\Common\Collection的实现，而不是简单的数组；

模型必须在每次更改时相互更新，因此这意味着

不应按原样返回集合对象，以避免通过引用进行修改。

在您的情况下:

<?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;
    }
}

表单收集配置正确

确保表单未暴露Order id(但在模板中包括路由器操作的正确GET参数)

确保不存在OrderRow order，因为它将由模型类

自动更新

确保将by_reference设置为false

确保在addOrderRow类

中定义了removeOrderRow和Order

以加快调试速度，请确保Order::getOrderRows不直接返回集合

以下是代码段:

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

Controller 必须正确更新实体

确保正确创建了表单；

(如果使用Form::handleRequest)，请确保HTTP方法与Form方法属性

相匹配

(如果表单有效)，请照顾

集合中已删除的元素

如果表单有效，则保留实体，然后刷新

在您的情况下，您应该执行以下操作:

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(),
    ));
}

希望这可以帮助!