Class Mage_Adminhtml_Block_Widget_Grid

Description

Adminhtml grid widget block

Located in /Adminhtml/Block/Widget/Grid.php (line 34)

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Adminhtml_Block_Template
            |
            --Mage_Adminhtml_Block_Widget
               |
               --Mage_Adminhtml_Block_Widget_Grid
Direct descendents
Class Description
Mage_Bundle_Block_Adminhtml_Catalog_Product_Edit_Tab_Bundle_Option_Search_Grid Bundle selection product grid
Mage_Paypal_Block_Adminhtml_Settlement_Report_Grid Adminhtml paypal settlement reports grid block
Mage_Adminhtml_Block_Permissions_Role_Grid_User Acl role user grid
Mage_Adminhtml_Block_Permissions_User_Grid Adminhtml permissions user grid
Mage_Adminhtml_Block_Permissions_User_Edit_Tab_Roles Magento
Mage_Adminhtml_Block_Permissions_Grid_User Users grid
Mage_Adminhtml_Block_Permissions_Grid_Role roles grid
Mage_Adminhtml_Block_Backup_Grid Adminhtml backups grid block
Mage_Adminhtml_Block_Cms_Block_Grid Adminhtml cms blocks grid
Mage_Adminhtml_Block_Cms_Block_Widget_Chooser CMS block chooser for Wysiwyg CMS widget
Mage_Adminhtml_Block_Cms_Page_Grid Adminhtml cms pages grid
Mage_Adminhtml_Block_Cms_Page_Widget_Chooser CMS page chooser for Wysiwyg CMS widget
Mage_Adminhtml_Block_Catalog_Category_Tab_Product Product in category grid
Mage_Adminhtml_Block_Catalog_Search_Grid description
Mage_Adminhtml_Block_Catalog_Product_Attribute_Set_Grid description
Mage_Adminhtml_Block_Catalog_Product_Grid Adminhtml customer grid block
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Upsell Upsell products admin grid
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Related Related products admin grid
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Super_Config_Grid Adminhtml super product links grid
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Super_Group Product in category grid
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Tag_Customer List of customers tagged a product
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Alerts_Price Sign up for an alert when the product price changes grid
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Alerts_Stock Sign up for an alert when the product price changes grid
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Crosssell Crossell products admin grid
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Tag Products' tags grid
Mage_Adminhtml_Block_Catalog_Product_Widget_Chooser Product Chooser for "Product Link" Cms Widget Plugin
Mage_Adminhtml_Block_Dashboard_Grid Adminhtml dashboard grid
Mage_Adminhtml_Block_Api_Role_Grid_User Acl role user grid
Mage_Adminhtml_Block_Api_User_Grid Adminhtml permissions user grid
Mage_Adminhtml_Block_Api_User_Edit_Tab_Roles Magento
Mage_Adminhtml_Block_Api_Grid_Role roles grid
Mage_Adminhtml_Block_Customer_Group_Grid Adminhtml customers groups grid block
Mage_Adminhtml_Block_Customer_Grid Adminhtml customer grid block
Mage_Adminhtml_Block_Customer_Online_Grid Adminhtml customer grid block
Mage_Adminhtml_Block_Customer_Edit_Tab_Tags Adminhtml customer orders grid block
Mage_Adminhtml_Block_Customer_Edit_Tab_Newsletter_Grid Adminhtml newsletter queue grid block
Mage_Adminhtml_Block_Customer_Edit_Tab_Orders Adminhtml customer orders grid block
Mage_Adminhtml_Block_Customer_Edit_Tab_Wishlist Adminhtml customer orders grid block
Mage_Adminhtml_Block_Customer_Edit_Tab_View_Orders Adminhtml customer recent orders grid block
Mage_Adminhtml_Block_Customer_Edit_Tab_View_Wishlist Adminhtml customer view wishlist block
Mage_Adminhtml_Block_Customer_Edit_Tab_View_Cart Adminhtml customer cart items grid block
Mage_Adminhtml_Block_Customer_Edit_Tab_Tag Customer's tags grid
Mage_Adminhtml_Block_Customer_Edit_Tab_Cart Adminhtml customer orders grid block
Mage_Adminhtml_Block_Urlrewrite_Grid Adminhtml urlrewrite grid block
Mage_Adminhtml_Block_Tag_Customer_Grid Child Of Mage_Adminhtml_Block_Tag_Customer
Mage_Adminhtml_Block_Tag_Tag_Grid Adminhtml all tags grid
Mage_Adminhtml_Block_Tag_Grid_Pending Adminhtml pending tags grid
Mage_Adminhtml_Block_Tag_Grid_All Adminhtml all tags grid block
Mage_Adminhtml_Block_Tag_Grid_Products Adminhtml tagged products grid block
Mage_Adminhtml_Block_Tag_Grid_Customers Adminhtml tagginf customers grid block
Mage_Adminhtml_Block_Tag_Assigned_Grid Adminhtml assigned products grid block
Mage_Adminhtml_Block_Tag_Product_Grid Child Of Mage_Adminhtml_Block_Tag_Product
Mage_Adminhtml_Block_Newsletter_Queue_Grid Adminhtml newsletter queue grid block
Mage_Adminhtml_Block_Newsletter_Problem_Grid Adminhtml newsletter problem grid block
Mage_Adminhtml_Block_Newsletter_Subscriber_Grid Adminhtml newsletter subscribers grid block
Mage_Adminhtml_Block_Newsletter_Template_Grid Adminhtml newsletter templates grid block
Mage_Adminhtml_Block_Sales_Invoice_Grid Adminhtml sales orders grid
Mage_Adminhtml_Block_Sales_Creditmemo_Grid Adminhtml sales orders grid
Mage_Adminhtml_Block_Sales_Transactions_Grid Adminhtml transactions grid
Mage_Adminhtml_Block_Sales_Transactions_Detail_Grid Adminhtml transaction details grid
Mage_Adminhtml_Block_Sales_Shipment_Grid Adminhtml sales orders grid
Mage_Adminhtml_Block_Sales_Order_Create_Customer_Grid Adminhtml sales order create block
Mage_Adminhtml_Block_Sales_Order_Create_Search_Grid Adminhtml sales order create search products block
Mage_Adminhtml_Block_Sales_Order_Grid Adminhtml sales orders grid
Mage_Adminhtml_Block_Sales_Order_Status_Grid Adminhtml sales order's statuses grid
Mage_Adminhtml_Block_Sales_Order_View_Tab_Creditmemos Order Credit Memos grid
Mage_Adminhtml_Block_Sales_Order_View_Tab_Invoices Order Invoices grid
Mage_Adminhtml_Block_Sales_Order_View_Tab_Shipments Order Shipments grid
Mage_Adminhtml_Block_Promo_Catalog_Grid description
Mage_Adminhtml_Block_Promo_Quote_Grid description
Mage_Adminhtml_Block_Promo_Widget_Chooser_Sku Adminhtml sales order create search products block
Mage_Adminhtml_Block_Promo_Widget_Chooser Shopping cart price rule chooser
Mage_Adminhtml_Block_Cache_Grid Magento
Mage_Adminhtml_Block_Shipping_Carrier_Tablerate_Grid Shipping carrier table rate grid block WARNING: This grid used for export table rates
Mage_Adminhtml_Block_Checkout_Agreement_Grid Magento
Mage_Adminhtml_Block_Poll_Grid description
Mage_Adminhtml_Block_Poll_Edit_Tab_Answers_Grid Poll answers grid
Mage_Adminhtml_Block_Review_Grid Adminhtml reviews grid
Mage_Adminhtml_Block_Report_Refresh_Statistics_Grid Adminhtml sales report grid block
Mage_Adminhtml_Block_Report_Tag_Customer_Grid Adminhtml tags by customers report grid block
Mage_Adminhtml_Block_Report_Tag_Customer_Detail_Grid Adminhtml tags detail for customer report grid block
Mage_Adminhtml_Block_Report_Tag_Product_Grid Adminhtml tags by products report grid block
Mage_Adminhtml_Block_Report_Tag_Product_Detail_Grid Adminhtml tags detail for product report grid block
Mage_Adminhtml_Block_Report_Tag_Popular_Grid Adminhtml popular tags report grid block
Mage_Adminhtml_Block_Report_Tag_Popular_Detail_Grid Adminhtml tags detail for product report grid block
Mage_Adminhtml_Block_Report_Grid Adminhtml report grid block
Mage_Adminhtml_Block_Report_Grid_Abstract Magento
Mage_Adminhtml_Block_Report_Wishlist_Grid Adminhtml wishlist report grid block
Mage_Adminhtml_Block_Report_Search_Grid Adminhtml search report grid block
Mage_Adminhtml_Block_Report_Review_Customer_Grid Adminhtml reviews by customers report grid block
Mage_Adminhtml_Block_Report_Review_Detail_Grid Adminhtml report reviews product grid block
Mage_Adminhtml_Block_Report_Review_Product_Grid Adminhtml reviews by products report grid block
Mage_Adminhtml_Block_Report_Product_Lowstock_Grid Adminhtml low stock products report grid block
Mage_Adminhtml_Block_Report_Product_Downloads_Grid Adminhtml product downloads report grid
Mage_Adminhtml_Block_Report_Product_Grid Adminhtml products report grid block
Mage_Adminhtml_Block_Report_Shopcart_Abandoned_Grid Adminhtml abandoned shopping carts report grid block
Mage_Adminhtml_Block_Report_Shopcart_Customer_Grid Adminhtml items in carts report grid block
Mage_Adminhtml_Block_Report_Shopcart_Product_Grid Adminhtml products in carts report grid block
Mage_Adminhtml_Block_System_Variable_Grid Custom Variable Grid Container
Mage_Adminhtml_Block_System_Store_Grid Adminhtml store grid
Mage_Adminhtml_Block_System_Convert_Profile_Grid Convert profiles grid
Mage_Adminhtml_Block_System_Convert_Profile_Edit_Tab_History Convert profile edit tab
Mage_Adminhtml_Block_System_Convert_Gui_Grid Convert profiles grid
Mage_Adminhtml_Block_System_Email_Template_Grid Adminhtml system templates grid block
Mage_Adminhtml_Block_System_Design_Grid Design changes grid
Mage_Adminhtml_Block_Rating_Grid description
Mage_Adminhtml_Block_Tax_Rate_Grid Magento
Mage_Adminhtml_Block_Tax_Class_Grid Adminhtml tax class Grid
Mage_Adminhtml_Block_Tax_Rule_Grid Magento
Mage_Adminhtml_Block_Notification_Grid Adminhtml AdminNotification inbox grid
Mage_Adminhtml_Block_Sitemap_Grid Sitemaps grid
Mage_Connect_Block_Adminhtml_Extension_Custom_Edit_Tab_Grid Convert profile edit tab
Mage_ImportExport_Block_Adminhtml_Export_Filter Export filter block
Mage_Sales_Block_Adminhtml_Billing_Agreement_Grid Adminhtml billing agreements grid
Mage_Sales_Block_Adminhtml_Recurring_Profile_Grid Recurring profiles grid
Mage_Sales_Block_Adminhtml_Recurring_Profile_View_Tab_Orders Recurring profile orders grid
Mage_Index_Block_Adminhtml_Process_Grid Magento
Mage_Eav_Block_Adminhtml_Attribute_Grid_Abstract Product attributes grid
Mage_XmlConnect_Block_Adminhtml_Queue_Grid XmlConnect AirMail message queue grid
Mage_Xmlconnect_Block_Adminhtml_Mobile_Grid Magento
Mage_XmlConnect_Block_Adminhtml_Mobile_Edit_Tab_Submission_History XmlConnect application history grid
Mage_XmlConnect_Block_Adminhtml_Template_Grid XmlConnect AirMail message queue grid
Mage_XmlConnect_Block_Adminhtml_History_Grid XmlConnect application history grid
Mage_GoogleBase_Block_Adminhtml_Types_Grid Adminhtml Google Base Item Types Mapping grid
Mage_GoogleBase_Block_Adminhtml_Items_Item Google Base Items
Mage_GoogleBase_Block_Adminhtml_Items_Product Products Grid to add to Google Base
Mage_Widget_Block_Adminhtml_Widget_Instance_Grid Widget Instance grid block
Variable Summary
Method Summary
Mage_Adminhtml_Block_Widget_Grid __construct ([ $attributes = array()])
Mage_Adminhtml_Block_Widget_Grid addColumn (string $columnId, array $column)
Mage_Adminhtml_Block_Widget_Grid addColumnAfter (string $columnId, array|Varien_Object $column, string $after)
Mage_Adminhtml_Block_Widget_Grid addColumnsOrder (string $columnId, string $after)
Mage_Adminhtml_Block_Widget_Grid addExportType (string $url, string $label)
Mage_Adminhtml_Block_Widget_Grid addRssList (string $url, string $label)
string getAbsoluteGridUrl ([array $params = array()])
Varien_Data_Collection getCollection ()
Varien_Object getColumn (string $columnId)
void getColumnCount ()
array getColumns ()
array getColumnsOrder ()
boolean getCountSubTotals ()
boolean getCountTotals ()
string getCsv ()
array getCsvFile ()
integer getEmptyCellColspan (Varien_Object $item)
string getEmptyCellLabel ()
string getEmptyText ()
string getEmptyTextClass ()
string getExcel ([string $filename = ''])
string getExcelFile ([ $sheetName = ''])
array getExportTypes ()
boolean getFilterVisibility ()
string getGridUrl ()
string getHtml ()
void getJsObjectName ()
void getLastColumnId ()
array getMultipleRowColumns (Varien_Object $item)
array getMultipleRows (Varien_Object $item)
boolean getPagerVisibility ()
mixed getParam (string $paramName, [mixed $default = null])
string getRowId ( $row)
integer|boolean getRowspan (Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column)
string getRowUrl (Mage_Catalog_Model_Product|Varien_Object $item)
array getRssLists ()
unknown getSubTotalColumns ()
Varien_Object getSubTotalItem (Varien_Object $item)
array getSubTotals ()
Varien_Object getTotals ()
void getVarNameDir ()
void getVarNameLimit ()
void getVarNamePage ()
void getVarNameSort ()
void getXml ()
boolean|Mage_Adminhtml_Block_Widget_Grid isColumnGrouped (string|object  $column, [string $value = null])
void setCollection (Varien_Data_Collection $collection)
void setCountTotals ([ $count = true], boolean $visible)
void setDefaultDir ( $dir)
void setDefaultFilter ( $filter)
void setDefaultLimit ( $limit)
void setDefaultPage ( $page)
void setDefaultSort ( $sort)
void setFilterVisibility ([boolean $visible = true])
void setHeadersVisibility ([boolean $visible = true])
void setMessageBlockVisibility ([boolean $visible = true])
void setPagerVisibility ([boolean $visible = true])
void setTotals ( $totals, boolean $visible)
void setVarNameDir ( $name)
void setVarNameFilter ( $name)
void setVarNameLimit ( $name)
void setVarNamePage ( $name)
void setVarNameSort ( $name)
boolean shouldRenderCell (Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column)
boolean shouldRenderEmptyCell (Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column)
boolean shouldRenderSubTotal (Varien_Object $item)
void _addColumnFilterToCollection ( $column)
void _beforeToHtml ()
void _decodeFilter ( &$value)
void _exportCsvItem ( $item,  $adapter)
void _exportExcelItem ( $item,  $adapter, [Varien_Convert_Parser_Xml_Excel $parser = null])
array _getExportTotals ()
string _getFileContainerContent ( $fileData)
string _getRssUrl (string $url)
void _prepareColumns ()
void _prepareGrid ()
void _prepareLayout ()
void _preparePage ()
void _setFilterValues ( $data)
Variables
Varien_Data_Collection $_collection = null (line 59)

Collection object

  • access: protected

Redefined in descendants as:
array $_columns = array() (line 50)

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) )

  • access: protected
array $_columnsOrder = array() (line 197)

Columns view order

  • access: protected
boolean $_countSubTotals = false (line 141)

Count subtotals

  • access: protected
boolean $_countTotals = false (line 134)

Count totals

  • access: protected
mixed $_defaultDir = 'desc' (line 75)
  • access: protected
mixed $_defaultFilter = array() (line 76)
  • access: protected
mixed $_defaultLimit = 20 (line 72)
  • access: protected
mixed $_defaultPage = 1 (line 73)
  • access: protected
mixed $_defaultSort = false (line 74)
  • access: protected

Redefined in descendants as:
string $_emptyCellLabel = '' (line 211)

Label for empty cell

  • access: protected
sting|null $_emptyText (line 90)

Empty grid text

  • access: protected
sting|null $_emptyTextCss = 'a-center' (line 97)

Empty grid text CSS class

  • access: protected
int $_exportPageSize = 1000 (line 169)

Rows per page for import

  • access: protected
array $_exportTypes = array() (line 162)

Grid export types

  • access: protected
boolean $_filterVisibility = true (line 118)

Filter visibility

  • access: protected
array $_groupedColumn = array() (line 204)

