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.
extension_attributes.xml
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="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.
fieldset.xml
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="DataObject/etc/fieldset.xsd">
<scope id="global">
<fieldset id="sales_convert_quote">
<field name="demo">
<aspect name="to_order" />
</field>
</fieldset>
</scope>
</config>Step 3: Copy the fieldset
The following code snippets highlight the code pieces needed to copy a fieldset using the \Magento\Framework\DataObject\Copy class.
...
/**
* @var \Magento\Framework\DataObject\Copy
*/
protected $objectCopyService;
...
/**
* @param \Magento\Framework\DataObject\Copy $objectCopyService
...
*/
public function __construct(
\Magento\Framework\DataObject\Copy $objectCopyService,
...
) {
$this->objectCopyService = $objectCopyService;
...
}
...
/**
* @param $quote \Magento\Quote\Api\Data\CartInterface
* @param $order \Magento\Sales\Api\Data\Order
*/
private function copyQuoteToOrder($quote, $order)
{
...
$copy->copyFieldsetToTarget('sales_convert_quote', 'to_order', $quote, $order);
...
}
...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..