如何在 Magento 的销售/订单网格中添加自定义列？答案

【问题标题】：How to add Custom Column in sales/order grid in Magento?如何在 Magento 的销售/订单网格中添加自定义列？
【发布时间】：2014-09-12 05:59:20
【问题描述】：

我正在尝试将自定义列添加到我的销售/订单网格中。我的列将是跟踪号和磁贴。标题基本上是快递员代码，它显示您通过哪个快递员向您发送产品。所以我为此做了一些以下事情。

我已将文件从magento/app/code/core/Mage/Adminhtml/Block/Sales/Order/Grid.php复制到

magento/app/code/local/Mage/Adminhtml/Block/Sales/Order/Grid.php

这样我就可以添加列并自定义我的销售/订单网格。

在文件Grid.php中，有_prepareCollections()函数。

这里的代码进入它。

protected function _prepareCollection()
    {
        $collection = Mage::getResourceModel($this->_getCollectionClass());
        $this->setCollection($collection);
        $collection->getSelect();
        $collection->getSelect()->join('sales_flat_shipment_track', 'main_table.entity_id =sales_flat_shipment_track.order_id',array('track_number'=> new Zend_Db_Expr('group_concat(sales_flat_shipment_track.track_number SEPARATOR ",")'),'title' => new Zend_Db_Expr('group_concat(sales_flat_shipment_track.title SEPARATOR ",")')));
        return parent::_prepareCollection();    
    }

现在我将在我的 _prepareColumns() 函数中添加我的列。代码是

protected function _prepareColumns()
    {
        $this->addColumn('track_number', array(
            'header'=> Mage::helper('sales')->__(' Track Number'),
            'width' => '80px',
            'type'  => 'text',
            'index' => 'track_number',
            ));
        $this->addColumn('title', array(

            'header'=> Mage::helper('sales')->__('Title'),
            'width' => '80px',
            'index' => 'title',
            ));

文件 Grid.php 在这里。

<?php
/**
 * Magento
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@magentocommerce.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade Magento to newer
 * versions in the future. If you wish to customize Magento for your
 * needs please refer to http://www.magentocommerce.com for more information.
 *
 * @category    Mage
 * @package     Mage_Adminhtml
 * @copyright   Copyright (c) 2014 Magento Inc. (http://www.magentocommerce.com)
 * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */

/**
 * Adminhtml sales orders grid
 *
 * @category   Mage
 * @package    Mage_Adminhtml
 * @author      Magento Core Team <core@magentocommerce.com>
 */
class Mage_Adminhtml_Block_Sales_Order_Grid extends Mage_Adminhtml_Block_Widget_Grid
{

    public function __construct()
    {
        parent::__construct();
        $this->setId('sales_order_grid');
        $this->setUseAjax(true);
        $this->setDefaultSort('created_at');
        $this->setDefaultDir('DESC');
        $this->setSaveParametersInSession(true);
    }

    /**
     * Retrieve collection class
     *
     * @return string
     */
    protected function _getCollectionClass()
    {
        return 'sales/order_grid_collection';
    }

    protected function _prepareCollection()
    {
        $collection = Mage::getResourceModel($this->_getCollectionClass());
        $this->setCollection($collection);
        $collection->getSelect();
        $collection->getSelect()->join('sales_flat_shipment_track', 'main_table.entity_id =sales_flat_shipment_track.order_id',array('track_number'=> new Zend_Db_Expr('group_concat(sales_flat_shipment_track.track_number SEPARATOR ",")'),'title' => new Zend_Db_Expr('group_concat(sales_flat_shipment_track.title SEPARATOR ",")')));
        return parent::_prepareCollection();    
    }

    protected function _prepareColumns()
    {
        $this->addColumn('track_number', array(
            'header'=> Mage::helper('sales')->__(' Track Number'),
            'width' => '80px',
            'type'  => 'text',
            'index' => 'track_number',
            ));
        $this->addColumn('title', array(

            'header'=> Mage::helper('sales')->__('Title'),
            'width' => '80px',
            'index' => 'title',
            ));

        $this->addColumn('real_order_id', array(
            'header'=> Mage::helper('sales')->__('Order #'),
            'width' => '80px',
            'type'  => 'text',
            'index' => 'increment_id',
        ));

        if (!Mage::app()->isSingleStoreMode()) {
            $this->addColumn('store_id', array(
                'header'    => Mage::helper('sales')->__('Purchased From (Store)'),
                'index'     => 'store_id',
                'type'      => 'store',
                'store_view'=> true,
                'display_deleted' => true,
            ));
        }

        $this->addColumn('created_at', array(
            'header' => Mage::helper('sales')->__('Purchased On'),
            'index' => 'created_at',
            'type' => 'datetime',
            'width' => '100px',
        ));

        $this->addColumn('billing_name', array(
            'header' => Mage::helper('sales')->__('Bill to Name'),
            'index' => 'billing_name',
        ));

        $this->addColumn('shipping_name', array(
            'header' => Mage::helper('sales')->__('Ship to Name'),
            'index' => 'shipping_name',
        ));

        $this->addColumn('base_grand_total', array(
            'header' => Mage::helper('sales')->__('G.T. (Base)'),
            'index' => 'base_grand_total',
            'type'  => 'currency',
            'currency' => 'base_currency_code',
        ));

        $this->addColumn('grand_total', array(
            'header' => Mage::helper('sales')->__('G.T. (Purchased)'),
            'index' => 'grand_total',
            'type'  => 'currency',
            'currency' => 'order_currency_code',
        ));

        $this->addColumn('status', array(
            'header' => Mage::helper('sales')->__('Status'),
            'index' => 'status',
            'type'  => 'options',
            'width' => '70px',
            'options' => Mage::getSingleton('sales/order_config')->getStatuses(),
        ));

        if (Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/view')) {
            $this->addColumn('action',
                array(
                    'header'    => Mage::helper('sales')->__('Action'),
                    'width'     => '50px',
                    'type'      => 'action',
                    'getter'     => 'getId',
                    'actions'   => array(
                        array(
                            'caption' => Mage::helper('sales')->__('View'),
                            'url'     => array('base'=>'*/sales_order/view'),
                            'field'   => 'order_id',
                            'data-column' => 'action',
                        )
                    ),
                    'filter'    => false,
                    'sortable'  => false,
                    'index'     => 'stores',
                    'is_system' => true,
            ));
        }
        $this->addRssList('rss/order/new', Mage::helper('sales')->__('New Order RSS'));

        $this->addExportType('*/*/exportCsv', Mage::helper('sales')->__('CSV'));
        $this->addExportType('*/*/exportExcel', Mage::helper('sales')->__('Excel XML'));

        return parent::_prepareColumns();
    }

    protected function _prepareMassaction()
    {
        $this->setMassactionIdField('entity_id');
        $this->getMassactionBlock()->setFormFieldName('order_ids');
        $this->getMassactionBlock()->setUseSelectAll(false);

        if (Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/cancel')) {
            $this->getMassactionBlock()->addItem('cancel_order', array(
                 'label'=> Mage::helper('sales')->__('Cancel'),
                 'url'  => $this->getUrl('*/sales_order/massCancel'),
            ));
        }

        if (Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/hold')) {
            $this->getMassactionBlock()->addItem('hold_order', array(
                 'label'=> Mage::helper('sales')->__('Hold'),
                 'url'  => $this->getUrl('*/sales_order/massHold'),
            ));
        }

        if (Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/unhold')) {
            $this->getMassactionBlock()->addItem('unhold_order', array(
                 'label'=> Mage::helper('sales')->__('Unhold'),
                 'url'  => $this->getUrl('*/sales_order/massUnhold'),
            ));
        }

        $this->getMassactionBlock()->addItem('pdfinvoices_order', array(
             'label'=> Mage::helper('sales')->__('Print Invoices'),
             'url'  => $this->getUrl('*/sales_order/pdfinvoices'),
        ));

        $this->getMassactionBlock()->addItem('pdfshipments_order', array(
             'label'=> Mage::helper('sales')->__('Print Packingslips'),
             'url'  => $this->getUrl('*/sales_order/pdfshipments'),
        ));

        $this->getMassactionBlock()->addItem('pdfcreditmemos_order', array(
             'label'=> Mage::helper('sales')->__('Print Credit Memos'),
             'url'  => $this->getUrl('*/sales_order/pdfcreditmemos'),
        ));

        $this->getMassactionBlock()->addItem('pdfdocs_order', array(
             'label'=> Mage::helper('sales')->__('Print All'),
             'url'  => $this->getUrl('*/sales_order/pdfdocs'),
        ));

        $this->getMassactionBlock()->addItem('print_shipping_label', array(
             'label'=> Mage::helper('sales')->__('Print Shipping Labels'),
             'url'  => $this->getUrl('*/sales_order_shipment/massPrintShippingLabel'),
        ));

        return $this;
    }

    public function getRowUrl($row)
    {
        if (Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/view')) {
            return $this->getUrl('*/sales_order/view', array('order_id' => $row->getId()));
        }
        return false;
    }

    public function getGridUrl()
    {
        return $this->getUrl('*/*/grid', array('_current'=>true));
    }

}

现在我在我的网格上获得了跟踪编号和标题列。但是在我的跟踪号中，它向我显示了重复的条目。例如，如果我的跟踪号是 12345678，它会显示两个相同的值，就像这样。 12345678,12345678。

在我的标题中，它显示了两次联邦快递，联邦快递。

我想要的是两件事，

一个。首先，可以有 2 个跟踪编号，或者更多。但它应该像这样显示。前任。 12345678,12345678900。它应该是不同的。

对于我的某些订单，它显示不同。但他们中的大多数都有重复的条目。

b.其次，如果快递是通过联邦快递发送的，然后如果产品退回并且我们通过 bluedart 发送然后它应该显示联邦快递 bluedart 。但我得到的是联邦快递，联邦快递，蓝镖，蓝镖。

它显示了我 4 次。

我不知道我到底面临什么问题。是任何数据库问题或我写的查询。

请告诉我是否

protected function _prepareCollection()
        {
            $collection = Mage::getResourceModel($this->_getCollectionClass());
            $this->setCollection($collection);
            $collection->getSelect();
            $collection->getSelect()->join('sales_flat_shipment_track', 'main_table.entity_id =sales_flat_shipment_track.order_id',array('track_number'=> new Zend_Db_Expr('group_concat(sales_flat_shipment_track.track_number SEPARATOR ",")'),'title' => new Zend_Db_Expr('group_concat(sales_flat_shipment_track.title SEPARATOR ",")')));
            return parent::_prepareCollection();    
        }

这个函数是正确的，其中写的查询也是正确的。

编辑部分

我还想在我的 grid.php 中过滤 track_number 和 title。我已经尝试了一些东西。

这段代码在grid.php中，

protected function spaceSeparatedFilter($collection, $column)
{
    $value = $column->getFilter()->getValue();
    if (!$value) {

        return $this;
    }
    //if there was a space input
        else if(preg_match('/s+/', $value))
    {
        //explode by space, getting array of IDs
        $val = explode(" ", $value);
        //filter the collection, where collection index (order_id) is present in $val array
        $this->getCollection()->addAttributeToFilter($column->getData('index'), array('in'=>$val));
    }
    else
    {
    //else use default grid filter functionality (like $value input)
    $this->getCollection()->addAttributeToFilter($column->getData('index'), array('like' => '%'.$value.'%'));
    }
    return $this;
}

现在我已将过滤条件添加到我的 addcolumn，

$this->addColumn('track_number', array(
            'header'=> Mage::helper('sales')->__(' Track Number'),
            'width' => '80px',
            'type'  => 'text',
            'index' => 'track_number',
            'filter_condition_callback' => array($this, 'spaceSeparatedFilter'),
            ));

        $this->addColumn('title', array(
            'header'=> Mage::helper('sales')->__('Title'),
            'width' => '80px',
            'index' => 'title',
            'filter_condition_callback' => array($this, 'spaceSeparatedFilter'),
            ));

但我无法在我的销售/订单网格中进行过滤。请告诉我解决方案。

感谢和问候。

【问题讨论】：

标签： php mysql magento magento-1.9.1

【解决方案1】：

如果在您的 _prepareCollection 方法中，我通过以下方式打印查询：

echo $collection->getSelect()->assemble();

我明白了：

SELECT 
    `main_table`.*, 
    group_concat(sales_flat_shipment_track.track_number SEPARATOR ",") AS `track_number`, 
    group_concat(sales_flat_shipment_track.title SEPARATOR ",") AS `title` 

FROM `sales_flat_order_grid` AS `main_table` 

INNER JOIN `sales_flat_shipment_track` 
    ON main_table.entity_id = sales_flat_shipment_track.order_id

通过这个查询，我总是会得到一个结果，即使表上没有订单时也是一个“空”行。相反，我认为您想要实现的目标可以使用子查询来完成：

SELECT 
    `main_table`.*, 
    (
        SELECT 
            group_concat(`t`.`track_number` SEPARATOR ",") AS `track_number`

        FROM `sales_flat_shipment_track` AS `t`

        WHERE `main_table`.`entity_id` = `t`.`order_id`
    ),
    (
        SELECT 
            group_concat(`t`.`title` SEPARATOR ",") AS `title`

        FROM `sales_flat_shipment_track` as `t`

        WHERE `main_table`.`entity_id` = `t`.`order_id`
    )

FROM `sales_flat_order_grid` AS `main_table`;

所以要为 Magento 翻译它，它看起来像这样：

protected function _prepareCollection()
{
    $collection = Mage::getResourceModel('sales/order_grid_collection');

    $collection->getSelect()
        ->from(
            array(),
            array(
                'track_number' => new Zend_Db_Expr('(
                    SELECT GROUP_CONCAT(`t`.`track_number` SEPARATOR ",")
                    FROM `sales_flat_shipment_track` as `t`
                    WHERE `main_table`.`entity_id` = `t`.`order_id`
                )'),
                'title' => new Zend_Db_Expr('(
                    SELECT GROUP_CONCAT(`t`.`title` SEPARATOR ",")
                    FROM `sales_flat_shipment_track` as `t`
                    WHERE `main_table`.`entity_id` = `t`.`order_id`
                )'),
            )
        );

    $this->setCollection($this);

    return parent::_prepareCollection();
}

关于重复运营商标题的观点，在这种情况下是可以预料的。唯一的解决方法是在标题的子查询中添加一个DISTINCT 词，如下所示：

SELECT GROUP_CONCAT(DISTINCT `t`.`title` SEPARATOR ",")

但我不确定您打算如何处理网格中的这些数据。希望对您有所帮助。

【讨论】：

您好 rick 先生，感谢您的回复。我对这两列的过滤有疑问。我想在我的管理网格中过滤 track_number 和 title。我该怎么做这些？？？
嘿@JayDesai，如果您要创建一个新问题，我会尝试在那里回答。然后在您的下一条评论中提供指向它的链接。谢谢！
stackoverflow.com/questions/25850777/…
您好先生..上面提供的链接是我的新问题。请帮帮我。

【解决方案2】：

首先，您没有使用重写 Magento 文件的好方法。看看这个：

http://inchoo.net/magento/how-to-extend-magento-order-grid/

一旦你做到了，在 Grid.php 中做

protected function _prepareCollection() {
    $collection = Mage::getResourceModel ( $this->_getCollectionClass () );
    $collection->join(array('so'=>'sales/order'), 'main_table.entity_id=so.entity_id', array('your_coustom_field'=>'your_coustom_field', 'customer_email'=>'customer_email' ), null,'left');
    $this->setCollection ( $collection );
    return parent::_prepareCollection();
}

然后在_prepareColumn方法中添加

$this->addColumn ( 'customer_email', array (
    'header' => Mage::helper ( 'sales' )->__ ( 'customer email' ),
    'index' => 'customer_email'
) );

【讨论】：