Columns to group by

  • access: protected
boolean $_headersVisibility = true (line 111)

Column headers visibility

  • access: protected
bool $_isExport = false (line 83)

Export flag

  • access: protected
mixed $_lastColumnId (line 52)
  • access: protected
string $_massactionBlockName = 'adminhtml/widget_grid_massaction' (line 183)

Massaction block name

  • access: protected
string $_massactionIdField = null (line 176)

Massaction row id field

  • access: protected
boolean $_messageBlockVisibility = false (line 125)

Massage block visibility

  • access: protected
boolean $_pagerVisibility = true (line 104)

Pager visibility

  • access: protected
array $_rssLists = array() (line 190)

RSS list

  • access: protected
mixed $_saveParametersInSession = false (line 127)
  • access: protected

Redefined in descendants as:
array $_subtotals = array() (line 155)

SubTotals

  • access: protected
mixed $_varNameDir = 'dir' (line 69)
  • access: protected
mixed $_varNameFilter = 'filter' (line 70)
  • access: protected
string $_varNameLimit = 'limit' (line 66)

Page and sorting var names

  • access: protected
mixed $_varNamePage = 'page' (line 67)
  • access: protected
mixed $_varNameSort = 'sort' (line 68)
  • access: protected
Varien_Object $_varTotals (line 148)

