Class Mage_Adminhtml_Block_Report_Grid

Adminhtml report grid block

Varien_Object

Mage_Core_Block_Abstract

Mage_Core_Block_Template

Mage_Adminhtml_Block_Template

Mage_Adminhtml_Block_Widget

Mage_Adminhtml_Block_Widget_Grid

Mage_Adminhtml_Block_Report_Grid

Direct known subclasses

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_Sold_Grid

Package: Mage\Adminhtml
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Adminhtml/Block/Report/Grid.php

Methods summary
`public`	# `__construct( )` Overrides `Mage_Adminhtml_Block_Widget_Grid::__construct()`
`protected Mage_Core_Block_Abstract`	# `_prepareLayout( )` Preparing global layout Preparing global layout You can redefine this method in child classes for changing layout Returns `Mage_Core_Block_Abstract` Overrides `Mage_Adminhtml_Block_Widget_Grid::_prepareLayout()`
`protected`	# `_prepareColumns( )` Overrides `Mage_Adminhtml_Block_Widget_Grid::_prepareColumns()`
`protected this`	# `_prepareCollection( )` Prepare grid collection object Prepare grid collection object Returns `this` Overrides `Mage_Adminhtml_Block_Widget_Grid::_prepareCollection()`
`protected`	# `_setFilterValues( mixed $data )` Overrides `Mage_Adminhtml_Block_Widget_Grid::_setFilterValues()`
`public`	# `setStoreSwitcherVisibility( boolean $visible = true )` Set visibility of store switcher Set visibility of store switcher Parameters `$visible` `boolean` $visible
`public boolean`	# `getStoreSwitcherVisibility( )` Return visibility of store switcher Return visibility of store switcher Returns `boolean`
`public string`	# `getStoreSwitcherHtml( )` Return store switcher html Return store switcher html Returns `string`
`public`	# `setDateFilterVisibility( boolean $visible = true )` Set visibility of date filter Set visibility of date filter Parameters `$visible` `boolean` $visible
`public boolean`	# `getDateFilterVisibility( )` Return visibility of date filter Return visibility of date filter Returns `boolean`
`public`	# `setExportVisibility( boolean $visible = true )` Set visibility of export action Set visibility of export action Parameters `$visible` `boolean` $visible
`public boolean`	# `getExportVisibility( )` Return visibility of export action Return visibility of export action Returns `boolean`
`public`	# `setSubtotalVisibility( boolean $visible = true )` Set visibility of subtotals Set visibility of subtotals Parameters `$visible` `boolean` $visible
`public boolean`	# `getSubtotalVisibility( )` Return visibility of subtotals Return visibility of subtotals Returns `boolean`
`public`	# `getPeriods( )`
`public`	# `getDateFormat( )`
`public`	# `getRefreshButtonHtml( )` Return refresh button html Return refresh button html
`public`	# `setFilter( mixed $name, mixed $value )`
`public`	# `getFilter( mixed $name )`
`public`	# `setSubReportSize( mixed $size )`
`public`	# `getSubReportSize( )`
`public Mage_Core_Model_Locale`	# `getLocale( )` Retrieve locale Retrieve locale Returns `Mage_Core_Model_Locale`
`public Mage_Adminhtml_Block_Widget_Grid`	# `addExportType( string $url, string $label )` Add new export type to grid Add new export type to grid Parameters `$url` `string` $url `$label` `string` $label Returns `Mage_Adminhtml_Block_Widget_Grid` Overrides `Mage_Adminhtml_Block_Widget_Grid::addExportType()`
`public`	# `getReport( mixed $from, mixed $to )`
`public`	# `addGrandTotals( mixed $total )`
`public`	# `getGrandTotals( )`
`public`	# `getPeriodText( )`
`public unknown`	# `getCsv( )` Retrieve grid as CSV Retrieve grid as CSV Returns `unknown` Overrides `Mage_Adminhtml_Block_Widget_Grid::getCsv()`
`public unknown`	# `getExcel( string $filename = '' )` Retrieve grid as Excel Xml Retrieve grid as Excel Xml Parameters `$filename` `string` $filename the Workbook sheet name Returns `unknown` Overrides `Mage_Adminhtml_Block_Widget_Grid::getExcel()`
`public`	# `getSubtotalText( )`
`public`	# `getTotalText( )`
`public string`	# `getEmptyText( )` Return empty text for grid Return empty text for grid Returns `string` Overrides `Mage_Adminhtml_Block_Widget_Grid::getEmptyText()`
`public boolean`	# `getCountTotals( )` Return count totals Return count totals Returns `boolean` Overrides `Mage_Adminhtml_Block_Widget_Grid::getCountTotals()`
`public string`	# `getRefreshButtonCallback( )` onlick event for refresh button to show alert if fields are empty onlick event for refresh button to show alert if fields are empty Returns `string`
`public array`	# `getErrors( )` Retrieve errors Retrieve errors Returns `array`
`public string`	# `getCurrentCurrencyCode( )` Retrieve correct currency code for select website, store, group Retrieve correct currency code for select website, store, group Returns `string`
`public float`	# `getRate( string\|Mage_Directory_Model_Currency $toCurrency )` Get currency rate (base to given currency) Get currency rate (base to given currency) Parameters `$toCurrency` `string\|Mage_Directory_Model_Currency` $currencyCode Returns `float`

Methods inherited from Mage_Adminhtml_Block_Widget_Grid
_addColumnFilterToCollection(), _afterLoadCollection(), _beforeToHtml(), _decodeFilter(), _exportCsvItem(), _exportExcelItem(), _exportIterateCollection(), _getExportHeaders(), _getExportTotals(), _getFileContainerContent(), _getRssUrl(), _prepareGrid(), _prepareMassaction(), _prepareMassactionBlock(), _prepareMassactionColumn(), _preparePage(), _setCollectionOrder(), addColumn(), addColumnAfter(), addColumnsOrder(), addRssList(), canDisplayContainer(), getAbsoluteGridUrl(), getCollection(), getColumn(), getColumnCount(), getColumns(), getColumnsOrder(), getCountSubTotals(), getCsvFile(), getEmptyCellColspan(), getEmptyCellLabel(), getEmptyTextClass(), getExcelFile(), getExportButtonHtml(), getExportTypes(), getFilterVisibility(), getHeadersVisibility(), getHtml(), getJsObjectName(), getLastColumnId(), getMainButtonsHtml(), getMassactionBlock(), getMassactionBlockHtml(), getMassactionBlockName(), getMassactionIdField(), getMassactionIdFilter(), getMessageBlockVisibility(), getMultipleRowColumns(), getMultipleRows(), getPagerVisibility(), getParam(), getResetFilterButtonHtml(), getRowId(), getRowUrl(), getRowspan(), getRssLists(), getSearchButtonHtml(), getSubTotalColumns(), getSubTotalItem(), getSubTotals(), getTotals(), getVarNameDir(), getVarNameFilter(), getVarNameLimit(), getVarNamePage(), getVarNameSort(), getXml(), isColumnGrouped(), removeColumn(), setCollection(), setCountSubTotals(), setCountTotals(), setDefaultDir(), setDefaultFilter(), setDefaultLimit(), setDefaultPage(), setDefaultSort(), setEmptyCellLabel(), setEmptyText(), setEmptyTextClass(), setFilterVisibility(), setHeadersVisibility(), setMassactionBlockName(), setMassactionIdField(), setMassactionIdFilter(), setMessageBlockVisibility(), setPagerVisibility(), setSaveParametersInSession(), setSubTotals(), setTotals(), setVarNameDir(), setVarNameFilter(), setVarNameLimit(), setVarNamePage(), setVarNameSort(), shouldRenderCell(), shouldRenderEmptyCell(), shouldRenderSubTotal(), sortColumnsByOrder()

Methods inherited from Mage_Adminhtml_Block_Widget
`_addBreadcrumb(), getButtonHtml(), getCurrentUrl(), getGlobalIcon(), getHtmlId(), getId()`

Methods inherited from Mage_Adminhtml_Block_Template
`_getUrlModelClass(), _toHtml(), getFormKey(), isOutputEnabled()`

Methods inherited from Mage_Core_Block_Template
`_construct(), _getAllowSymlinks(), assign(), fetchView(), getArea(), getBaseUrl(), getCacheKeyInfo(), getDirectOutput(), getJsUrl(), getObjectData(), getShowTemplateHints(), getTemplate(), getTemplateFile(), renderView(), setScriptPath(), setTemplate()`

