Mage_Adminhtml_Block_Report_Grid Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Report_Grid:

List of all members.

Public Member Functions
	__construct ()
	setStoreSwitcherVisibility ($visible=true)
	getStoreSwitcherVisibility ()
	getStoreSwitcherHtml ()
	setDateFilterVisibility ($visible=true)
	getDateFilterVisibility ()
	setExportVisibility ($visible=true)
	getExportVisibility ()
	setSubtotalVisibility ($visible=true)
	getSubtotalVisibility ()
	getPeriods ()
	getDateFormat ()
	getRefreshButtonHtml ()
	setFilter ($name, $value)
	getFilter ($name)
	setSubReportSize ($size)
	getSubReportSize ()
	getLocale ()
	addExportType ($url, $label)
	getReport ($from, $to)
	addGrandTotals ($total)
	getGrandTotals ()
	getPeriodText ()
	getCsv ()
	getExcel ($filename= '')
	getSubtotalText ()
	getTotalText ()
	getEmptyText ()
	getCountTotals ()
	getRefreshButtonCallback ()
	getErrors ()
	getCurrentCurrencyCode ()
Protected Member Functions
	_prepareLayout ()
	_prepareColumns ()
	_prepareCollection ()
	_setFilterValues ($data)
Protected Attributes
	$_storeSwitcherVisibility = true
	$_dateFilterVisibility = true
	$_exportVisibility = true
	$_subtotalVisibility = false
	$_filters = array()
	$_defaultFilters
	$_subReportSize = 5
	$_grandTotals
	$_errors = array()
	$_currentCurrencyCode = null

---

Detailed Description

Definition at line 34 of file Grid.php.

---

Constructor & Destructor Documentation

__construct

(

)

Constructor

By default is looking for first argument as array and assignes it as object attributes This behaviour may change in child classes

Reimplemented from Varien_Object.

Reimplemented in Mage_Adminhtml_Block_Report_Customer_Accounts_Grid, Mage_Adminhtml_Block_Report_Customer_Orders_Grid, Mage_Adminhtml_Block_Report_Customer_Totals_Grid, Mage_Adminhtml_Block_Report_Product_Ordered_Grid, Mage_Adminhtml_Block_Report_Product_Sold_Grid, Mage_Adminhtml_Block_Report_Product_Viewed_Grid, Mage_Adminhtml_Block_Report_Sales_Coupons_Grid, Mage_Adminhtml_Block_Report_Sales_Invoiced_Grid, Mage_Adminhtml_Block_Report_Sales_Refunded_Grid, Mage_Adminhtml_Block_Report_Sales_Sales_Grid, Mage_Adminhtml_Block_Report_Sales_Shipping_Grid, and Mage_Adminhtml_Block_Report_Sales_Tax_Grid.

Definition at line 63 of file Grid.php.

    {
        parent::__construct();
        $this->setFilterVisibility(false);
        $this->setPagerVisibility(false);
        $this->setTemplate('report/grid.phtml');
        $this->setUseAjax(false);
        $this->setCountTotals(true);
    }

---

Member Function Documentation

_prepareCollection

(

)

[protected]

Prepare grid collection object

Returns:

this

Validate from and to date

Getting and saving store ids for website & group

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Reimplemented in Mage_Adminhtml_Block_Report_Customer_Accounts_Grid, Mage_Adminhtml_Block_Report_Customer_Orders_Grid, Mage_Adminhtml_Block_Report_Customer_Totals_Grid, Mage_Adminhtml_Block_Report_Product_Ordered_Grid, Mage_Adminhtml_Block_Report_Product_Sold_Grid, Mage_Adminhtml_Block_Report_Product_Viewed_Grid, Mage_Adminhtml_Block_Report_Sales_Coupons_Grid, Mage_Adminhtml_Block_Report_Sales_Invoiced_Grid, Mage_Adminhtml_Block_Report_Sales_Refunded_Grid, Mage_Adminhtml_Block_Report_Sales_Sales_Grid, Mage_Adminhtml_Block_Report_Sales_Shipping_Grid, and Mage_Adminhtml_Block_Report_Sales_Tax_Grid.

Definition at line 103 of file Grid.php.

    {
        $filter = $this->getParam($this->getVarNameFilter(), null);

        if (is_null($filter)) {
            $filter = $this->_defaultFilter;
        }

        if (is_string($filter)) {
            $data = array();
            $filter = base64_decode($filter);
            parse_str(urldecode($filter), $data);

            if (!isset($data['report_from'])) {
                // getting all reports from 2001 year
                $date = new Zend_Date(mktime(0,0,0,1,1,2001));
                $data['report_from'] = $date->toString($this->getLocale()->getDateFormat('short'));
            }

            if (!isset($data['report_to'])) {
                // getting all reports from 2001 year
                $date = new Zend_Date();
                $data['report_to'] = $date->toString($this->getLocale()->getDateFormat('short'));
            }

            $this->_setFilterValues($data);
        } else if ($filter && is_array($filter)) {
            $this->_setFilterValues($filter);
        } else if(0 !== sizeof($this->_defaultFilter)) {
            $this->_setFilterValues($this->_defaultFilter);
        }

        $collection = Mage::getResourceModel('reports/report_collection');

        $collection->setPeriod($this->getFilter('report_period'));

        if ($this->getFilter('report_from') && $this->getFilter('report_to')) {
            /**
             * Validate from and to date
             */
            try {
                $from = $this->getLocale()->date($this->getFilter('report_from'), Zend_Date::DATE_SHORT, null, false);
                $to   = $this->getLocale()->date($this->getFilter('report_to'), Zend_Date::DATE_SHORT, null, false);

                $collection->setInterval($from, $to);
            }
            catch (Exception $e) {
                $this->_errors[] = Mage::helper('reports')->__('Invalid date specified');
            }
        }

        /**
         * Getting and saving store ids for website & group
         */
        if ($this->getRequest()->getParam('store')) {
            $storeIds = array($this->getParam('store'));
        } else if ($this->getRequest()->getParam('website')){
            $storeIds = Mage::app()->getWebsite($this->getRequest()->getParam('website'))->getStoreIds();
        } else if ($this->getRequest()->getParam('group')){
            $storeIds = Mage::app()->getGroup($this->getRequest()->getParam('group'))->getStoreIds();
        } else {
            $storeIds = array('');
        }
        $collection->setStoreIds($storeIds);

        $collection->setPageSize($this->getSubReportSize());

        $this->setCollection($collection);

        Mage::dispatchEvent('adminhtml_widget_grid_filter_collection',
                array('collection' => $this->getCollection(), 'filter_values' => $this->_filterValues)
        );
    }

_prepareColumns

(

)

[protected]

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Reimplemented in Mage_Adminhtml_Block_Report_Customer_Accounts_Grid, Mage_Adminhtml_Block_Report_Customer_Orders_Grid, Mage_Adminhtml_Block_Report_Customer_Totals_Grid, Mage_Adminhtml_Block_Report_Product_Ordered_Grid, Mage_Adminhtml_Block_Report_Product_Sold_Grid, Mage_Adminhtml_Block_Report_Product_Viewed_Grid, Mage_Adminhtml_Block_Report_Sales_Coupons_Grid, Mage_Adminhtml_Block_Report_Sales_Invoiced_Grid, Mage_Adminhtml_Block_Report_Sales_Refunded_Grid, Mage_Adminhtml_Block_Report_Sales_Sales_Grid, Mage_Adminhtml_Block_Report_Sales_Shipping_Grid, and Mage_Adminhtml_Block_Report_Sales_Tax_Grid.

Definition at line 94 of file Grid.php.

    {
        foreach ($this->_columns as $_column) {
            $_column->setSortable(false);
        }

        parent::_prepareColumns();
    }

_prepareLayout

(

)

[protected]

Preparing global layout

You can redefine this method in child classes for changin layout

Returns:

Mage_Core_Block_Abstract

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 73 of file Grid.php.

    {
        $this->setChild('store_switcher',
            $this->getLayout()->createBlock('adminhtml/store_switcher')
                ->setUseConfirm(false)
                ->setSwitchUrl($this->getUrl('*/*/*', array('store'=>null)))
                ->setTemplate('report/store/switcher.phtml')
        );

        $this->setChild('refresh_button',
            $this->getLayout()->createBlock('adminhtml/widget_button')
                ->setData(array(
                    'label'     => Mage::helper('adminhtml')->__('Refresh'),
                    'onclick'   => $this->getRefreshButtonCallback(),
                    'class'   => 'task'
                ))
        );
        parent::_prepareLayout();
        return $this;
    }

_setFilterValues

(

$

data

)

[protected]

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 177 of file Grid.php.

    {
        foreach ($data as $name => $value) {
            //if (isset($data[$name])) {
                $this->setFilter($name, $data[$name]);
            //}
        }
        return $this;
    }

addExportType	(	$	url,
		$	label
	)

Add new export type to grid

Parameters:

	string	$url
	string	$label

Returns:

Mage_Adminhtml_Block_Widget_Grid

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 341 of file Grid.php.

    {
        $this->_exportTypes[] = new Varien_Object(
            array(
                'url'   => $this->getUrl($url,
                    array(
                        '_current'=>true,
                        'filter' => $this->getParam($this->getVarNameFilter(), null)
                        )
                    ),
                'label' => $label
            )
        );
        return $this;
    }

addGrandTotals

(

$

total

)

Definition at line 371 of file Grid.php.

    {
        $totalData = $total->getData();
        foreach ($totalData as $key=>$value) {
            $_column = $this->getColumn($key);
            if ($_column->getTotal() != '') {
                $this->getGrandTotals()->setData($key, $this->getGrandTotals()->getData($key)+$value);
            }
        }
        /*
         * recalc totals if we have average
         */
        foreach ($this->getColumns() as $key=>$_column) {
            if (strpos($_column->getTotal(), '/') !== FALSE) {
                list($t1, $t2) = explode('/', $_column->getTotal());
                if ($this->getGrandTotals()->getData($t2) != 0) {
                    $this->getGrandTotals()->setData(
                        $key,
                        (float)$this->getGrandTotals()->getData($t1)/$this->getGrandTotals()->getData($t2)
                    );
                }
            }
        }
    }

getCountTotals

(

)

Return count totals

Returns:

boolean

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 543 of file Grid.php.

    {
        $totals = $this->getGrandTotals()->getData();
        if (parent::getCountTotals() && count($totals)) {
            return true;
        } else {
            return false;
        }
    }

getCsv

(

)

Retrieve grid as CSV

Returns:

unknown

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 414 of file Grid.php.

    {
        $csv = '';
        $this->_prepareGrid();

        $data = array('"'.$this->__('Period').'"');
        foreach ($this->_columns as $column) {
            if (!$column->getIsSystem()) {
                $data[] = '"'.$column->getHeader().'"';
            }
        }
        $csv.= implode(',', $data)."\n";

        foreach ($this->getCollection()->getIntervals() as $_index=>$_item) {
            $report = $this->getReport($_item['start'], $_item['end']);
            foreach ($report as $_subIndex=>$_subItem) {
                $data = array('"'.$_index.'"');
                foreach ($this->_columns as $column) {
                    if (!$column->getIsSystem()) {
                        $data[] = '"'.str_replace(array('"', '\\'), array('""', '\\\\'), $column->getRowField($_subItem)).'"';
                    }
                }
                $csv.= implode(',', $data)."\n";
            }
            if ($this->getCountTotals() && $this->getSubtotalVisibility())
            {
                $data = array('"'.$_index.'"');
                $j = 0;
                foreach ($this->_columns as $column) {
                    $j++;
                    if (!$column->getIsSystem()) {
                        $data[] = ($j==1)?'"'.$this->__('Subtotal').'"':'"'.str_replace('"', '""', $column->getRowField($this->getTotals())).'"';
                    }
                }
                $csv.= implode(',', $data)."\n";
            }
        }

        if ($this->getCountTotals())
        {
            $data = array('"'.$this->__('Total').'"');
            foreach ($this->_columns as $column) {
                if (!$column->getIsSystem()) {
                    $data[] = '"'.str_replace('"', '""', $column->getRowField($this->getGrandTotals())).'"';
                }
            }
            $csv.= implode(',', $data)."\n";
        }

        return $csv;
    }

getCurrentCurrencyCode

(

)

Retrieve correct currency code for select website, store, group

Returns:

string

