Class Mage_Adminhtml_Block_Widget_Grid

Adminhtml grid widget block

Varien_Object

Mage_Core_Block_Abstract

Mage_Core_Block_Template

Mage_Adminhtml_Block_Template

Mage_Adminhtml_Block_Widget

Mage_Adminhtml_Block_Widget_Grid

Direct known subclasses

Indirect known subclasses

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/Widget/Grid.php

Methods summary
`public`	# `__construct( mixed $attributes = array() )`
`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_Core_Block_Abstract::_prepareLayout()`
`public`	# `getExportButtonHtml( )`
`public`	# `getResetFilterButtonHtml( )`
`public`	# `getSearchButtonHtml( )`
`public`	# `getMainButtonsHtml( )`
`public`	# `setCollection( mixed $collection )`
`public Varien_Data_Collection`	# `getCollection( )` get collection object get collection object Returns `Varien_Data_Collection`
`public Mage_Adminhtml_Block_Widget_Grid`	# `addColumn( string $columnId, array $column )` Add column to grid Add column to grid Parameters `$columnId` `string` $columnId `$column` `array` \|\| Varien_Object $column Returns `Mage_Adminhtml_Block_Widget_Grid`
`public Mage_Adminhtml_Block_Widget_Grid`	# `removeColumn( string $columnId )` Remove existing column Remove existing column Parameters `$columnId` `string` $columnId Returns `Mage_Adminhtml_Block_Widget_Grid`
`public Mage_Adminhtml_Block_Widget_Grid`	# `addColumnAfter( string $columnId, array\|Varien_Object $column, string $after )` Add column to grid after specified column. Add column to grid after specified column. Parameters `$columnId` `string` $columnId `$column` `array\|Varien_Object` $column `$after` `string` $after Returns `Mage_Adminhtml_Block_Widget_Grid`
`public Mage_Adminhtml_Block_Widget_Grid`	# `addColumnsOrder( string $columnId, string $after )` Add column view order Add column view order Parameters `$columnId` `string` $columnId `$after` `string` $after Returns `Mage_Adminhtml_Block_Widget_Grid`
`public array`	# `getColumnsOrder( )` Retrieve columns order Retrieve columns order Returns `array`
`public Mage_Adminhtml_Block_Widget_Grid`	# `sortColumnsByOrder( )` Sort columns by predefined order Sort columns by predefined order Returns `Mage_Adminhtml_Block_Widget_Grid`
`public`	# `getLastColumnId( )`
`public`	# `getColumnCount( )`
`public Varien_Object`	# `getColumn( string $columnId )` Retrieve grid column by column id Retrieve grid column by column id Parameters `$columnId` `string` $columnId Returns `Varien_Object` \|\| false
`public array`	# `getColumns( )` Retrieve all grid columns Retrieve all grid columns Returns `array`
`protected`	# `_setFilterValues( mixed $data )`
`protected`	# `_addColumnFilterToCollection( mixed $column )`
`protected Mage_Adminhtml_Block_Widget_Grid`	# `_setCollectionOrder( Mage_Adminhtml_Block_Widget_Grid_Column $column )` Sets sorting order by some column Sets sorting order by some column Parameters `$column` `Mage_Adminhtml_Block_Widget_Grid_Column` $column Returns `Mage_Adminhtml_Block_Widget_Grid`
`protected this`	# `_prepareCollection( )` Prepare grid collection object Prepare grid collection object Returns `this`
`protected`	# `_decodeFilter( mixed & $value )` Decode URL encoded filter value recursive callback method Decode URL encoded filter value recursive callback method Var string $value
`protected`	# `_preparePage( )`
`protected`	# `_prepareColumns( )`
`protected Mage_Adminhtml_Block_Widget_Grid`	# `_prepareMassactionBlock( )` Prepare grid massaction block Prepare grid massaction block Returns `Mage_Adminhtml_Block_Widget_Grid`
`protected Mage_Adminhtml_Block_Widget_Grid`	# `_prepareMassaction( )` Prepare grid massaction actions Prepare grid massaction actions Returns `Mage_Adminhtml_Block_Widget_Grid`
`protected unknown`	# `_prepareMassactionColumn( )` Prepare grid massaction column Prepare grid massaction column Returns `unknown`
`protected`	# `_prepareGrid( )`
`protected Mage_Core_Block_Abstract`	# `_beforeToHtml( )` Before rendering html, but after trying to load cache Before rendering html, but after trying to load cache Returns `Mage_Core_Block_Abstract` Overrides `Mage_Core_Block_Abstract::_beforeToHtml()`
`protected`	# `_afterLoadCollection( )`
`public`	# `getVarNameLimit( )`
`public`	# `getVarNamePage( )`
`public`	# `getVarNameSort( )`
`public`	# `getVarNameDir( )`
`public`	# `getVarNameFilter( )`
`public`	# `setVarNameLimit( mixed $name )`
`public`	# `setVarNamePage( mixed $name )`
`public`	# `setVarNameSort( mixed $name )`
`public`	# `setVarNameDir( mixed $name )`
`public`	# `setVarNameFilter( mixed $name )`
`public`	# `setHeadersVisibility( boolean $visible = true )` Set visibility of column headers Set visibility of column headers Parameters `$visible` `boolean` $visible
`public boolean`	# `getHeadersVisibility( )` Return visibility of column headers Return visibility of column headers Returns `boolean`
`public`	# `setPagerVisibility( boolean $visible = true )` Set visibility of pager Set visibility of pager Parameters `$visible` `boolean` $visible
`public boolean`	# `getPagerVisibility( )` Return visibility of pager Return visibility of pager Returns `boolean`
`public`	# `setFilterVisibility( boolean $visible = true )` Set visibility of filter Set visibility of filter Parameters `$visible` `boolean` $visible
`public boolean`	# `getFilterVisibility( )` Return visibility of filter Return visibility of filter Returns `boolean`
`public`	# `setMessageBlockVisibility( boolean $visible = true )` Set visibility of filter Set visibility of filter Parameters `$visible` `boolean` $visible
`public boolean`	# `getMessageBlockVisibility( )` Return visibility of filter Return visibility of filter Returns `boolean`
`public`	# `setDefaultLimit( mixed $limit )`
`public`	# `setDefaultPage( mixed $page )`
`public`	# `setDefaultSort( mixed $sort )`
`public`	# `setDefaultDir( mixed $dir )`
`public`	# `setDefaultFilter( mixed $filter )`
`public array\|false`	# `getExportTypes( )` Retrieve grid export types Retrieve grid export types Returns `array\|false`
`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`
`public array`	# `getRssLists( )` Retrieve rss lists types Retrieve rss lists types Returns `array`
`protected string`	# `_getRssUrl( string $url )` Returns url for RSS Can be overloaded in descendant classes to perform custom changes to url passed to addRssList() Returns url for RSS Can be overloaded in descendant classes to perform custom changes to url passed to addRssList() Parameters `$url` `string` $url Returns `string`
`public Mage_Adminhtml_Block_Widget_Grid`	# `addRssList( string $url, string $label )` Add new rss list to grid Add new rss list to grid Parameters `$url` `string` $url `$label` `string` $label Returns `Mage_Adminhtml_Block_Widget_Grid`
`public string`	# `getHtml( )` Retrieve grid HTML Retrieve grid HTML Returns `string`
`protected string`	# `_getFileContainerContent( array $fileData )` Retrieve file content from file container array Retrieve file content from file container array Parameters `$fileData` `array` $fileData Returns `string`
`protected array`	# `_getExportHeaders( )` Retrieve Headers row array for Export Retrieve Headers row array for Export Returns `array`
`protected array`	# `_getExportTotals( )` Retrieve Totals row array for Export Retrieve Totals row array for Export Returns `array`
`public Mage_Adminhtml_Block_Widget_Grid`	# `_exportIterateCollection( string $callback, array $args )` Iterate collection and call callback method per item For callback method first argument always is item object Iterate collection and call callback method per item For callback method first argument always is item object Parameters `$callback` `string` $callback `$args` `array` $args additional arguments for callback method Returns `Mage_Adminhtml_Block_Widget_Grid`
`protected`	# `_exportCsvItem( Varien_Object $item, Varien_Io_File $adapter )` Write item data to csv export file Write item data to csv export file Parameters `$item` `Varien_Object` $item `$adapter` `Varien_Io_File` $adapter
`public array`	# `getCsvFile( )` Retrieve a file container array by grid data as CSV Retrieve a file container array by grid data as CSV Return array with keys type and value Returns `array`
`public string`	# `getCsv( )` Retrieve Grid data as CSV Retrieve Grid data as CSV Returns `string`
`public`	# `getXml( )`
`protected`	# `_exportExcelItem( Varien_Object $item, Varien_Io_File $adapter, Varien_Convert_Parser_Xml_Excel $parser = null )` Write item data to Excel 2003 XML export file Write item data to Excel 2003 XML export file Parameters `$item` `Varien_Object` $item `$adapter` `Varien_Io_File` $adapter `$parser` `Varien_Convert_Parser_Xml_Excel` $parser
`public string`	# `getExcelFile( mixed $sheetName = '' )` Retrieve a file container array by grid data as MS Excel 2003 XML Document Retrieve a file container array by grid data as MS Excel 2003 XML Document Return array with keys type and value Returns `string`
`public string`	# `getExcel( string $filename = '' )` Retrieve grid data as MS Excel 2003 XML Document Retrieve grid data as MS Excel 2003 XML Document Parameters `$filename` `string` $filename the Workbook sheet name Returns `string`
`public`	# `canDisplayContainer( )`
`public string`	# `getAbsoluteGridUrl( array $params = array() )` Grid url getter Version of getGridUrl() but with parameters Grid url getter Version of getGridUrl() but with parameters Parameters `$params` `array` $params url parameters Returns `string` current grid url
`public mixed`	# `getParam( string $paramName, mixed $default = null )` Retrieve grid Retrieve grid Parameters `$paramName` `string` $paramName `$default` `mixed` $default Returns `mixed`
`public`	# `setSaveParametersInSession( mixed $flag )`
`public`	# `getJsObjectName( )`
`public string`	# `getRowId( mixed $row )` Deprecated since 1.1.7 Deprecated since 1.1.7 Returns `string`
`public string`	# `getMassactionIdField( )` Retrieve massaction row identifier field Retrieve massaction row identifier field Returns `string`
`public Mage_Adminhtml_Block_Widget_Grid`	# `setMassactionIdField( string $idField )` Set massaction row identifier field Set massaction row identifier field Parameters `$idField` `string` $idField Returns `Mage_Adminhtml_Block_Widget_Grid`
`public string`	# `getMassactionIdFilter( )` Retrieve massaction row identifier filter Retrieve massaction row identifier filter Returns `string`
`public Mage_Adminhtml_Block_Widget_Grid`	# `setMassactionIdFilter( string $idFilter )` Set massaction row identifier filter Set massaction row identifier filter Parameters `$idFilter` `string` $idFilter Returns `Mage_Adminhtml_Block_Widget_Grid`
`public string`	# `getMassactionBlockName( )` Retrive massaction block name Retrive massaction block name Returns `string`
`public Mage_Adminhtml_Block_Widget_Grid`	# `setMassactionBlockName( string $blockName )` Set massaction block name Set massaction block name Parameters `$blockName` `string` $blockName Returns `Mage_Adminhtml_Block_Widget_Grid`
`public Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract`	# `getMassactionBlock( )` Retrive massaction block Retrive massaction block Returns `Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract`
`public`	# `getMassactionBlockHtml( )`
`public Mage_Adminhtml_Block_Widget_Grid`	# `setEmptyText( string $text )` Set empty text for grid Set empty text for grid Parameters `$text` `string` $text Returns `Mage_Adminhtml_Block_Widget_Grid`
`public string`	# `getEmptyText( )` Return empty text for grid Return empty text for grid Returns `string`
`public Mage_Adminhtml_Block_Widget_Grid`	# `setEmptyTextClass( string $cssClass )` Set empty text CSS class Set empty text CSS class Parameters `$cssClass` `string` $cssClass Returns `Mage_Adminhtml_Block_Widget_Grid`
`public string`	# `getEmptyTextClass( )` Return empty text CSS class Return empty text CSS class Returns `string`
`public`	# `setCountTotals( boolean $count = true )` Set count totals Set count totals Parameters `$count` `boolean` $visible
`public boolean`	# `getCountTotals( )` Return count totals Return count totals Returns `boolean`
`public`	# `setTotals( Varien_Object $totals )` Set totals Set totals Parameters `$totals` `boolean` $visible
`public Varien_Object`	# `getTotals( )` Retrieve totals Retrieve totals Returns `Varien_Object`
`public Mage_Adminhtml_Block_Widget_Grid`	# `setCountSubTotals( boolean $flag = true )` Set subtotals Set subtotals Parameters `$flag` `boolean` $flag Returns `Mage_Adminhtml_Block_Widget_Grid`
`public boolean`	# `getCountSubTotals( )` Return count subtotals Return count subtotals Returns `boolean`
`public Mage_Adminhtml_Block_Widget_Grid`	# `setSubTotals( array $items )` Set subtotal items Set subtotal items Parameters `$items` `array` $items Returns `Mage_Adminhtml_Block_Widget_Grid`
`public Varien_Object`	# `getSubTotalItem( Varien_Object $item )` Retrieve subtotal item Retrieve subtotal item Parameters `$item` `Varien_Object` $item Returns `Varien_Object`
`public array`	# `getSubTotals( )` Retrieve subtotal items Retrieve subtotal items Returns `array`
`public boolean`	# `shouldRenderSubTotal( Varien_Object $item )` Check whether subtotal should be rendered Check whether subtotal should be rendered Parameters `$item` `Varien_Object` $item Returns `boolean`
`public unknown`	# `getSubTotalColumns( )` Retrieve columns to render Retrieve columns to render Returns `unknown`
`public integer\|boolean`	# `getRowspan( Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column )` Retrieve rowspan number Retrieve rowspan number Parameters `$item` `Varien_Object` $item `$column` `Mage_Adminhtml_Block_Widget_Grid_Column` $column Returns `integer\|boolean`
`public boolean\|Mage_Adminhtml_Block_Widget_Grid`	# `isColumnGrouped( string\|object $column, string $value = null )` Enter description here... Enter description here... Parameters `$column` `string\|object` $column `$value` `string` $value Returns `boolean\|Mage_Adminhtml_Block_Widget_Grid`
`public array`	# `getMultipleRows( Varien_Object $item )` Get children of specified item Get children of specified item Parameters `$item` `Varien_Object` $item Returns `array`
`public array`	# `getMultipleRowColumns( )` Retrieve columns for multiple rows Retrieve columns for multiple rows Returns `array`
`public boolean`	# `shouldRenderCell( Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column )` Check whether should render cell Check whether should render cell Parameters `$item` `Varien_Object` $item `$column` `Mage_Adminhtml_Block_Widget_Grid_Column` $column Returns `boolean`
`public boolean`	# `shouldRenderEmptyCell( Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column )` Check whether should render empty cell Check whether should render empty cell Parameters `$item` `Varien_Object` $item `$column` `Mage_Adminhtml_Block_Widget_Grid_Column` $column Returns `boolean`
`public integer`	# `getEmptyCellColspan( )` Retrieve colspan for empty cell Retrieve colspan for empty cell Returns `integer`
`public string`	# `getEmptyCellLabel( )` Retrieve label for empty cell Retrieve label for empty cell Returns `string`
`public Mage_Adminhtml_Block_Widget_Grid`	# `setEmptyCellLabel( string $label )` Set label for empty cell Set label for empty cell Parameters `$label` `string` $label Returns `Mage_Adminhtml_Block_Widget_Grid`
`public string`	# `getRowUrl( Mage_Catalog_Model_Product\|Varien_Object $item )` Return row url for js event handlers Return row url for js event handlers Parameters `$item` `Mage_Catalog_Model_Product\|Varien_Object` Returns `string`

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 array`	`$_columns`	`array()`	# Columns array Columns array array( 'header' => string, 'width' => int, 'sortable' => bool, 'index' => string, //'renderer' => Mage_Adminhtml_Block_Widget_Grid_Column_Renderer_Interface, 'format' => string 'total' => string (sum, avg) )
`protected mixed`	`$_lastColumnId`		#
`protected Varien_Data_Collection`	`$_collection`	`null`	# Collection object Collection object
`protected string`	`$_varNameLimit`	`'limit'`	# Page and sorting var names Page and sorting var names
`protected string`	`$_varNamePage`	`'page'`	#
`protected string`	`$_varNameSort`	`'sort'`	#
`protected string`	`$_varNameDir`	`'dir'`	#
`protected string`	`$_varNameFilter`	`'filter'`	#
`protected integer`	`$_defaultLimit`	`20`	#
`protected integer`	`$_defaultPage`	`1`	#
`protected boolean`	`$_defaultSort`	`false`	#
`protected string`	`$_defaultDir`	`'desc'`	#
`protected array`	`$_defaultFilter`	`array()`	#
`protected boolean`	`$_isExport`	`false`	# Export flag Export flag
`protected sting\|null`	`$_emptyText`		# Empty grid text Empty grid text
`protected sting\|null`	`$_emptyTextCss`	`'a-center'`	# Empty grid text CSS class Empty grid text CSS class
`protected boolean`	`$_pagerVisibility`	`true`	# Pager visibility Pager visibility
`protected boolean`	`$_headersVisibility`	`true`	# Column headers visibility Column headers visibility
`protected boolean`	`$_filterVisibility`	`true`	# Filter visibility Filter visibility
`protected boolean`	`$_messageBlockVisibility`	`false`	# Massage block visibility Massage block visibility
`protected boolean`	`$_saveParametersInSession`	`false`	#
`protected boolean`	`$_countTotals`	`false`	# Count totals Count totals
`protected boolean`	`$_countSubTotals`	`false`	# Count subtotals Count subtotals
`protected Varien_Object`	`$_varTotals`		# Totals Totals
`protected array`	`$_subtotals`	`array()`	# SubTotals SubTotals
`protected array`	`$_exportTypes`	`array()`	# Grid export types Grid export types
`protected integer`	`$_exportPageSize`	`1000`	# Rows per page for import Rows per page for import
`protected string`	`$_massactionIdField`	`null`	# Massaction row id field Massaction row id field
`protected string`	`$_massactionIdFilter`	`null`	# Massaction row id filter Massaction row id filter
`protected string`	`$_massactionBlockName`	`'adminhtml/widget_grid_massaction'`	# Massaction block name Massaction block name
`protected array`	`$_rssLists`	`array()`	# RSS list RSS list
`protected array`	`$_columnsOrder`	`array()`	# Columns view order Columns view order
`protected array`	`$_groupedColumn`	`array()`	# Columns to group by Columns to group by
`protected string`	`$_emptyCellLabel`	`''`	# Label for empty cell Label for empty cell

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_Widget_Grid

Direct known subclasses

Indirect known subclasses

Returns

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Var

Returns

Returns

Returns

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns