How is the «Refunded» column implemented for the backend's credit memo grids?

dmitry_fedyuk · January 19, 2017, 3:16am

There are 2 credit memo grids in the backend:

In the «Sales» → «Credit Memos» section:

magento/magento2/blob/2.1.3/app/code/Magento/Sales/view/adminhtml/ui_component/sales_order_creditmemo_grid.xml#L143-L150


<column name="base_grand_total" class="Magento\Sales\Ui\Component\Listing\Column\Price">
    <argument name="data" xsi:type="array">
        <item name="config" xsi:type="array">
            <item name="filter" xsi:type="string">textRange</item>
            <item name="label" xsi:type="string" translate="true">Refunded</item>
        </item>
    </argument>
</column>

On the «Credit Memos» tab of an order screen:

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Sales/view/adminhtml/ui_component/sales_order_view_creditmemo_grid.xml#L146-L153


<column name="base_grand_total" class="Magento\Sales\Ui\Component\Listing\Column\Price">
    <argument name="data" xsi:type="array">
        <item name="config" xsi:type="array">
            <item name="filter" xsi:type="string">textRange</item>
            <item name="label" xsi:type="string" translate="true">Refunded</item>
        </item>
    </argument>
</column>

Magento\Sales\Ui\Component\Listing\Column\Price::prepareDataSource():

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Sales/Ui/Component/Listing/Column/Price.php#L43-L65


/**
 * Prepare Data Source
 *
 * @param array $dataSource
 * @return array
 */
public function prepareDataSource(array $dataSource)
{
    if (isset($dataSource['data']['items'])) {
        foreach ($dataSource['data']['items'] as & $item) {
            $currencyCode = isset($item['base_currency_code']) ? $item['base_currency_code'] : null;
            $item[$this->getData('name')] = $this->priceFormatter->format(
                $item[$this->getData('name')],
                false,
                null,
                null,
                $currencyCode
            );
        }
    }


    return $dataSource;
}

Data source: sales_order_creditmemo_grid_data_source

It is implemented by the Magento\Sales\Model\ResourceModel\Order\Creditmemo\Grid\Collection class:

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Sales/etc/di.xml#L804-L804


<item name="sales_order_creditmemo_grid_data_source" xsi:type="string">Magento\Sales\Model\ResourceModel\Order\Creditmemo\Grid\Collection</item>

dmitry_fedyuk · January 19, 2017, 8:26am