Definition at line 579 of file Grid.php.

    {
        if (is_null($this->_currentCurrencyCode)) {
            if ($this->getRequest()->getParam('store')) {
                $this->_currentCurrencyCode = Mage::app()->getStore($this->getRequest()->getParam('store'))->getBaseCurrencyCode();
            } else if ($this->getRequest()->getParam('website')){
                $this->_currentCurrencyCode = Mage::app()->getWebsite($this->getRequest()->getParam('website'))->getBaseCurrencyCode();
            } else if ($this->getRequest()->getParam('group')){
                $this->_currentCurrencyCode =  Mage::app()->getGroup($this->getRequest()->getParam('group'))->getWebsite()->getBaseCurrencyCode();
            } else {
                $this->_currentCurrencyCode = Mage::app()->getStore()->getBaseCurrencyCode();
            }
        }
        return $this->_currentCurrencyCode;
    }

getDateFilterVisibility

(

)

Return visibility of date filter

Returns:

boolean

Definition at line 232 of file Grid.php.

    {
        return $this->_dateFilterVisibility;
    }

getDateFormat

(

)

Definition at line 282 of file Grid.php.

    {
        return $this->getLocale()->getDateStrFormat(Mage_Core_Model_Locale::FORMAT_TYPE_SHORT);
    }

getEmptyText

(

)

Return empty text for grid

Returns:

string

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 538 of file Grid.php.

    {
        return $this->__('No records found for this period.');
    }

getErrors

(

)

Retrieve errors

Returns:

array

Definition at line 569 of file Grid.php.

    {
        return $this->_errors;
    }

getExcel

(

$

filename = ''

)

Retrieve grid as Excel Xml

Returns:

unknown

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 471 of file Grid.php.

    {
        $this->_prepareGrid();

        $data = array();
        $row = array($this->__('Period'));
        foreach ($this->_columns as $column) {
            if (!$column->getIsSystem()) {
                $row[] = $column->getHeader();
            }
        }
        $data[] = $row;

        foreach ($this->getCollection()->getIntervals() as $_index=>$_item) {
            $report = $this->getReport($_item['start'], $_item['end']);
            foreach ($report as $_subIndex=>$_subItem) {
                $row = array($_index);
                foreach ($this->_columns as $column) {
                    if (!$column->getIsSystem()) {
                        $row[] = $column->getRowField($_subItem);
                    }
                }
                $data[] = $row;
            }
            if ($this->getCountTotals() && $this->getSubtotalVisibility())
            {
                $row = array($_index);
                $j = 0;
                foreach ($this->_columns as $column) {
                    $j++;
                    if (!$column->getIsSystem()) {
                        $row[] = ($j==1)?$this->__('Subtotal'):$column->getRowField($this->getTotals());
                    }
                }
                $data[] = $row;
            }
        }

        if ($this->getCountTotals())
        {
            $row = array($this->__('Total'));
            foreach ($this->_columns as $column) {
                if (!$column->getIsSystem()) {
                    $row[] = $column->getRowField($this->getGrandTotals());
                }
            }
            $data[] = $row;
        }

        $xmlObj = new Varien_Convert_Parser_Xml_Excel();
        $xmlObj->setVar('single_sheet', $filename);
        $xmlObj->setData($data);
        $xmlObj->unparse();

        return $xmlObj->getData();
    }

getExportVisibility

(

)

Return visibility of export action

Returns:

boolean

Definition at line 252 of file Grid.php.

    {
        return $this->_exportVisibility;
    }

getFilter

(

$

name

)

Definition at line 302 of file Grid.php.

    {
        if (isset($this->_filters[$name])) {
            return $this->_filters[$name];
        } else {
            return '';
        }
    }

getGrandTotals

(

)

Definition at line 396 of file Grid.php.

    {
        if (!$this->_grandTotals) {
            $this->_grandTotals = new Varien_Object();
        }
        return $this->_grandTotals;
    }

getLocale

(

)

Retrieve locale

Returns:

Mage_Core_Model_Locale

Definition at line 326 of file Grid.php.

    {
        if (!$this->_locale) {
            $this->_locale = Mage::app()->getLocale();
        }
        return $this->_locale;
    }

getPeriods

(

)

Definition at line 277 of file Grid.php.

    {
        return $this->getCollection()->getPeriods();
    }

getPeriodText

(

)

Definition at line 404 of file Grid.php.

    {
        return $this->__('Period');
    }

getRefreshButtonCallback

(

)

