Magento – Mass Action in Widgets

adminhtmljavascriptmassactionwidgets

A while back I found a question on stackoverflow about allowing multiple products via a widget. I thought to myself that it would be a great option and surely could not be that difficult. Sadly I was wrong 🙁 I have managed to get the mass action checkboxes and buttons to display on a widget but the JavaScript that goes with it is either not included or not working.

The grid is displayed include mass action options but when I try to use these items I get the following JavaScript error.

Uncaught ReferenceError: options_fieldset1adc562cf047406a634a7c10ae4f7db2_product_idsa765921c1aaf6166ee36c2e83468e0bf_massactionJsObject is not defined

So here is what I have done so far.

Created a app\etc\modules\Manners_Widgets.xml

<?xml version="1.0"?>
<config>
    <modules>
        <Manners_Widgets>
            <active>true</active>
            <codePool>community</codePool>
            <depends>
                <Mage_Adminhtml />
                <Mage_Widget />
            </depends>
        </Manners_Widgets>
    </modules>
</config>

Created a app\code\community\Manners\Widgets\etc\config.xml

<?xml version="1.0"?>
<config>
    <modules>
        <Manners_Widgets>
            <version>1.0.0</version>
        </Manners_Widgets>
    </modules>

    <global>
        <blocks>
            <manners_widgets>
                <class>Manners_Widgets_Block</class>
            </manners_widgets>
            <adminhtml>
                <rewrite>
                    <catalog_product_widget_chooser>Manners_Widgets_Block_Catalog_Product_Widget_Chooser</catalog_product_widget_chooser>
                </rewrite>
            </adminhtml>
        </blocks>

        <helpers>
            <manners_widgets>
                <class>Manners_Widgets_Helper</class>
            </manners_widgets>
        </helpers>
    </global>
</config>

Created a app\code\community\Manners\Widgets\etc\widget.xml

<?xml version="1.0"?>
<widgets>
    <manners_widgets_products type="manners_widgets/products" translate="name description" module="manners_widgets">
        <name>Multiple Products Widget</name>
        <description>Widget to display multiple products on one page</description>
        <parameters>
            <product_ids translate="label">
                <visible>1</visible>
                <required>1</required>
                <label>Product</label>
                <type>label</type>
                <helper_block>
                    <type>manners_widgets/catalog_product_widget_chooser</type>
                    <data>
                        <button translate="open remove">
                            <open>Select Products...</open>
                        </button>
                    </data>
                </helper_block>
            </product_ids>
        </parameters>
    </manners_widgets_products>
</widgets>

Finally I created my block Manners_Widgets_Block_Catalog_Product_Widget_Chooser

<?php
class Manners_Widgets_Block_Catalog_Product_Widget_Chooser extends Mage_Adminhtml_Block_Catalog_Product_Widget_Chooser {
    /**
     *
     * @return Mage_Adminhtml_Block_Widget_Grid|void
     */
    protected function _prepareColumns() {
        $this->addColumn('entity_id', array(
            'header'    => Mage::helper('catalog')->__('ID'),
            'sortable'  => true,
            'width'     => '60px',
            'index'     => 'entity_id'
        ));
        $this->addColumn('chooser_sku', array(
            'header'    => Mage::helper('catalog')->__('SKU'),
            'name'      => 'chooser_sku',
            'width'     => '80px',
            'index'     => 'sku'
        ));
        $this->addColumn('chooser_name', array(
            'header'    => Mage::helper('catalog')->__('Product Name'),
            'name'      => 'chooser_name',
            'index'     => 'name'
        ));
    }

    /**
     * Prepare the massaction
     *  - Block,
     *  - Item
     *
     * @return $this|Mage_Adminhtml_Block_Widget_Grid
     */
    protected function _prepareMassaction() {
        $this->setMassactionIdField('entity_id');
        $this->setMassactionIdFilter('entity_id');
        $this->getMassactionBlock()->setFormFieldName('product');

        $this->getMassactionBlock()->addItem('delete', array(
            'label'=> Mage::helper('catalog')->__('Add Products'),
            'url'  => $this->getUrl('*/*/addProducts')
        ));

        Mage::dispatchEvent('manners_widgets_catalog_product_grid_prepare_massaction', array('block' => $this));
        return $this;
    }

    /**
     * Checkbox Check JS Callback
     *
     * @return string
     */
    public function getCheckboxCheckCallback()
    {
        return "function (grid, element) {
            $(grid.containerId).fire('product:changed', {element: element});
        }";
    }

    /**
     * Grid Row JS Callback
     *
     * @return string
     */
    public function getRowClickCallback()
    {
        $chooserJsObject = $this->getId();
            return '
                function (grid, event) {
                    var trElement = Event.findElement(event, "tr");
                    var productId = trElement.down("td").innerHTML;
                    var productName = trElement.down("td").next().next().innerHTML;
                    var optionLabel = productName;
                    var optionValue = "product/" + productId.replace(/^\s+|\s+$/g,"");
                    if (grid.categoryId) {
                        optionValue += "/" + grid.categoryId;
                    }
                    if (grid.categoryName) {
                        optionLabel = grid.categoryName + " / " + optionLabel;
                    }
                    '.$chooserJsObject.'.setElementValue(optionValue);
                    '.$chooserJsObject.'.setElementLabel(optionLabel);
                    '.$chooserJsObject.'.close();
                }
            ';
    }
}

Original stackoverflow question

https://stackoverflow.com/questions/13493630/how-to-allow-multiple-product-selection-in-magento-widget-configuration

GitHub Repo

https://github.com/dmanners/Manners_Widgets

Best Answer

First, here is why you get that error.
The mass action block button has this onclick event.

$this->getJsObjectName() . ".apply()"

Digging deeper in the methods the code above translates into

{parent_block_id}_massactionJsObject.apply();

(For a widget chooser the parent block id is some random hash but that's not important). The idea is that the object above does not exist.
Now the (possible) solution. Change the mass action block only for your widget chooser. For this create a new class:

<?php 
class Manners_Widgets_Block_Catalog_Product_Massaction extends Mage_Adminhtml_Block_Widget_Grid_Massaction{
    public function getApplyButtonHtml()
    {
        return $this->getButtonHtml($this->__('Submit'), "alert('Doh!')");//add this your js function that should do the magic.
    }
}

Now tell your grid to use this new mass action block. For this add int the class Manners_Widgets_Block_Catalog_Product_Widget_Chooser this method:

protected function _construct(){
    parent::_construct();
    $this->setMassactionBlockName('manners_widgets/catalog_product_massaction');
}

Now when you click on the "submit" button you will get an alert and no errors.
Change the alert in the code above with your actions.

Related Solutions

Magento – Change updated_at date on mass action

Good question. I didn't notice this before.
The updated_at date does not change because the updated_at attribute has a backend model that updates the value Mage_Eav_Model_Entity_Attribute_Backend_Time_Updated. The value gets updated only when you call save on the product, because that's the only time the backend models for the attributes come into play.

There are some events dispatched in the mass update process. I think you have to observe all of them:
This one should be the easiest: catalog_product_attribute_update_before.
It is dispatched in Mage_Catalog_Model_Product_Action::updateAttributes. That method is called when updating the attributes.

The idea is to add the update_at in the attributes update list.
Your observer method could looks like this:

public function beforeUpdateAttributes($observer) 
{
    //the attributes data array is passed by reference
    $attributesData = $observer->getEvent()->getAttributesData();
    //add updated at
    $attributesData['updated_at'] = Varien_Date::now();
}

But now a problem.
If you only change a website or the stock data for the products this event never gets dispatched because Mage_Catalog_Model_Product_Action::updateAttributes does not get called.
Instead you can use these events:
catalog_product_stock_item_mass_change - for stock change.
catalog_product_to_website_change - for website change.
honestly I don't know if you should even update updated_at attribute the product if you change only the stock or a website, because technically you are not changing the product entity. You are just changing some related entities.
But in case you want to change updated_at in this case also, your observer for both of these events could look like this:

public function updateUpdatedAt($observer) 
{
    $productIds = $observer->getEvent()->getProducts();
    Mage::getSingleton('catalog/product_action')->updateAttributes(
        $productIds,
        array('updated_at' => Varien_Date::now()),
        0
    );
}

my code is not perfect. It has an issue. If you change some attributes in mass action AND the stock, the event catalog_product_attribute_update_before would be triggered twice. Once by the Mage_Catalog_Model_Product_Action::updateAttributes method and once by your observer for catalog_product_stock_item_mass_change.
To avoid this you should make your observer as a singleton and remember the product ids you already updated to avoid duplicate sql queries that have the same result.
The code would work even if you update a product twice, but it might be a bit slower.

Magento – ProductController for Mass Action

Try this in your controller:

$productIds = $this->getRequest()->getParam('product');
if (!is_array($productIds)) {
    $this->_getSession()->addError($this->__('Please select product(s).'));
    $this->_redirect('*/*/index');
}

$catId = $this->getRequest()->getParam('Category');
$category = Mage::getModel('catalog/category')->load($catId);

if (!$category->getId()) {
    $this->_getSession()->addError($this->__('Category not found.'));
    $this->_redirect('*/*/index');
}

try {
    foreach($productIds as $productId) {
        $product = Mage::getModel('catalog/product')->load($productId);

        if (!$product->getId()) {
            continue;
        }

        $productCats = $product->getCategoryIds();
        $productCats = array_unique(array_merge($productCats, array($catId)));

        $product->setCategoryIds($productCats)->save();
    }
} catch (Exception $e){
    $this->_getSession()->addError($e->getMessage());
    $this->_redirect('*/*/index');
}

Best Answer

Related Solutions

Magento – Change updated_at date on mass action

Magento – ProductController for Mass Action

Related Topic