Magento Themes and Magento Extensions

CREATE AND DOWNLOAD XLS REPORT FILE USING MAGENTO’S CORE

Share

Reporting can be a very important part of the Module you might be developing for Mageneto. If you are showing your data in Grid that’s good, but it will be better if you add XLS file generation action on that grid, so that the site administrator can see the report in paper. And if you have in paper you can visualize more clearly than on screen.

I came this condition recently, and found out that Magento has functions to chanage your Grid (in Admin) to XLS files and if you dig more than you can change your data Array to XLS file using Magento’s function.

First let me say you about exporing data from the Admin Grid you have already populated. You need do the following in your grid Block’s _prepareColumn function.

$this->addExportType('router/controller/action', Mage::helper('reports')->__('Excel'));

And in your controller you will have to do this.

/**
* Export grid to Excel XML format in Controller
* @class Mynamespace_Mymodule_Adminhtml_controllerController
*/
public function actionAction()
{
$fileName = 'grid.xls';
/**
* This is the part where Grid Columns and Data are created as Excel XML and returned as stream.
* The implementation of this code is done in the parent class of Grid Mynamespace_Mymodule_Block_Adminhtml_Grid
* And that class should be Mage_Adminhtml_Block_Widget_Grid
*/
$content = $this->getLayout()->createBlock('mymodule_adminhtml/mygrid_grid')
->getExcel($fileName);
/**
* This is for Force Download implemented below
*/
$this->_prepareDownloadResponse($fileName, $content);
}
/**
* Force Download Code block in your controller
* Declare headers and content file in responce for file download
*
* @param string $fileName
* @param string $content set to null to avoid starting output, $contentLength should be set explicitly in that case
* @param string $contentType
* @param int $contentLength explicit content length, if strlen($content) isn't applicable
* @return Mage_Adminhtml_Controller_Action
*/
protected function _prepareDownloadResponse($fileName, $content, $contentType = 'application/octet-stream', $contentLength = null)
{
$session = Mage::getSingleton('admin/session');
if ($session->isFirstPageAfterLogin()) {
$this->_redirect($session->getUser()->getStartupPageUrl());
return $this;
}
$this->getResponse()
->setHttpResponseCode(200)
->setHeader('Pragma', 'public', true)
->setHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0', true)
->setHeader('Content-type', $contentType, true)
->setHeader('Content-Length', is_null($contentLength) ? strlen($content) : $contentLength)
->setHeader('Content-Disposition', 'attachment; filename=' . $fileName)
->setHeader('Last-Modified', date('r'));
if (!is_null($content)) {
$this->getResponse()->setBody($content);
}
return $this;
}

Now you can export your Grid data to XLS sheet. But what about your array you are not displaying in the grid? This should be fun too.. for you now.. because it was not fun for me to find out in the first hand .

Lets take the same controller now.

/**
* Export Array to Excel XML format in Controller
* @class Mynamespace_Mymodule_Adminhtml_controllerController
*/
public function actionAction()
{
$filename = 'array.xls';
$exportData=Mage::getSingleton("adminhtml/session")->getMyData();
/**
* Example Data Format
* $data[0]['product_id']=10
* $data[0]['product_name']=HTC Diamond
* $data[0]['vendor_name']=HTC JMKYZY
* $data[1]['product_id']=11
* $data[1]['product_name']=HTC Ruby
* $data[1]['vendor_name']=HTC JMKYZY
*
*/
// Setting headers columns
$data[0]=array($this->__("Product ID"),$this->__("Product Name"),$this->__("Vendors"));
// Setting Column Data
$i=1;
foreach($exportData as $key=>$value){
$data[$i]=array($value['product_id'],$value['product_name'],$value['vendor_name']);
$i++;
}
// Unparsing in Excel Format
$xmlObj = new Varien_Convert_Parser_Xml_Excel();
$xmlObj->setVar('single_sheet', $filename);
$xmlObj->setData($data);
$xmlObj->unparse();
$content=$xmlObj->getData();
// Force Download
$this->_prepareDownloadResponse($filename,$content);
}

So by comparing the two export controller methods, you can see that the Admin Grid’s Parent already has the functionality to get data from Grid and set that data to Varien_Convert_Parser_Xml_Excel Object and unparse its. As I said we need to dig further to know what going on inside Magento.

Happy Coding.

Leave a Reply

You must be logged in to post a comment.