Copying fieldsets
Overview
In this tutorial, you will learn to copy custom data from a quote object to an order object using the Magento/Framework/DataObject/Copy class.
Step 1: Define your attributes
The following code defines a simple extension attribute named demo for the Cart and Order objects.
etc/extension_attributes.xml:
1
2
3
4
5
6
7
8
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
<extension_attributes for="Magento\Quote\Api\Data\CartInterface">
<attribute code="demo" type="string" />
</extension_attributes>
<extension_attributes for="Magento\Sales\Api\Data\OrderInterface">
<attribute code="demo" type="string" />
</extension_attributes>
</config>
Step 2: Configure the fieldset
The following code adds the demo field to the sales_convert_quote fieldset with the to_order aspect.
The code snippet in the next step uses the name of the fieldset and aspect to specify which fields to copy.
etc/fieldset.xml:
The following example shows how to copy sales_convert_quote.demo to sales_order.demo.
1
2
3
4
5
6
7
8
9
10
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:DataObject/etc/fieldset.xsd">
<scope id="global">
<fieldset id="sales_convert_quote">
<field name="demo">
<aspect name="to_order" />
</field>
</fieldset>
</scope>
</config>
Use the targetField attribute to specify the destination field. The following example shows how to copy sales_convert_quote.demo to sales_order.order_demo.
1
2
3
4
5
6
7
8
9
10
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:DataObject/etc/fieldset.xsd">
<scope id="global">
<fieldset id="sales_convert_quote">
<field name="demo">
<aspect name="to_order" targetField="order_demo"/>
</field>
</fieldset>
</scope>
</config>
Define a new aspect if you need to copy a field of a source table into multiple fields in a destination table.
The following example shows how to copy sales_convert_quote.demo into
sales_order.demosales_order.order_demo
1
2
3
4
5
6
7
8
9
10
11
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:DataObject/etc/fieldset.xsd">
<scope id="global">
<fieldset id="sales_convert_quote">
<field name="demo">
<aspect name="to_order"/>
<aspect name="to_demo_order" targetField="order_demo"/>
</field>
</fieldset>
</scope>
</config>
Step 3: Copy the fieldset
For copying the fieldset, we’ll observe the sales_model_service_quote_submit_before event by using the following code in our etc/events.xml:
1
2
3
4
5
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
<event name="sales_model_service_quote_submit_before">
<observer name="[vendor]_[module]_sales_model_service_quote_submit_before" instance="Vendor\Module\Observer\SaveOrderBeforeSalesModelQuoteObserver" />
</event>
</config>
The following code snippets highlight the code pieces needed to copy a fieldset using the \Magento\Framework\DataObject\Copy class.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Vendor\Module\Observer;
use Magento\Framework\DataObject\Copy;
use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;
use Magento\Quote\Model\Quote;
use Magento\Sales\Model\Order;
class SaveOrderBeforeSalesModelQuoteObserver implements ObserverInterface
{
...
/**
* @var Copy
*/
protected $objectCopyService;
...
/**
* @param Copy $objectCopyService
* ...
*/
public function __construct(
Copy $objectCopyService,
...
) {
$this->objectCopyService = $objectCopyService;
...
}
/**
* @param Observer $observer
*/
public function execute(Observer $observer)
{
/* @var Order $order */
$order = $observer->getEvent()->getData('order');
/* @var Quote $quote */
$quote = $observer->getEvent()->getData('quote');
$this->objectCopyService->copyFieldsetToTarget('sales_convert_quote', 'to_order', $quote, $order);
...
return $this;
}
}
In the code, an instance of the Copy class is obtained from the constructor using dependency injection.
The copyFieldsetToTarget function call with the $quote and $order parameters copies the fieldset for the two objects.
Step 4: Compile and cache clean
Compile the code with this command:
1
bin/magento setup:di:compile
and clean the cache with this command:
1
bin/magento cache:clean