How to Add Filterable ‘Manage Stock’ Column to Catalog Admin Grid

gridmagento-enterprise

After reading many answers here (and a load of Google searches), I've gotten Magento to almost do what I want it to do. Basically, I want to add a column to the 'Manage Products' page under Catalog. Right now, I've been successful in adding the column where I want it, and with a drop down, but I have a couple of issues:

1) the drop down in the header is displaying the 'Attrib. Set Name' options instead of the 'Manage Stock' options

2) Nothing is showing up in the product listings for that column on that page

Below is my code and I'm hoping someone can spot my (obvious) mistake(s). TIA.

EDIT: After a bit more reading, I'm thinking that I may need to do a 'joinTable' to get the value that I'm looking for, but still not quite there. I've updated the code below, but I'm getting a fatal error in the protected function '_prepareColumns', on the array name value pair 'index' => 'manage_stock'. The error in my Apache logs is: "PHP Fatal error: Call to a member function getBackend() on a non-object"

EDIT 2: Made minor changes over the weekend but was unable to get it working. Updated code is below; still producing the fatal error.

EDIT 3: Updated code per Yiorgos' suggestion, and the error went away, as well as something being populated in the field for the product. However, I seem to have a poor understanding of how the options field of the array in the 'addColumnAfter' method in the '_prepareColumns' protected function. No matter what I do there, the data shown in the column is whatever the first element of the array is, regardless of what the setting for the actual product is. I've tried the following:

'options' => array (0 => 'No', 1 => 'Yes') --> All products show 'No'
'options' => array ('0' => 'No', '1' => 'Yes') --> All products show 'No'
'options' => array (0 => 'Yes', 1 => 'No') --> All products show 'Yes'
'options' => array ('0' => 'Yes', '1' => 'No') --> All products show 'Yes'

EDIT 4: Code has been updated below as per Yiorgos', but I'm still having some issue with it not filtering properly. Example – when I filter for 'No', I still get products are are set to 'Yes' (says no in the category column) even though the product is set to 'Yes'.

Sample of catalog page, product example outlined in red:

Product inventory section of product from catalog page:

Updated Code:

<?php

class MyCompany_Catalog_Block_Adminhtml_Catalog_Product_Grid extends Mage_Adminhtml_Block_Catalog_Product_Grid
{
    public function setCollection($collection)
    {
        $store = $this->_getStore();
        $collection->joinField('manage_stock',
            'cataloginventory/stock_item',
            'manage_stock',
            'product_id=entity_id',
            '{{table}}.stock_id=1',
            'left');
        parent::setCollection($collection);
    }

    protected function _prepareColumns()
    {
        $store = $this->_getStore();
        $this->addColumnAfter('manage_stock',
                array(
                        'header'=> Mage::helper('catalog')->__('Manage Stock'),
                        'index' => 'manage_stock',
                        'type'  => 'options',
                        'options' => array (
                            '0' => Mage::helper('core')->__('No'),
                            '1' => Mage::helper('core')->__('Yes'),)
                ),
                'qty'
        );
        return parent::_prepareColumns();
    }
}

Best Answer

Try replacing the line

 $collection->addAttributeToSelect('manage_stock');

with

        $collection->joinField('manage_stock',
            'cataloginventory/stock_item',
            'manage_stock',
            'product_id=entity_id',
            '{{table}}.stock_id=1',
            'left');

Your _prepareColumns function should look like this

protected function _prepareColumns(){
    $this->addColumn('manage_stock', array(
           'header'=> Mage::helper('catalog')->__('Manage Stock'),
           'index' => 'manage_stock',
           'type'  => 'options',
           'options' => array (
                           '0' =>  Mage::helper('core')->__('No'), 
                           '1' =>  Mage::helper('core')->__('Yes'),
                        )
    ));
    return parent::_prepareColumns();
}

app/etc/modules/{namespace}_{module}

    <Namespace_Module>
        <active>true</active>
        <codePool>local</codePool>
    </Namespace_Module>

app/code/local/{namespace}/{module}/etc/config.xml

<?xml version="1.0"?>
<config>
    <modules>
        <Namespace_Module>
            <version>0.0.0.1</version>
        </Namespace_Module>
    </modules>
    <global>
        <blocks>
            <namespace_module>
                <class>Namespace_Module_Block</class>
            </namespace_module>
        </blocks>
        <helpers>
            <namespace_module>
                <class>Namespace_Module_Helper</class>
            </namespace_module>
        </helpers>
    </global>
    <admin>
        <routers>
            <adminhtml>
                <args>
                    <modules>
                        <namespace_module before="Mage_Adminhtml">Namespace_Module_Adminhtml</namespace_module>
                    </modules>
                </args>
            </adminhtml>
        </routers>
    </admin>
</config>

app/code/local/{namespace}/{module}/etc/adminhtml.xml

<?xml version="1.0"?>
<config>
    <menu>
        <sales> <!-- In menu, change as needed -->
            <children>
                <namespace_module translate="title" module="namespace_module">
                    <sort_order>10</sort_order> <!-- sort order in menu -->
                    <title>module title here</title>
                    <action>adminhtml/order/</action> <!-- controller action to call -->
                </namespace_module>
            </children>
        </sales>
    </menu>
</config>

app/code/local/{namespace}/{module}/Helper/Data.php

<?php
class Namespace_Module_Helper_Data extends Mage_Core_Helper_Abstract
{
}

app/code/local/{namespace}/{module}/Block/Adminhtml/Item/Grid.php

<?php
class Namespace_Module_Block_Adminhtml_Item_Grid extends Mage_Adminhtml_Block_Widget_Grid
{
    public function __construct()
    {
        parent::__construct();
        $this->setId('namespace_module_grid');
        $this->setDefaultSort('entity_id');
        $this->setDefaultDir('DESC');
        $this->setSaveParametersInSession(true);
        $this->setUseAjax(true);
    }
    protected function _prepareCollection()
    {
        $collection = null; //Your collection code here instead of null
        $this->setCollection($collection);
        parent::_prepareCollection();
        return $this;
    }
    protected function _prepareColumns()
    {
        $helper = Mage::helper('namespace_module');
        $currency = (string) Mage::getStoreConfig(Mage_Directory_Model_Currency::XML_PATH_CURRENCY_BASE);

        // To add a column. (column will be added if the field is available)
        $this->addColumn('entity_id', array(
            'header' => $helper->__('Product id'),
            'index'  => 'entity_id',
            'type'   => 'number'
        ));

        return parent::_prepareColumns();
    }

    //Include this if checkboxes are needed for the listed items
    protected function _prepareMassaction(){
        $this->setMassactionIdField('entity_id');
        $this->getMassactionBlock()->setFormFieldName('namespace_module');
        $this->getMassactionBlock()->addItem('status', array(
            'label'=> Mage::helper('namespace_module')->__('Save'),
            'url'  => $this->getUrl('*/*/massSave', array('_current'=>true))  // calling "massSaveAction" method in controller.
        ));
        return $this;
    }
    public function getGridUrl()
    {
        return $this->getUrl('*/*/grid', array('_current'=>true));
    }
}

app/code/local/{namespace}/{module}/Block/Adminhtml/Item.php

<?php
class Namespace_Module_Block_Adminhtml_Item extends Mage_Adminhtml_Block_Widget_Grid_Container
{
    public function __construct()
    {
        $this->_blockGroup = 'namespace_module';
        $this->_controller = 'adminhtml_sales_order';
        $this->_headerText = Mage::helper('namespace_module')->__('Module items');
        parent::__construct();
        $this->_removeButton('add');
    }
}

app/code/local/{namespace}/{module}/controllers/Adminhtml/ItemController.php

<?php
class Namespace_Module_Adminhtml_ItemController extends Mage_Adminhtml_Controller_Action
{
    public function indexAction()
    {
        $this->_title($this->__('page title here'));
        $this->loadLayout();
        $this->_setActiveMenu('active menu name'); //looks like optional to me
        $this->_addContent($this->getLayout()->createBlock('namespace_module/adminhtml_item'));
        $this->renderLayout();
    }
    public function gridAction()
    {
        $this->loadLayout();
        $this->getResponse()->setBody(
            $this->getLayout()->createBlock('namespace_module/adminhtml_item_grid')->toHtml()
        );
    }
    public function massSaveAction(){
        $urlParam = $this->getRequest()->getParam('namespace_module');
        if(!is_array($urlParam)) {
            Mage::getSingleton('adminhtml/session')->addError(Mage::helper('namespace_module')->__('Please select Items.'));
        } 
        else {
            try {
                // Add action code here
                // Like, sql queries to update database table

                $this->_getSession()->addSuccess($this->__('Total of %d Items were successfully updated.', count($urlParam)));
            }
            catch (Mage_Core_Exception $e){
                Mage::getSingleton('adminhtml/session')->addError($e->getMessage());
            }
            catch (Exception $e) {
                Mage::getSingleton('adminhtml/session')->addError(Mage::helper('namespace_module')->__('There was an error updating Items.'));
                Mage::logException($e);
            }
        }
        $this->_redirect('*/*/index');
    }
}

Best Answer

Related Solutions

Magento – Adding onclick event and id selector for an Admin Grid column of type radio

How to Add an Admin Grid in Magento 1.8