Totals

  • access: protected

Inherited Variables

Inherited from Mage_Core_Block_Template

Mage_Core_Block_Template::$_baseUrl
Mage_Core_Block_Template::$_jsUrl
Mage_Core_Block_Template::$_showTemplateHints
Mage_Core_Block_Template::$_showTemplateHintsBlocks
Mage_Core_Block_Template::$_template
Mage_Core_Block_Template::$_viewDir
Mage_Core_Block_Template::$_viewVars

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::$_alias
Mage_Core_Block_Abstract::$_anonSuffix
Mage_Core_Block_Abstract::$_childGroups
Mage_Core_Block_Abstract::$_children
Mage_Core_Block_Abstract::$_childrenHtmlCache
Mage_Core_Block_Abstract::$_frameCloseTag
Mage_Core_Block_Abstract::$_frameOpenTag
Mage_Core_Block_Abstract::$_isAnonymous
Mage_Core_Block_Abstract::$_layout
Mage_Core_Block_Abstract::$_messagesBlock
Mage_Core_Block_Abstract::$_nameInLayout
Mage_Core_Block_Abstract::$_parent
Mage_Core_Block_Abstract::$_parentBlock
Mage_Core_Block_Abstract::$_request
Mage_Core_Block_Abstract::$_sortedChildren
Mage_Core_Block_Abstract::$_urlModel
Methods
Constructor __construct (line 213)
  • access: public
Mage_Adminhtml_Block_Widget_Grid __construct ([ $attributes = array()])
  • $attributes

Redefined in descendants as:
addColumn (line 302)

Add column to grid

  • access: public
Mage_Adminhtml_Block_Widget_Grid addColumn (string $columnId, array $column)
  • string $columnId
  • array $column: || Varien_Object $column

Redefined in descendants as:
addColumnAfter (line 329)

Add column to grid after specified column.

  • access: public
Mage_Adminhtml_Block_Widget_Grid addColumnAfter (string $columnId, array|Varien_Object $column, string $after)
  • string $columnId
  • array|Varien_Object $column
  • string $after
addColumnsOrder (line 343)

Add column view order

  • access: public
Mage_Adminhtml_Block_Widget_Grid addColumnsOrder (string $columnId, string $after)
  • string $columnId
  • string $after
addExportType (line 790)

Add new export type to grid

  • access: public
Mage_Adminhtml_Block_Widget_Grid addExportType (string $url, string $label)
  • string $url
  • string $label

Redefined in descendants as:
addRssList (line 835)

Add new rss list to grid

  • access: public
Mage_Adminhtml_Block_Widget_Grid addRssList (string $url, string $label)
  • string $url
  • string $label
canDisplayContainer (line 1188)
  • access: public
void canDisplayContainer ()
getAbsoluteGridUrl (line 1215)

Grid url getter Version of getGridUrl() but with parameters

  • return: current grid url
  • access: public
string getAbsoluteGridUrl ([array $params = array()])
  • array $params: url parameters
getCollection (line 290)

get collection object

  • access: public
Varien_Data_Collection getCollection ()

Redefined in descendants as:
getColumn (line 407)

Retrieve grid column by column id

  • return: || false
  • access: public
Varien_Object getColumn (string $columnId)
  • string $columnId
getColumnCount (line 396)
  • access: public
void getColumnCount ()
getColumns (line 420)

Retrieve all grid columns

  • access: public
array getColumns ()
getColumnsOrder (line 354)

Retrieve columns order

  • access: public
array getColumnsOrder ()
getCountSubTotals (line 1427)

Return count subtotals

  • access: public
boolean getCountSubTotals ()
getCountTotals (line 1385)

Return count totals

  • access: public
boolean getCountTotals ()

Redefined in descendants as:
getCsv (line 1001)

Retrieve Grid data as CSV

  • access: public
string getCsv ()

Redefined in descendants as:
getCsvFile (line 963)

Retrieve a file container array by grid data as CSV

Return array with keys type and value

  • access: public
array getCsvFile ()
getEmptyCellColspan (line 1587)

Retrieve colspan for empty cell

  • access: public
integer getEmptyCellColspan (Varien_Object $item)
  • Varien_Object $item
getEmptyCellLabel (line 1597)

Retrieve label for empty cell

  • access: public
string getEmptyCellLabel ()
getEmptyText (line 1343)

Return empty text for grid

  • access: public
string getEmptyText ()

Redefined in descendants as:
getEmptyTextClass (line 1365)

Return empty text CSS class

  • access: public
string getEmptyTextClass ()
getExcel (line 1142)

Retrieve grid data as MS Excel 2003 XML Document

  • access: public
string getExcel ([string $filename = ''])
  • string $filename: the Workbook sheet name

Redefined in descendants as:
getExcelFile (line 1100)

Retrieve a file container array by grid data as MS Excel 2003 XML Document

Return array with keys type and value

  • access: public
string getExcelFile ([ $sheetName = ''])
  • $sheetName
getExportButtonHtml (line 249)
  • access: public
void getExportButtonHtml ()
getExportTypes (line 778)

Retrieve grid export types

  • access: public
array getExportTypes ()

Redefined in descendants as:
getFilterVisibility (line 718)

Return visibility of filter

  • access: public
boolean getFilterVisibility ()
getGridUrl (line 1203)

Grid url getter

  • return: current grid url
  • deprecated: after 1.3.2.3 Use getAbsoluteGridUrl() method instead
  • access: public
string getGridUrl ()

Redefined in descendants as:
getHeadersVisibility (line 678)

Return visibility of column headers

  • access: public
boolean getHeadersVisibility ()

Redefined in descendants as:
getHtml (line 851)

Retrieve grid HTML

  • access: public
string getHtml ()
getJsObjectName (line 1252)
  • access: public
void getJsObjectName ()
getLastColumnId (line 391)
  • access: public
void getLastColumnId ()
getMainButtonsHtml (line 264)
  • access: public
void getMainButtonsHtml ()
getMassactionBlock (line 1316)

Retrive massaction block

  • access: public
getMassactionBlockHtml (line 1321)
  • access: public
void getMassactionBlockHtml ()
getMassactionBlockName (line 1294)

Retrive massaction block name

  • access: public
string getMassactionBlockName ()
getMassactionIdField (line 1272)

Retrive massaction row identifier field

  • access: public
string getMassactionIdField ()
getMessageBlockVisibility (line 738)

Return visibility of filter

  • access: public
boolean getMessageBlockVisibility ()
getMultipleRowColumns (line 1542)

Retrieve columns for multiple rows

  • access: public
array getMultipleRowColumns (Varien_Object $item)
  • Varien_Object $item
getMultipleRows (line 1531)

Get children of specified item

  • access: public
array getMultipleRows (Varien_Object $item)
  • Varien_Object $item
getPagerVisibility (line 698)

Return visibility of pager

  • access: public
boolean getPagerVisibility ()
getParam (line 1227)

Retrieve grid

  • access: public
mixed getParam (string $paramName, [mixed $default = null])
  • string $paramName
  • mixed $default
getResetFilterButtonHtml (line 254)
  • access: public
void getResetFilterButtonHtml ()
getRowId (line 1262)

Deprecated since 1.1.7

  • access: public
string getRowId ( $row)
  • $row

Redefined in descendants as:
getRowspan (line 1498)

Retrieve rowspan number

  • access: public
integer|boolean getRowspan (Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column)
getRowUrl (line 1620)

Return row url for js event handlers

  • access: public
string getRowUrl (Mage_Catalog_Model_Product|Varien_Object $item)

Redefined in descendants as:
getRssLists (line 806)

Retrieve rss lists types

  • access: public
array getRssLists ()
getSearchButtonHtml (line 259)
  • access: public
void getSearchButtonHtml ()
getSubTotalColumns (line 1487)

Retrieve columns to render

  • access: public
unknown getSubTotalColumns ()
getSubTotalItem (line 1450)

Retrieve subtotal item

  • access: public
Varien_Object getSubTotalItem (Varien_Object $item)
  • Varien_Object $item
getSubTotals (line 1467)

Retrieve subtotal items

  • access: public
array getSubTotals ()

Redefined in descendants as:
getTotals (line 1405)

Retrieve totals

  • access: public
Varien_Object getTotals ()
getVarNameDir (line 628)
  • access: public
void getVarNameDir ()
getVarNameFilter (line 633)
  • access: public
void getVarNameFilter ()
getVarNameLimit (line 613)
  • access: public
void getVarNameLimit ()
getVarNamePage (line 618)
  • access: public
void getVarNamePage ()
getVarNameSort (line 623)
  • access: public
void getVarNameSort ()
getXml (line 1043)
  • access: public
void getXml ()
isColumnGrouped (line 1513)

Enter description here...

  • access: public
boolean|Mage_Adminhtml_Block_Widget_Grid isColumnGrouped (string|object  $column, [string $value = null])
  • string|object $column
  • string $value
setCollection (line 280)

set collection object

  • access: public
void setCollection (Varien_Data_Collection $collection)
  • Varien_Data_Collection $collection
setCountSubTotals (line 1416)

Set subtotals

  • access: public
Mage_Adminhtml_Block_Widget_Grid setCountSubTotals ([boolean $flag = true])
  • boolean $flag
setCountTotals (line 1375)

Set count totals

  • access: public
void setCountTotals ([ $count = true], boolean $visible)
  • boolean $visible
  • $count
setDefaultDir (line 761)
  • access: public
void setDefaultDir ( $dir)
  • $dir
setDefaultFilter (line 767)
  • access: public
void setDefaultFilter ( $filter)
  • $filter
setDefaultLimit (line 743)
  • access: public
void setDefaultLimit ( $limit)
  • $limit
setDefaultPage (line 749)
  • access: public
void setDefaultPage ( $page)
  • $page
setDefaultSort (line 755)
  • access: public
void setDefaultSort ( $sort)
  • $sort
setEmptyCellLabel (line 1608)

Set label for empty cell

  • access: public
Mage_Adminhtml_Block_Widget_Grid setEmptyCellLabel (string $label)
  • string $label
setEmptyText (line 1332)

Set empty text for grid

  • access: public
Mage_Adminhtml_Block_Widget_Grid setEmptyText (string $text)
  • string $text
setEmptyTextClass (line 1354)

Set empty text CSS class

  • access: public
Mage_Adminhtml_Block_Widget_Grid setEmptyTextClass (string $cssClass)
  • string $cssClass
setFilterVisibility (line 708)

Set visibility of filter

  • access: public
void setFilterVisibility ([boolean $visible = true])
  • boolean $visible
setHeadersVisibility (line 668)

Set visibility of column headers

  • access: public
void setHeadersVisibility ([boolean $visible = true])
  • boolean $visible
setMassactionBlockName (line 1305)

Set massaction block name

  • access: public
Mage_Adminhtml_Block_Widget_Grid setMassactionBlockName (string $blockName)
  • string $blockName
setMassactionIdField (line 1283)

Set massaction row identifier field

  • access: public
Mage_Adminhtml_Block_Widget_Grid setMassactionIdField (string $idField)
  • string $idField
setMessageBlockVisibility (line 728)

Set visibility of filter

  • access: public
void setMessageBlockVisibility ([boolean $visible = true])
  • boolean $visible
setPagerVisibility (line 688)

Set visibility of pager

  • access: public
void setPagerVisibility ([boolean $visible = true])
  • boolean $visible
setSaveParametersInSession (line 1246)
  • access: public
void setSaveParametersInSession ( $flag)
  • $flag
setSubTotals (line 1438)

Set subtotal items

  • access: public
Mage_Adminhtml_Block_Widget_Grid setSubTotals ( $items)
  • array $items
setTotals (line 1395)

Set totals

  • access: public
void setTotals ( $totals, boolean $visible)
  • boolean $visible
  • Varien_Object $totals
setVarNameDir (line 653)
  • access: public
void setVarNameDir ( $name)
  • $name
setVarNameFilter (line 658)
  • access: public
void setVarNameFilter ( $name)
  • $name
setVarNameLimit (line 638)
  • access: public
void setVarNameLimit ( $name)
  • $name
setVarNamePage (line 643)
  • access: public
void setVarNamePage ( $name)
  • $name
setVarNameSort (line 648)
  • access: public
void setVarNameSort ( $name)
  • $name
shouldRenderCell (line 1558)

Check whether should render cell

  • access: public
boolean shouldRenderCell (Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column)
shouldRenderEmptyCell (line 1576)

Check whether should render empty cell

  • access: public
boolean shouldRenderEmptyCell (Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column)
shouldRenderSubTotal (line 1478)

Check whether subtotal should be rendered

  • access: public
boolean shouldRenderSubTotal (Varien_Object $item)
  • Varien_Object $item
sortColumnsByOrder (line 364)

Sort columns by predefined order

  • access: public
Mage_Adminhtml_Block_Widget_Grid sortColumnsByOrder ()
_addColumnFilterToCollection (line 436)
  • access: protected
void _addColumnFilterToCollection ( $column)
  • $column

Redefined in descendants as:
_beforeToHtml (line 602)
  • access: protected
void _beforeToHtml ()

Redefinition of:
Mage_Core_Block_Abstract::_beforeToHtml()
Before rendering html, but after trying to load cache

Redefined in descendants as:
_decodeFilter (line 519)

Decode URL encoded filter value recursive callback method

  • access: protected
void _decodeFilter ( &$value)
  • &$value
_exportCsvItem (line 945)

Write item data to csv export file

  • access: protected
void _exportCsvItem ( $item,  $adapter)
  • Varien_Object $item
  • Varien_Io_File $adapter
_exportExcelItem (line 1077)

Write item data to Excel 2003 XML export file

  • access: protected
void _exportExcelItem ( $item,  $adapter, [Varien_Convert_Parser_Xml_Excel $parser = null])
  • Varien_Object $item
  • Varien_Io_File $adapter
  • Varien_Convert_Parser_Xml_Excel $parser
_exportIterateCollection (line 911)

Iterate collection and call callback method per item For callback method first argument always is item object

  • access: public
Mage_Adminhtml_Block_Widget_Grid _exportIterateCollection (string $callback,  $args)
  • string $callback
  • array $args: additional arguments for callback method
_getExportHeaders (line 875)

Retrieve Headers row array for Export

  • access: protected
array _getExportHeaders ()
_getExportTotals (line 891)

Retrieve Totals row array for Export

  • access: protected
array _getExportTotals ()
_getFileContainerContent (line 862)

Retrieve file content from file container array

  • access: protected
string _getFileContainerContent ( $fileData)
  • array $fileData
_getRssUrl (line 818)

Returns url for RSS Can be overloaded in descendant classes to perform custom changes to url passed to addRssList()

  • access: protected
string _getRssUrl (string $url)
  • string $url
_prepareCollection (line 474)

Prepare grid collection object

  • access: protected
this _prepareCollection ()

Redefined in descendants as:
_prepareColumns (line 530)
  • access: protected
void _prepareColumns ()

Redefined in descendants as:
_prepareGrid (line 594)
  • access: protected
void _prepareGrid ()
_prepareLayout (line 221)
  • access: protected
void _prepareLayout ()

Redefinition of:
Mage_Core_Block_Abstract::_prepareLayout()
Preparing global layout

Redefined in descendants as:
_prepareMassaction (line 556)

Prepare grid massaction actions

  • access: protected
Mage_Adminhtml_Block_Widget_Grid _prepareMassaction ()

Redefined in descendants as:
_prepareMassactionBlock (line 541)

Prepare grid massaction block

  • access: protected
Mage_Adminhtml_Block_Widget_Grid _prepareMassactionBlock ()
_prepareMassactionColumn (line 567)

Prepare grid massaction column

  • access: protected
unknown _prepareMassactionColumn ()
_preparePage (line 524)
  • access: protected
void _preparePage ()

Redefined in descendants as:
_setCollectionOrder (line 458)

Sets sorting order by some column

  • access: protected

Redefined in descendants as:
_setFilterValues (line 425)
  • access: protected
void _setFilterValues ( $data)
  • $data

Redefined in descendants as:

Inherited Methods

Inherited From Mage_Adminhtml_Block_Widget

Mage_Adminhtml_Block_Widget::getButtonHtml()
Mage_Adminhtml_Block_Widget::getCurrentUrl()
Mage_Adminhtml_Block_Widget::getGlobalIcon()
Mage_Adminhtml_Block_Widget::getHtmlId()
Mage_Adminhtml_Block_Widget::getId()
Mage_Adminhtml_Block_Widget::_addBreadcrumb()

Inherited From Mage_Adminhtml_Block_Template

Mage_Adminhtml_Block_Template::getFormKey()
Mage_Adminhtml_Block_Template::isOutputEnabled()
Mage_Adminhtml_Block_Template::_getUrlModelClass()
Mage_Adminhtml_Block_Template::_toHtml()

Inherited From Mage_Core_Block_Template

Mage_Core_Block_Template::assign()
Mage_Core_Block_Template::fetchView()
Mage_Core_Block_Template::getArea()
Mage_Core_Block_Template::getBaseUrl()
Mage_Core_Block_Template::getCacheKeyInfo()
Mage_Core_Block_Template::getDirectOutput()
Mage_Core_Block_Template::getJsUrl()
Mage_Core_Block_Template::getObjectData()
Mage_Core_Block_Template::getShowTemplateHints()
Mage_Core_Block_Template::getTemplate()
Mage_Core_Block_Template::getTemplateFile()
Mage_Core_Block_Template::renderView()
Mage_Core_Block_Template::setScriptPath()
Mage_Core_Block_Template::setTemplate()
Mage_Core_Block_Template::_construct()
Mage_Core_Block_Template::_toHtml()

Inherited From Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::addToChildGroup()
Mage_Core_Block_Abstract::addToParentGroup()
Mage_Core_Block_Abstract::append()
Mage_Core_Block_Abstract::countChildren()
Mage_Core_Block_Abstract::escapeHtml()
Mage_Core_Block_Abstract::escapeUrl()
Mage_Core_Block_Abstract::formatDate()
Mage_Core_Block_Abstract::formatTime()
Mage_Core_Block_Abstract::getAction()
Mage_Core_Block_Abstract::getAnonSuffix()
Mage_Core_Block_Abstract::getBlockAlias()
Mage_Core_Block_Abstract::getBlockHtml()
Mage_Core_Block_Abstract::getCacheKey()
Mage_Core_Block_Abstract::getCacheKeyInfo()
Mage_Core_Block_Abstract::getCacheLifetime()
Mage_Core_Block_Abstract::getCacheTags()
Mage_Core_Block_Abstract::getChild()
Mage_Core_Block_Abstract::getChildChildHtml()
Mage_Core_Block_Abstract::getChildData()
Mage_Core_Block_Abstract::getChildGroup()
Mage_Core_Block_Abstract::getChildHtml()
Mage_Core_Block_Abstract::getHelper()
Mage_Core_Block_Abstract::getIsAnonymous()
Mage_Core_Block_Abstract::getLayout()
Mage_Core_Block_Abstract::getMessagesBlock()
Mage_Core_Block_Abstract::getModuleName()
Mage_Core_Block_Abstract::getNameInLayout()
Mage_Core_Block_Abstract::getParentBlock()
Mage_Core_Block_Abstract::getRequest()
Mage_Core_Block_Abstract::getSkinUrl()
Mage_Core_Block_Abstract::getSortedChildBlocks()
Mage_Core_Block_Abstract::getSortedChildren()
Mage_Core_Block_Abstract::getUrl()
Mage_Core_Block_Abstract::getUrlBase64()
Mage_Core_Block_Abstract::getUrlEncoded()
Mage_Core_Block_Abstract::helper()
Mage_Core_Block_Abstract::htmlEscape()
Mage_Core_Block_Abstract::insert()
Mage_Core_Block_Abstract::jsQuoteEscape()
Mage_Core_Block_Abstract::setAnonSuffix()
Mage_Core_Block_Abstract::setAttribute()
Mage_Core_Block_Abstract::setBlockAlias()
Mage_Core_Block_Abstract::setChild()
Mage_Core_Block_Abstract::setFrameTags()
Mage_Core_Block_Abstract::setIsAnonymous()
Mage_Core_Block_Abstract::setLayout()
Mage_Core_Block_Abstract::setMessagesBlock()
Mage_Core_Block_Abstract::setNameInLayout()
Mage_Core_Block_Abstract::setParentBlock()
Mage_Core_Block_Abstract::stripTags()
Mage_Core_Block_Abstract::toHtml()
Mage_Core_Block_Abstract::unsetCallChild()
Mage_Core_Block_Abstract::unsetChild()
Mage_Core_Block_Abstract::unsetChildren()
Mage_Core_Block_Abstract::urlEscape()
Mage_Core_Block_Abstract::_afterCacheUrl()
Mage_Core_Block_Abstract::_afterToHtml()
Mage_Core_Block_Abstract::_beforeCacheUrl()
Mage_Core_Block_Abstract::_beforeChildToHtml()
Mage_Core_Block_Abstract::_beforeToHtml()
Mage_Core_Block_Abstract::_construct()
Mage_Core_Block_Abstract::_getChildHtml()
Mage_Core_Block_Abstract::_getUrlModel()
Mage_Core_Block_Abstract::_getUrlModelClass()
Mage_Core_Block_Abstract::_loadCache()
Mage_Core_Block_Abstract::_prepareLayout()
Mage_Core_Block_Abstract::_saveCache()
Mage_Core_Block_Abstract::_toHtml()
Mage_Core_Block_Abstract::__()
Class Constants

Documentation generated on Fri, 11 Feb 2011 17:04:13 +0200 by phpDocumentor 1.4.3