onlick event for refresh button to show alert if fields are empty

Returns:

string

Definition at line 558 of file Grid.php.

    {
        return "{$this->getJsObjectName()}.doFilter();";
        return "if ($('period_date_to').value == '' && $('period_date_from').value == '') {alert('".$this->__('Please specify at least start or end date.')."'); return false;}else {$this->getJsObjectName()}.doFilter();";
    }

getRefreshButtonHtml

(

)

Return refresh button html

Definition at line 290 of file Grid.php.

    {
        return $this->getChildHtml('refresh_button');
    }

getReport	(	$	from,
		$	to
	)

Definition at line 357 of file Grid.php.

    {
        if ($from == '') {
            $from = $this->getFilter('report_from');
        }
        if ($to == '') {
            $to = $this->getFilter('report_to');
        }
        $totalObj = new Mage_Reports_Model_Totals();
        $this->setTotals($totalObj->countTotals($this, $from, $to));
        $this->addGrandTotals($this->getTotals());
        return $this->getCollection()->getReport($from, $to);
    }

getStoreSwitcherHtml

(

)

Return store switcher html

Returns:

string

Definition at line 212 of file Grid.php.

    {
        return $this->getChildHtml('store_switcher');
    }

getStoreSwitcherVisibility

(

)

Return visibility of store switcher

Returns:

boolean

Definition at line 202 of file Grid.php.

    {
        return $this->_storeSwitcherVisibility;
    }

getSubReportSize

(

)

Definition at line 316 of file Grid.php.

    {
        return $this->_subReportSize;
    }

getSubtotalText

(

)

Definition at line 528 of file Grid.php.

    {
        return $this->__('Subtotal');
    }

getSubtotalVisibility

(

)

Return visibility of subtotals

Returns:

boolean

Definition at line 272 of file Grid.php.

    {
        return $this->_subtotalVisibility;
    }

getTotalText

(

)

Definition at line 533 of file Grid.php.

    {
        return $this->__('Total');
    }

setDateFilterVisibility

(

$

visible = true

)

Set visibility of date filter

Parameters:

boolean

$visible

Definition at line 222 of file Grid.php.

    {
        $this->_dateFilterVisibility = $visible;
    }

setExportVisibility

(

$

visible = true

)

Set visibility of export action

Parameters:

boolean

$visible

Definition at line 242 of file Grid.php.

    {
        $this->_exportVisibility = $visible;
    }

setFilter	(	$	name,
		$	value
	)

Definition at line 295 of file Grid.php.

    {
        if ($name) {
            $this->_filters[$name] = $value;
        }
    }

setStoreSwitcherVisibility

(

$

visible = true

)

Set visibility of store switcher

Parameters:

boolean

$visible

Definition at line 192 of file Grid.php.

    {
        $this->_storeSwitcherVisibility = $visible;
    }

setSubReportSize

(

$

size

)

Definition at line 311 of file Grid.php.

    {
        $this->_subReportSize = $size;
    }

setSubtotalVisibility

(

$

visible = true

)

Set visibility of subtotals

Parameters:

boolean

$visible

Definition at line 262 of file Grid.php.

    {
        $this->_subtotalVisibility = $visible;
    }

---

Member Data Documentation

$_currentCurrencyCode = null [protected]

stores current currency code

Definition at line 61 of file Grid.php.

$_dateFilterVisibility = true [protected]

Definition at line 38 of file Grid.php.

$_defaultFilters [protected]

Initial value:

 array(
            'report_from' => '',
            'report_to' => '',
            'report_period' => 'day'
        )

Definition at line 46 of file Grid.php.

$_errors = array() [protected]

Definition at line 56 of file Grid.php.

$_exportVisibility = true [protected]

Definition at line 40 of file Grid.php.

$_filters = array() [protected]

Definition at line 44 of file Grid.php.

$_grandTotals [protected]

Definition at line 54 of file Grid.php.

$_storeSwitcherVisibility = true [protected]

Definition at line 36 of file Grid.php.

$_subReportSize = 5 [protected]

Reimplemented in Mage_Adminhtml_Block_Report_Product_Sold_Grid.

Definition at line 52 of file Grid.php.

$_subtotalVisibility = false [protected]

Definition at line 42 of file Grid.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Adminhtml/Block/Report/Grid.php