Magento 1.8 – Add ‘Short Description’ to ‘Items Ordered’ Table in Sales Order Admin View

magento-1.8order-gridproduct-attributesales-order

Is it possible to add the 'Short Description' to the 'order view' within the 'Sales admin page'. Primarily in the 'items ordered' table so;

[Product][Item Status][Original Price][Price][Qty]…etc

[Short Description][Product][Item Status][Original Price][Price][Qty]…etc

This is the screen we'd like to edit.
url/sales_order/view/order_id….
enter image description here

The Short Description exists in a simple product.

If we could also add this functionality to the order grid, that would be great.

We've taken a look at mySQL and the entry exists in 'catalog_product_flat_1' and can probably cobble a custom SELECT query to achieve this but we were wondering if there is a better way?

Thanks in advance.

Best Answer

Editing the back end is the same as editing the front end - you can do anything from customising the templates through to extending the various blocks and models.

I don't have a 1.8 install active right now so this using 1.7.2.

If we trace through from the URL, via the controllers and XML layout files, you'll see that the rows of that table are rendered by the block model app/code/core/Mage/Adminhtml/Block/Sales/Items/Renderer/Default.php, using template app/design/adminhtml/default/default/template/sales/order/view/items/renderer/default.phtml.

$this in the template of course refers to the block model, and we can see that to render the product's name, it's using $this->getColumnHtml($_item, 'name'). Looking at the code for that function, we can see it sometimes treats $_item as a sales order item, and looking at the code to see where that comes from, we can see in the Mage_Adminhtml_Block_Sales_Order_View_Items block that it comes from the getItemsCollection method called on a sales order model, so it's an actual sales order item model. Often in Magento, a collection will be constructed to contain only sparsely populated objects (in non-Magento terms, imagine a SELECT statement that only selects a few fields), but in this case it at least contains the product ID.

Using that Mage_Sales_Model_Order_Item object, we can see from that model's code that we can call getProduct, giving us a fully loaded product object, and from there we can call getShortDescription().

So adding this:

echo $_item->getProduct()->getShortDescription()

somewhere in

app/design/adminhtml/default/default/template/sales/order/view/items/renderer/default.phtml

will show you the short description.

Tested on 1.7.2

Loading the full product model for each line shown there might be a little slow if the orders contain dozens of lines, but in most cases I expect staff will happily wait an extra second or two for the screen to load. You could optimise it by loading a sparsely populated product collection before rendering all the items... I'll leave that as an exercise to the reader!

Event on collection load before:

  protected function _beforeLoad()
    {
        parent::_beforeLoad();
        Mage::dispatchEvent('core_collection_abstract_load_before', array('collection' => $this));
        if ($this->_eventPrefix && $this->_eventObject) {
            Mage::dispatchEvent($this->_eventPrefix.'_load_before', array(
                $this->_eventObject => $this
            ));
        }
        return $this;
    }

Event on collection load after:

protected function _afterLoad()
    {
        parent::_afterLoad();
        foreach ($this->_items as $item) {
            $item->setOrigData();
            if ($this->_resetItemsDataChanged) {
                $item->setDataChanges(false);
            }
        }
        Mage::dispatchEvent('core_collection_abstract_load_after', array('collection' => $this));
        if ($this->_eventPrefix && $this->_eventObject) {
            Mage::dispatchEvent($this->_eventPrefix.'_load_after', array(
                $this->_eventObject => $this
            ));
        }
        return $this;
    }

Now if we add the custom table on basic of two event then it can fulfill yours requirement

Basically on the sales order collection load event we can add your custom table.Just Order grid load from sales/order_grid_collection.This collection

collection these events are sales_order_grid_collection_load_before and sales_order_grid_collection_load_after. If we add custom table using joinLeft then it would be working good.

Example:

<adminhtml>
    <events>
        <sales_order_grid_collection_load_before>
            <observers>
                <amit_sales_order_grid_collection_load_before>
                    <class>Yourmodulem modelPrefix/observer</class>
                    <method>addmycustomtable</method>
                </amit_sales_order_grid_collection_load_before>
            </observers>
        </sales_order_grid_collection_load_before>
    </events>
</adminhtml>

Observer code:

<?php class MyNameSpace_Mymodule_Model_Observer
public function addmycustomtable(Varien_Event_Observer $observer)
    {
        $collection = $observer->getOrderGridCollection();
        $select = $collection->getSelect();
        $select->joinLeft(array('v' => 'additional_order_info'),
                        'main_table.entity_id = v.order_id',
                        array('*'));
}
}

Best Answer

Related Solutions

Magento – Join Custom Table with Admin/Sales/Order/View

Event on collection load before:

Event on collection load after:

Related Topic