Class Mage_Adminhtml_Block_Report_Grid_Abstract

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@magentocommerce.com so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

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_Abstract

Direct known subclasses

Mage_Adminhtml_Block_Report_Product_Viewed_Grid, Mage_Adminhtml_Block_Report_Sales_Bestsellers_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, Mage_Adminhtml_Block_Report_Sales_Tax_Grid

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

Methods summary
`public`	# `__construct( )` Overrides `Mage_Adminhtml_Block_Widget_Grid::__construct()`
`public`	# `getResourceCollectionName( )`
`public Varien_Data_Collection`	# `getCollection( )` get collection object get collection object Returns `Varien_Data_Collection` Overrides `Mage_Adminhtml_Block_Widget_Grid::getCollection()`
`protected`	# `_getAggregatedColumns( )`
`public Mage_Adminhtml_Block_Report_Grid_Abstract`	# `addColumn( string $columnId, array $column )` Add column to grid Overriden to add support for visibility_filter column option It stands for conditional visibility of the column depending on filter field values Value of visibility_filter supports (filter_field_name => filter_field_value) pairs Add column to grid Overriden to add support for visibility_filter column option It stands for conditional visibility of the column depending on filter field values Value of visibility_filter supports (filter_field_name => filter_field_value) pairs Parameters `$columnId` `string` $columnId `$column` `array` $column Returns `Mage_Adminhtml_Block_Report_Grid_Abstract` Overrides `Mage_Adminhtml_Block_Widget_Grid::addColumn()`
`protected array`	# `_getStoreIds( )` Get allowed store ids array intersected with selected scope in store switcher Get allowed store ids array intersected with selected scope in store switcher Returns `array`
`protected this`	# `_prepareCollection( )` Prepare grid collection object Prepare grid collection object Returns `this` Overrides `Mage_Adminhtml_Block_Widget_Grid::_prepareCollection()`
`public boolean`	# `getCountTotals( )` Return count totals Return count totals Returns `boolean` Overrides `Mage_Adminhtml_Block_Widget_Grid::getCountTotals()`
`public array`	# `getSubTotals( )` Retrieve subtotal items Retrieve subtotal items Returns `array` Overrides `Mage_Adminhtml_Block_Widget_Grid::getSubTotals()`
`public`	# `setStoreIds( mixed $storeIds )`
`public`	# `getCurrentCurrencyCode( )`
`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`
`protected Mage_Adminhtml_Block_Report_Grid_Abstract`	# `_addOrderStatusFilter( Mage_Reports_Model_Resource_Report_Collection_Abstract $collection, Varien_Object $filterData )` Add order status filter Add order status filter Parameters `$collection` `Mage_Reports_Model_Resource_Report_Collection_Abstract` $collection `$filterData` `Varien_Object` $filterData Returns `Mage_Adminhtml_Block_Report_Grid_Abstract`
`protected Mage_Adminhtml_Block_Report_Grid_Abstract`	# `_addCustomFilter( Mage_Reports_Model_Resource_Report_Collection_Abstract $collection, Varien_Object $filterData )` Adds custom filter to resource collection Can be overridden in child classes if custom filter needed Adds custom filter to resource collection Can be overridden in child classes if custom filter needed Parameters `$collection` `Mage_Reports_Model_Resource_Report_Collection_Abstract` $collection `$filterData` `Varien_Object` $filterData Returns `Mage_Adminhtml_Block_Report_Grid_Abstract`

Methods inherited from Mage_Adminhtml_Block_Widget_Grid
_addColumnFilterToCollection(), _afterLoadCollection(), _beforeToHtml(), _decodeFilter(), _exportCsvItem(), _exportExcelItem(), _exportIterateCollection(), _getExportHeaders(), _getExportTotals(), _getFileContainerContent(), _getRssUrl(), _prepareColumns(), _prepareGrid(), _prepareLayout(), _prepareMassaction(), _prepareMassactionBlock(), _prepareMassactionColumn(), _preparePage(), _setCollectionOrder(), _setFilterValues(), addColumnAfter(), addColumnsOrder(), addExportType(), addRssList(), canDisplayContainer(), getAbsoluteGridUrl(), getColumn(), getColumnCount(), getColumns(), getColumnsOrder(), getCountSubTotals(), getCsv(), getCsvFile(), getEmptyCellColspan(), getEmptyCellLabel(), getEmptyText(), getEmptyTextClass(), getExcel(), 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(), 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 string`	`$_resourceCollectionName`	`''`	#
`protected mixed`	`$_currentCurrencyCode`	`null`	#
`protected array`	`$_storeIds`	`array()`	#
`protected mixed`	`$_aggregatedColumns`	`null`	#

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_Abstract

Direct known subclasses

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Returns

Returns

Overrides

Returns

Overrides

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns