Türchen 10: GridMassActionPager (oder: "Macht der eigentlich noch was?!")

Eine häufige Anforderung an Entwickler ist die Implementierung eines Grid im Magento Backend, um Anwendern die Übersicht über bestimmte Daten zu erleichtern und damit zusammenhängende Aktionen bereitzustellen.
Ein repräsentatives Beispiel an dieser Stelle ist ein Produkt-Grid zum Export bestimmter Produkte an einen externen Service.

Wer sich intensiver mit dem Magento Widget Grid befasst hat, wird bereits wissen, dass es die MassAction Erweiterung für das Grid gibt. Diese macht es möglich, beliebig viele Datensätze im Grid zu selektieren und eine zuvor definierte Aktion mit diesen Datensätzen auszuführen. So kann man zunächst bestimmte Produkte über das Grid suchen und die gefundenen Produkte unter Zuhilfenahme der MassAction zum Beispiel mit wenigen Klicks deaktivieren.

Bei ressourcenintensiven Operationen in Kombination mit vielen selektierten Datensätzen kann es vorkommen, dass die ausgeführte Aktion vorzeitig durch den Server abgebrochen wird. Wie und wann sich ein solcher Fehler bemerkbar macht, ist abhängig von der Serverkonfiguration. Auch wenn durch die Konfiguration des Servers ausreichend Ressourcen bereitstellt sind, kann bei sehr langer Ausführungszeit der Eindruck entstehen, dass die ausgeführte Action fehlgeschlagen ist, und man wird dazu verleitet F5 zu drücken oder die Seite zu verlassen.

Um solchen Situationen entgegen zu wirken, haben wir ein kleines Modul entwickelt, das einen MassAction-Request in mehrere Requests mit einer definierten Anzahl an Datensätzen aufteilt. Dabei wird dem Anwender jeweils mitgeteilt, wie viele Datensätze bereits verarbeitet wurden und wie viele noch für die Verarbeitung ausstehen.

Einsatz

Das Modul funktioniert nicht "out of the box" sondern ist eine PHP und JavaScript Methoden-/Funktionssammlung die in einem eigenen Modul Verwendung finden kann.

Am Ende des Artikels findet Ihr einen Link auf das GitHub Repository des Models IntegerNet_GridMassActionPager und einen Link auf das Demo Modul IntegerNet_GridMassActionPagerDemo.

Es sind 3 Schritte nötig, um den GridMassActionPager in die Grid MassAction zu integrieren:

1.) In dem Kontext, in dem der GridMassActionPager eingesetzt werden soll, muss die JavaScript-Datei

gridmassactionpager.js

eingebunden werden.
Dies kann wie gewohnt über eine Layout XML bewerkstelligt werden, oder einfach durch die folgende Helper-Methode in der Grid Controller Action nach der Direktive

$this-&gt;loadLayout();

Mage::helper('integernet_gridmassactionpager')-&gt;addScript();

Gesamtes Beispiel aus dem Demo Modul IntegerNet_GridMassActionPagerDemo:

public function indexAction()
{
    $this->loadLayout();

    Mage::helper('integernet_gridmassactionpager')->addScript();

    $this->_setActiveMenu('integernet_gridmassactionpagerdemo');
    $this->_title($this->__('GridMassActionPager Demo'));

    $this->_addContent($this->getLayout()->createBlock('integernet_gridmassactionpagerdemo/adminhtml_product'));

    $this->renderLayout();
}

2.) Die Grid MassAction muss als ein AJAX Request ausgeführt werden, damit der Pager funktioniert, dazu einfach das Argument use_ajax setzen: $this->getMassactionBlock()->setData('use_ajax', true);

Jede MassAction, die den Pager nutzt, muss die Funktion integerNetGridMassActionPager aus dem Schritt 1) geladenen JavaScript Datei aufrufen. Dazu muss lediglich der Funktionsname integerNetGridMassActionPager dem Argument complete gegeben werden.

Vollständiger Auszug der _prepareMassaction Methode aus dem Demo Modul IntegerNet_GridMassActionPagerDemo:

protected function _prepareMassaction()
{
    $this->setMassactionIdField('entity_id');
    $this->getMassactionBlock()->setData('form_field_name', 'id');
    $this->getMassactionBlock()->setData('use_ajax', true);
    $this->setData('no_filter_massaction_column', true);

    $this->getMassactionBlock()->addItem('export', array(
        'label' => Mage::helper('integernet_gridmassactionpagerdemo')->__('Export'),
        'url' => $this->getUrl('*/*/massExport'),
        'confirm' => Mage::helper('integernet_gridmassactionpagerdemo')->__('Are you sure?'),
        'complete' => 'integerNetGridMassActionPager',
    ));

    return $this;
}

3.) Als letzter Schritt muss noch die eigentliche Controller Action an die Verwendung mit dem Pager angepasst werden. Zunächst ein vollständiger Auszug aus dem Demo Modul IntegerNet_GridMassActionPagerDemo:

public function massExportAction()
{
    /** @var IntegerNet_GridMassActionPager_Model_GridMassActionPager $gridMassActionPager */
    $gridMassActionPager = Mage::getModel('integernet_gridmassactionpager/gridMassActionPager');

    if ($productIds = (array)$this->getRequest()->getParam('id')) {

        $gridMassActionPager->init($productIds, 100);

    } elseif ($pageIds = $gridMassActionPager->getPageIds()) {

        $this->_process($pageIds);

        $gridMassActionPager->next();
    }

    $message = Mage::helper('integernet_gridmassactionpagerdemo')->__('Export product<br />{{from}} to {{to}} of {{of}}');

    $this->getResponse()->setHeader('Content-Type', 'application/json');
    $this->getResponse()->setBody($gridMassActionPager->getStatus(true, $message));
}

In der Action-Methode wird ein Objekt des GridMassActionPager instanziert und bei der Übergabe der Datenreferenzen initiiert. Bei der Initiierung werden die Datenreferenzen in Pages aufgeteilt, die nach und nach verarbeitet werden. Die Größe der Pages wird über das zweite Argument der init Methode definiert (100).
Die Action-Methode wird automatisch so lange durch das eingebundene JavaScript aufgerufen, bis alle Pages verarbeitet wurden. Die eigentliche Verarbeitung der Daten wird im Beispiel durch die Methode _process durchgeführt, alle anderen Direktiven in der Action Methode sind Bestandteil des GridMassActionPager.

Wird nun eine MassAction ausgeführt, erhält der Anwender folgende Ausgabe:

Einsatz

Links