Methods inherited from Mage_Core_Block_Abstract
__(), _afterCacheUrl(), _afterToHtml(), _beforeCacheUrl(), _beforeChildToHtml(), _getChildHtml(), _getSidPlaceholder(), _getUrlModel(), _loadCache(), _saveCache(), addToChildGroup(), addToParentGroup(), append(), countChildren(), escapeHtml(), escapeUrl(), formatDate(), formatTime(), getAction(), getAnonSuffix(), getBlockAlias(), getBlockHtml(), getCacheKey(), getCacheLifetime(), getCacheTags(), getChild(), getChildChildHtml(), getChildData(), getChildGroup(), getChildHtml(), getHelper(), getIsAnonymous(), getLayout(), getMessagesBlock(), getModuleName(), getNameInLayout(), getParentBlock(), getRequest(), getSkinUrl(), getSortedChildBlocks(), getSortedChildren(), getUrl(), getUrlBase64(), getUrlEncoded(), helper(), insert(), jsQuoteEscape(), setAnonSuffix(), setAttribute(), setBlockAlias(), setChild(), setFrameTags(), setIsAnonymous(), setLayout(), setMessagesBlock(), setNameInLayout(), setParentBlock(), sortChildren(), stripTags(), toHtml(), unsetCallChild(), unsetChild(), unsetChildren()

Constants inherited from Mage_Core_Block_Template
`XML_PATH_DEBUG_TEMPLATE_HINTS, XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS, XML_PATH_TEMPLATE_ALLOW_SYMLINK`

Constants inherited from Mage_Core_Block_Abstract
`CACHE_GROUP`

Properties summary
`protected boolean`	`$_storeSwitcherVisibility`	`true`	#
`protected boolean`	`$_dateFilterVisibility`	`true`	#
`protected boolean`	`$_exportVisibility`	`true`	#
`protected boolean`	`$_subtotalVisibility`	`false`	#
`protected array`	`$_filters`	`array()`	#
`protected array`	`$_defaultFilters`	`array( 'report_from' => '', 'report_to' => '', 'report_period' => 'day' )`	#
`protected integer`	`$_subReportSize`	`5`	#
`protected mixed`	`$_grandTotals`		#
`protected array`	`$_errors`	`array()`	#
`protected mixed`	`$_currentCurrencyCode`	`null`	# stores current currency code stores current currency code

Properties inherited from Mage_Adminhtml_Block_Widget_Grid
$_collection, $_columns, $_columnsOrder, $_countSubTotals, $_countTotals, $_defaultDir, $_defaultFilter, $_defaultLimit, $_defaultPage, $_defaultSort, $_emptyCellLabel, $_emptyText, $_emptyTextCss, $_exportPageSize, $_exportTypes, $_filterVisibility, $_groupedColumn, $_headersVisibility, $_isExport, $_lastColumnId, $_massactionBlockName, $_massactionIdField, $_massactionIdFilter, $_messageBlockVisibility, $_pagerVisibility, $_rssLists, $_saveParametersInSession, $_subtotals, $_varNameDir, $_varNameFilter, $_varNameLimit, $_varNamePage, $_varNameSort, $_varTotals

Properties inherited from Mage_Core_Block_Template
`$_allowSymlinks, $_baseUrl, $_jsUrl, $_showTemplateHints, $_showTemplateHintsBlocks, $_template, $_viewDir, $_viewVars`

Properties inherited from Mage_Core_Block_Abstract
`$_alias, $_anonSuffix, $_childGroups, $_children, $_childrenHtmlCache, $_frameCloseTag, $_frameOpenTag, $_isAnonymous, $_layout, $_messagesBlock, $_nameInLayout, $_parent, $_parentBlock, $_request, $_sortInstructions, $_sortedChildren, $_urlModel`

Packages

Classes

Interfaces

Exceptions

Class Mage_Adminhtml_Block_Report_Grid

Direct known subclasses

Overrides

Returns

Overrides

Overrides

Returns

Overrides

Overrides

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Returns

Overrides

Returns

Returns

Returns

Parameters

Returns