Documentation

Mage_Adminhtml_Block_Report_Grid_Abstract extends Mage_Adminhtml_Block_Widget_Grid
in package

Mage

Adminhtml

Maho

Constants

CACHE_GROUP = 'block_html': Cache group Tag
CACHE_KEY_PREFIX = 'BLOCK_': Prefix for cache key
CACHE_TAGS_DATA_KEY = 'cache_tags': Cache tags data key
XML_PATH_DEBUG_TEMPLATE_HINTS = 'dev/debug/template_hints'
XML_PATH_DEBUG_TEMPLATE_HINTS_ADMIN = 'dev/debug/template_hints_admin'
XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS = 'dev/debug/template_hints_blocks'
XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS_ADMIN = 'dev/debug/template_hints_blocks_admin'
XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'

Properties

$_aggregatedColumns : mixed
$_alias : string: Short alias of this block that was referred from parent
$_anonSuffix : string: Suffix for name of anonymous block
$_app : Mage_Core_Model_App|null: Application instance
$_baseUrl : mixed
$_childGroups : array<string|int, mixed>: Arbitrary groups of child blocks
$_children : array<string|int, Mage_Core_Block_Abstract>: Contains references to child block objects
$_childrenHtmlCache : array<string|int, mixed>: Children blocks HTML cache array
$_collection : Varien_Data_Collection_Db|null: Collection object
$_columnGroupBy : string: Column for grid to be grouped by
$_columns : array<string|int, mixed>: Columns array
$_columnsOrder : array<string|int, mixed>: Columns view order
$_countSubTotals : bool: Count subtotals
$_countTotals : bool: Count totals
$_currentCurrencyCode : mixed
$_data : array<string|int, mixed>|null: Object attributes
$_defaultDir : mixed
$_defaultFilter : mixed
$_defaultLimit : mixed
$_defaultPage : mixed
$_defaultSort : mixed
$_dirty : array<string|int, mixed>
$_emptyCellLabel : string: Label for empty cell
$_emptyText : string|null: Empty grid text
$_emptyTextCss : string|null: Empty grid text CSS class
$_exportPageSize : int: Rows per page for import
$_exportTypes : array<string|int, mixed>: Grid export types
$_factory : Mage_Core_Model_Factory|null: Factory instance
$_filterVisibility : bool: Filter visibility
$_frameCloseTag : string: Block html frame close tag
$_frameOpenTag : string: Block html frame open tag
$_groupedColumn : array<string|int, mixed>: Columns to group by
$_hasDataChanges : bool: Data changes flag (true after setData|unsetData call)
$_headersVisibility : bool: Column headers visibility
$_idFieldName : string: Name of object id field
$_isAnonymous : bool: Whether this block was not explicitly named
$_isDeleted : bool: Object delete flag
$_isExport : bool: Export flag
$_jsUrl : mixed
$_lastColumnId : mixed
$_layout : Mage_Core_Model_Layout: Parent layout of the block
$_massactionBlockName : string: Massaction block name
$_massactionIdField : string: Massaction row id field
$_massactionIdFilter : string: Massaction row id filter
$_messageBlockVisibility : bool: Massage block visibility
$_messagesBlock : Mage_Core_Block_Messages|null: Messages block instance
$_nameInLayout : string: Block name in layout
$_oldFieldsMap : array<string|int, mixed>: Map short fields names to its full names
$_pagerVisibility : bool: Pager visibility
$_parent : Mage_Core_Block_Abstract: Parent block
$_parentBlock : Mage_Core_Block_Abstract: Parent block
$_request : Zend_Controller_Request_Http: Request object
$_resourceCollectionName : mixed
$_rssLists : array<string|int, mixed>: RSS list
$_saveParametersInSession : mixed
$_showTemplateHints : mixed
$_showTemplateHintsAdmin : mixed
$_showTemplateHintsBlocks : mixed
$_showTemplateHintsBlocksAdmin : mixed
$_sortedChildren : array<string|int, mixed>: Sorted children list
$_sortInstructions : array<string|int, mixed>: Array of block sort priority instructions
$_storeIds : mixed
$_subtotals : array<string|int, mixed>: SubTotals
$_syncFieldsMap : mixed: Map of fields to sync to other fields upon changing their data
$_template : string: Path to template file in theme.
$_translationHelper : Mage_Core_Helper_Abstract|null: Translation helper instance
$_underscoreCache : array<string|int, mixed>: Setter/Getter underscore transformation cache
$_urlModel : Mage_Core_Model_Url: Url object
$_varNameDir : mixed
$_varNameFilter : mixed
$_varNameLimit : string: Page and sorting var names
$_varNamePage : mixed
$_varNameSort : mixed
$_varTotals : Varien_Object: Totals
$_viewDir : string: View scripts directory
$_viewVars : array<string|int, mixed>: Assigned variables for view
$defaultColumnSettings : null|array<string|int, array<string|int, array<string|int, mixed>>>
$_transportObject : Varien_Object

Methods

__() : string: Translate block sentence
__call() : mixed: Set/Get attribute wrapper
__construct() : mixed: Mage_Adminhtml_Block_Report_Grid_Abstract constructor.
__get() : mixed: Attribute getter (deprecated)
__set() : mixed: Attribute setter (deprecated)
__toArray() : array<string|int, mixed>: Convert object attributes to array
_exportIterateCollection() : mixed: Iterate collection and call callback method per item For callback method first argument always is item object
addCacheTag() : $this: Add tag to block
addColumn() : Mage_Adminhtml_Block_Report_Grid_Abstract: Add column to grid Overridden 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
addColumnAfter() : $this: Add column to grid after specified column.
addColumnDefaultData() : array<string|int, mixed>
addColumnsOrder() : $this: Add column view order
addData() : $this: Add data to the object.
addExportType() : $this: Add new export type to grid
addModelTags() : $this: Add tags from specified model to current block
addRssList() : $this: Add new rss list to grid
addToChildGroup() : mixed: Make sure specified block will be registered in the specified child groups
addToParentGroup() : $this: Add self to the specified group of parent block
append() : $this: Append child block
assign() : $this: Assign variable
canDisplayContainer() : bool
countChildren() : int: Get children blocks count
debug() : string|array<string|int, mixed>: Present object data as string in debug mode
escapeHtml() : null|string|array<string|int, string>: Escape html entities
escapeHtmlArrayAsObject() : array<string|int, Mage_Core_Model_Security_HtmlEscapedString>: Wrapper for escapeHtml() function with keeping original value
escapeHtmlAsObject() : Mage_Core_Model_Security_HtmlEscapedString: Wrapper for escapeHtml() function with keeping original value
escapeUrl() : string: Escape html entities in url
fetchView() : string: Retrieve block view from file (template)
flagDirty() : $this
formatDate() : string: Retrieve formatting date
formatTime() : string: Retrieve formatting time
formatTimezoneDate() : string: Retrieve formatting timezone date
getAbsoluteGridUrl() : string: Grid url getter Version of getGridUrl() but with parameters
getAction() : Mage_Core_Controller_Varien_Action: Retrieve current action object
getAnonSuffix() : string: Returns anonymous block suffix
getArea() : string: Get design area
getBaseUrl() : string: Get base url of the application
getBlockAlias() : string: Returns block alias
getBlockHtml() : string: Retrieve block html
getButtonHtml() : string: Create button and return its html
getCacheKey() : string: Get Key for caching block content
getCacheKeyInfo() : array<string|int, mixed>: Get cache key informative items Provide string array key to share specific info item with FPC placeholder
getCacheLifetime() : int|null: Get block cache lifetime
getCacheTags() : array<string|int, mixed>: Get tags array for saving cache
getChild() : mixed: Retrieve child block by name
getChildChildHtml() : string
getChildData() : mixed|void: Get a value from child block by specified key
getChildGroup() : array<string|int, mixed>: Get a group of child blocks
getChildHtml() : string: Retrieve child block HTML
getCollection() : Mage_Core_Model_Resource_Db_Collection_Abstract|Mage_Reports_Model_Grouped_Collection: get collection object
getColumn() : Mage_Adminhtml_Block_Widget_Grid_Column|false: Retrieve grid column by column id
getColumnCount() : int
getColumns() : array<string|int, Mage_Adminhtml_Block_Widget_Grid_Column>: Retrieve all grid columns
getColumnsOrder() : array<string|int, mixed>: Retrieve columns order
getConfigDefaultColumnSettings() : array<string|int, mixed>
getCountSubTotals() : bool: Return count subtotals
getCountTotals() : bool: Return count totals
getCsv() : string: Retrieve Grid data as CSV
getCsvFile() : array<string|int, mixed>: Retrieve a file container array by grid data as CSV
getCurrentCurrencyCode() : mixed
getCurrentUrl() : string: Get current url
getData() : mixed: Object data getter
getDataByKey() : mixed: Get object data by particular key
getDataByPath() : mixed: Get object data by path
getDataSetDefault() : mixed: Fast get data or set default if value is not available
getDataUsingMethod() : mixed: Get object data by key with calling getter method
getDirectOutput() : bool: Check if direct output is allowed for block
getEmptyCellColspan() : int: Retrieve colspan for empty cell
getEmptyCellLabel() : string: Retrieve label for empty cell
getEmptyText() : string: Return empty text for grid
getEmptyTextClass() : string: Return empty text CSS class
getExcel() : string: Retrieve grid data as MS Excel 2003 XML Document
getExcelFile() : array<string|int, mixed>: Retrieve a file container array by grid data as MS Excel 2003 XML Document
getExportButtonHtml() : string
getExportTypes() : array<string|int, mixed>|false: Retrieve grid export types
getFilterVisibility() : bool: Return visibility of filter
getFormKey() : string: Retrieve Session Form Key
getGlobalIcon() : string
getGridUrl() : string: Grid url getter
getHeadersVisibility() : bool: Return visibility of column headers
getHelper() : Mage_Core_Block_Abstract: Return block helper
getHtml() : string: Retrieve grid HTML
getHtmlId() : string
getIconDataUrl() : string
getIconSvg() : string
getId() : string: Retrieve object id
getIdFieldName() : string: Retrieve name of object id field
getIsAnonymous() : bool: Check if block is using auto generated (Anonymous) name
getItemsTags() : array<string|int, mixed>: Collect and retrieve items tags.
getJsObjectName() : string
getJsUrl() : string: Get url of base javascript file
getLastColumnId() : mixed
getLayout() : Mage_Core_Model_Layout: Retrieve layout object
getLimitOptions() : array<string|int, int>
getMainButtonsHtml() : string
getMassactionBlock() : Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract: Retrieve massaction block
getMassactionBlockHtml() : string
getMassactionBlockName() : string: Retrieve massaction block name
getMassactionIdField() : string: Retrieve massaction row identifier field
getMassactionIdFilter() : string: Retrieve massaction row identifier filter
getMessageBlockVisibility() : bool: Return visibility of filter
getMessagesBlock() : Mage_Core_Block_Messages: Retrieve messages block
getModuleName() : string: Retrieve module name of block
getMultipleRowColumns() : array<string|int, mixed>: Retrieve columns for multiple rows
getMultipleRows() : array<string|int, mixed>: Get children of specified item
getNameInLayout() : string: Alias for getName method.
getObjectData() : mixed: Get data from specified object
getPagerVisibility() : bool: Return visibility of pager
getParam() : mixed: Retrieve grid
getParentBlock() : $this: Retrieve parent block
getPosition() : string
getRate() : float: Get currency rate (base to given currency)
getRequest() : Mage_Core_Controller_Request_Http: Retrieve request object
getResetFilterButtonHtml() : string
getResourceCollectionName() : string
getRowId() : string
getRowspan() : int|bool: Retrieve rowspan number
getRowUrl() : string: Return row url for js event handlers
getRssLists() : array<string|int, mixed>|false: Retrieve rss lists types
getSearchButtonHtml() : string
getShowTemplateHints() : bool
getShowTemplateHintsAdmin() : bool
getSkinUrl() : string: Retrieve url of skins file
getSortedChildBlocks() : array<string|int, Mage_Core_Block_Abstract>: Obtain sorted child blocks
getSortedChildren() : array<string|int, mixed>: Retrieve sorted list of children.
getSubTotalColumns() : array<string|int, Mage_Adminhtml_Block_Widget_Grid_Column>: Retrieve columns to render
getSubTotalItem() : Varien_Object|string: Retrieve subtotal item
getSubTotals() : array<string|int, mixed>: Retrieve subtotal items
getTemplate() : string: Get relevant path to template
getTemplateFile() : string: Get absolute path to template
getTotals() : Varien_Object: Retrieve totals
getTranslationHelper() : Mage_Core_Helper_Abstract: Helper getter for translations
getUrl() : string: Generate url by route and parameters
getUrlBase64() : string: Generate base64-encoded url by route and parameters
getUrlEncoded() : string: Generate url-encoded url by route and parameters
getUrlSecure() : string: Generate security url by route and parameters (add form key if "Add Secret Key to URLs" disabled)
getVarNameDir() : string
getVarNameFilter() : string
getVarNameLimit() : string
getVarNamePage() : string
getVarNameSort() : string
getXml() : string
hasData() : bool: If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.
hasDataChanges() : bool: Get data change status
hasWrapperMustBeVisible() : bool
helper() : Mage_Core_Helper_Abstract: Returns helper object
htmlEscape() : string
insert() : object: Insert child block
isColumnGrouped() : bool|$this
isDeleted() : bool: Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value
isDirty() : bool
isEmpty() : bool: checks whether the object is empty
isModuleEnabled() : bool
isModuleOutputEnabled() : bool: Check whether the module output is enabled
isOutputEnabled() : bool
jsonDecode() : mixed: Decodes the given $encodedValue string which is encoded in the JSON format
jsonEncode() : string: Encode the mixed $valueToEncode into the JSON format
jsQuoteEscape() : mixed: Escape quotes in java scripts
maliciousCodeFilter() : string: Deleting script tags from string
offsetExists() : bool: Implementation of ArrayAccess::offsetExists()
offsetGet() : mixed: Implementation of ArrayAccess::offsetGet()
offsetSet() : void: Implementation of ArrayAccess::offsetSet()
offsetUnset() : void: Implementation of ArrayAccess::offsetUnset()
quoteEscape() : string: Escape quotes inside html attributes Use $addSlashes = false for escaping js that inside html attribute (onClick, onSubmit etc)
removeColumn() : $this: Remove existing column
renderView() : string: Render block
resetSavedParametersInSession() : mixed
serialize() : string: serialize object attributes
setAdditionalHtml() : $this
setAnonSuffix() : $this: Set anonymous suffix for current block
setAttribute() : $this: Set block attribute value
setBlockAlias() : $this: Set block alias
setBlockParams() : $this
setCacheKey() : $this
setCacheLifetime() : $this
setCacheTags() : $this
setChild() : $this: Set child block
setClass() : $this
setCollection() : mixed: set collection object
setContentHeading() : $this
setCountSubTotals() : $this: Set subtotals
setCountTotals() : mixed: Set count totals
setData() : $this: Overwrite data in the object.
setDataChanges() : $this: Clears data changes status
setDataUsingMethod() : $this: Set object data with calling setter method
setDefaultDir() : $this
setDefaultFilter() : $this
setDefaultLimit() : $this
setDefaultPage() : $this
setDefaultSort() : $this
setDestElementId() : $this
setDisabled() : $this
setDisplayMinimalPrice() : $this
setEmptyCellLabel() : $this: Set label for empty cell
setEmptyText() : $this: Set empty text for grid
setEmptyTextClass() : $this: Set empty text CSS class
setFilterVisibility() : mixed: Set visibility of filter
setFormAction() : $this
setFrameTags() : $this: Specify block output frame tags
setHeaderCss() : $this
setHeadersVisibility() : mixed: Set visibility of column headers
setId() : $this: Set object id field value
setIdFieldName() : $this: set name of object id field
setIdSuffix() : $this
setIsAnonymous() : $this: Set the anonymous flag
setLabel() : $this
setLayout() : $this: Set layout object
setMassactionBlockName() : $this: Set massaction block name
setMassactionIdField() : $this: Set massaction row identifier field
setMassactionIdFilter() : $this: Set massaction row identifier filter
setMessageBlockVisibility() : mixed: Set visibility of filter
setMessagesBlock() : $this: Set messages block
setNameInLayout() : $this: Set block's name in layout and unsets previous link if such exists.
setOnclick() : $this
setPagerVisibility() : mixed: Set visibility of pager
setParentBlock() : $this: Set parent block
setProduct() : $this
setSaveParametersInSession() : $this
setScriptPath() : $this: Set template location directory
setSortable() : $this
setStoreIds() : mixed
setSubTotals() : $this: Set subtotal items
setTemplate() : $this: Set path to template used for generating block's output.
setTemplate() : $this
setTitle() : $this
setTotals() : mixed: Set totals
setTranslationHelper() : $this: Helper setter for translations
setType() : $this
setUseAjax() : $this
setVarNameDir() : string
setVarNameFilter() : string
setVarNameLimit() : string
setVarNamePage() : string
setVarNameSort() : string
shouldRenderCell() : bool: Check whether should render cell
shouldRenderEmptyCell() : bool: Check whether should render empty cell
shouldRenderSubTotal() : bool: Check whether subtotal should be rendered
sortChildren() : $this: Sort block's children
sortColumnsByOrder() : $this: Sort columns by predefined order
stripTags() : string: Wrapper for standard strip_tags() function with extra functionality for html entities
toArray() : array<string|int, mixed>: Public wrapper for __toArray
toHtml() : string: Produce and return block's html output
toJson() : string: Public wrapper for __toJson
toString() : string: Public wrapper for __toString
toXml() : string: Public wrapper for __toXml
unsetCallChild() : $this: Call a child and unset it, if callback matched result
unsetChild() : $this: Unset child block
unsetChildren() : $this: Unset all children blocks
unsetData() : $this: Unset data from the object.
unsetOldData() : $this: Unset old fields data from the object.
urlEscape() : string
__toJson() : string: Convert object attributes to JSON
__toXml() : string: Convert object attributes to XML
_addBreadcrumb() : mixed
_addColumnFilterToCollection() : $this: Add filter
_addCustomFilter() : $this: Adds custom filter to resource collection Can be overridden in child classes if custom filter needed
_addFullNames() : mixed
_addLinkModelFilterCallback() : $this: Add link model filter from grid column to collection
_addOrderStatusFilter() : $this: Add order status filter
_afterCacheUrl() : string: Replace URLs from cache
_afterLoadCollection() : $this
_afterToHtml() : string: Processing block html after rendering
_beforeCacheUrl() : $this: Prepare url for save to cache
_beforeChildToHtml() : mixed: Prepare child block before generate html
_beforeLoadCollection() : $this
_beforeToHtml() : $this: Before rendering html, but after trying to load cache
_camelize() : string
_construct() : void: Internal constructor, that is called from real constructor
_decodeFilter() : mixed: Decode URL encoded filter value recursive callback method
_exportCsvItem() : mixed: Write item data to csv export file
_exportExcelItem() : mixed: Write item data to Excel 2003 XML export file
_getAggregatedColumns() : array<string|int, mixed>
_getAllowSymlinks() : bool: Get is allowed symlinks flag
_getApp() : Mage_Core_Model_App: Retrieve application instance
_getChildHtml() : string: Retrieve child block HTML
_getData() : mixed: Get value from _data array without parse key
_getExportHeaders() : array<string|int, mixed>: Retrieve Headers row array for Export
_getExportTotals() : array<string|int, mixed>: Retrieve Totals row array for Export
_getFactory() : Mage_Core_Model_Factory: Retrieve factory instance
_getFileContainerContent() : string: Retrieve file content from file container array
_getRssUrl() : string: Returns url for RSS Can be overloaded in descendant classes to perform custom changes to url passed to addRssList()
_getSidPlaceholder() : string: Get SID placeholder for cache
_getStoreIds() : array<string|int, mixed>: Get allowed store ids array intersected with selected scope in store switcher
_getTagsCacheKey() : string: Get cache key for tags
_getUrlModel() : Mage_Core_Model_Url: Create and return url object
_getUrlModelClass() : string: Returns url model class name
_initOldFieldsMap() : mixed: Inits mapping array of object's previously used fields to new fields.
_isSecure() : bool: Checks is request Url is secure
_loadCache() : string|false: Load block html from cache storage
_prepareArray() : array<string|int, mixed>: Set required array elements
_prepareCollection() : $this: Prepare grid collection object
_prepareColumns() : $this: Prepare columns for grid
_prepareGrid() : $this
_prepareLayout() : $this: Preparing global layout
_prepareMassaction() : $this: Prepare grid massaction actions
_prepareMassactionBlock() : $this: Prepare grid massaction block
_prepareMassactionColumn() : $this: Prepare grid massaction column
_preparePage() : mixed
_prepareSyncFieldsMap() : $this: Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.
_saveCache() : $this|false: Save block content to cache storage
_setCollectionOrder() : $this: Sets sorting order by some column
_setFilterValues() : $this
_toHtml() : string: Prepare html output
_underscore() : string: Converts field names for setters and getters
_getCacheHintStatusColor() : string: Retrieve block cache status

CACHE_GROUP

Cache group Tag


    public
        mixed
    CACHE_GROUP
    = 'block_html'

CACHE_KEY_PREFIX

Prefix for cache key


    public
        mixed
    CACHE_KEY_PREFIX
    = 'BLOCK_'

CACHE_TAGS_DATA_KEY

Cache tags data key


    public
        mixed
    CACHE_TAGS_DATA_KEY
    = 'cache_tags'

XML_PATH_DEBUG_TEMPLATE_HINTS


    public
        mixed
    XML_PATH_DEBUG_TEMPLATE_HINTS
    = 'dev/debug/template_hints'

XML_PATH_DEBUG_TEMPLATE_HINTS_ADMIN


    public
        mixed
    XML_PATH_DEBUG_TEMPLATE_HINTS_ADMIN
    = 'dev/debug/template_hints_admin'

XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS


    public
        mixed
    XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS
    = 'dev/debug/template_hints_blocks'

XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS_ADMIN


    public
        mixed
    XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS_ADMIN
    = 'dev/debug/template_hints_blocks_admin'

XML_PATH_TEMPLATE_ALLOW_SYMLINK


    public
        mixed
    XML_PATH_TEMPLATE_ALLOW_SYMLINK
    = 'dev/template/allow_symlink'

$_aggregatedColumns


    protected
        mixed
    $_aggregatedColumns
     = \null

$_alias

Short alias of this block that was referred from parent


    protected
        string
    $_alias

$_anonSuffix

Suffix for name of anonymous block


    protected
        string
    $_anonSuffix

$_app

Application instance


    protected
        Mage_Core_Model_App|null
    $_app

$_baseUrl


    protected
        mixed
    $_baseUrl

$_childGroups

Arbitrary groups of child blocks


    protected
        array<string|int, mixed>
    $_childGroups
     = []

$_children

Contains references to child block objects


    protected
        array<string|int, Mage_Core_Block_Abstract>
    $_children
     = []

$_childrenHtmlCache

Children blocks HTML cache array


    protected
        array<string|int, mixed>
    $_childrenHtmlCache
     = []

$_collection

Collection object


    protected
        Varien_Data_Collection_Db|null
    $_collection
     = \null

$_columnGroupBy

Column for grid to be grouped by


    protected
        string
    $_columnGroupBy

$_columns

Columns array


    protected
        array<string|int, mixed>
    $_columns
     = []

array( 'header' => string, 'width' => int, 'sortable' => bool, 'index' => string, //'renderer' => Mage_Adminhtml_Block_Widget_Grid_Column_Renderer_Interface, 'format' => string 'total' => string (sum, avg) )

$_columnsOrder

Columns view order


    protected
        array<string|int, mixed>
    $_columnsOrder
     = []

$_countSubTotals

Count subtotals


    protected
        bool
    $_countSubTotals
     = \false

$_countTotals

Count totals


    protected
        bool
    $_countTotals
     = \false

$_currentCurrencyCode


    protected
        mixed
    $_currentCurrencyCode
     = \null

$_data

Object attributes


    protected
        array<string|int, mixed>|null
    $_data
     = []

$_defaultDir


    protected
        mixed
    $_defaultDir
     = 'desc'

$_defaultFilter


    protected
        mixed
    $_defaultFilter
     = []

$_defaultLimit


    protected
        mixed
    $_defaultLimit
     = 20

$_defaultPage


    protected
        mixed
    $_defaultPage
     = 1

$_defaultSort


    protected
        mixed
    $_defaultSort
     = \false

$_dirty


    protected
        array<string|int, mixed>
    $_dirty

$_emptyCellLabel

Label for empty cell


    protected
        string
    $_emptyCellLabel
     = ''

$_emptyText

Empty grid text


    protected
        string|null
    $_emptyText

$_emptyTextCss

Empty grid text CSS class


    protected
        string|null
    $_emptyTextCss
     = 'a-center'

$_exportPageSize

Rows per page for import


    protected
        int
    $_exportPageSize
     = 1000

$_exportTypes

Grid export types


    protected
        array<string|int, mixed>
    $_exportTypes
     = []

$_factory

Factory instance


    protected
        Mage_Core_Model_Factory|null
    $_factory

$_filterVisibility

Filter visibility


    protected
        bool
    $_filterVisibility
     = \true

$_frameCloseTag

Block html frame close tag


    protected
        string
    $_frameCloseTag

$_frameOpenTag

Block html frame open tag


    protected
        string
    $_frameOpenTag

$_groupedColumn

Columns to group by


    protected
        array<string|int, mixed>
    $_groupedColumn
     = []

$_hasDataChanges

Data changes flag (true after setData|unsetData call)


    protected
        bool
    $_hasDataChanges
     = \false

$_headersVisibility

Column headers visibility


    protected
        bool
    $_headersVisibility
     = \true

$_idFieldName

Name of object id field


    protected
        string
    $_idFieldName
     = \null

$_isAnonymous

Whether this block was not explicitly named


    protected
        bool
    $_isAnonymous
     = \false

$_isDeleted

Object delete flag


    protected
        bool
    $_isDeleted
     = \false

$_isExport

Export flag


    protected
        bool
    $_isExport
     = \false

$_jsUrl


    protected
        mixed
    $_jsUrl

$_lastColumnId


    protected
        mixed
    $_lastColumnId

$_layout

Parent layout of the block


    protected
        Mage_Core_Model_Layout
    $_layout

$_massactionBlockName

Massaction block name


    protected
        string
    $_massactionBlockName
     = 'adminhtml/widget_grid_massaction'

$_massactionIdField

Massaction row id field


    protected
        string
    $_massactionIdField
     = \null

$_massactionIdFilter

Massaction row id filter


    protected
        string
    $_massactionIdFilter
     = \null

$_messageBlockVisibility

Massage block visibility


    protected
        bool
    $_messageBlockVisibility
     = \false

$_messagesBlock

Messages block instance


    protected
        Mage_Core_Block_Messages|null
    $_messagesBlock
     = \null

$_nameInLayout

Block name in layout


    protected
        string
    $_nameInLayout

$_oldFieldsMap

Map short fields names to its full names


    protected
        array<string|int, mixed>
    $_oldFieldsMap
     = []

$_pagerVisibility

Pager visibility


    protected
        bool
    $_pagerVisibility
     = \true

$_parent

Parent block


    protected
        Mage_Core_Block_Abstract
    $_parent

$_parentBlock

Parent block


    protected
        Mage_Core_Block_Abstract
    $_parentBlock

$_request

Request object


    protected
        Zend_Controller_Request_Http
    $_request

$_resourceCollectionName


    protected
        mixed
    $_resourceCollectionName
     = ''

$_rssLists

RSS list


    protected
        array<string|int, mixed>
    $_rssLists
     = []

$_saveParametersInSession


    protected
        mixed
    $_saveParametersInSession
     = \false

$_showTemplateHints


    protected
    static    mixed
    $_showTemplateHints

$_showTemplateHintsAdmin


    protected
    static    mixed
    $_showTemplateHintsAdmin

$_showTemplateHintsBlocks


    protected
    static    mixed
    $_showTemplateHintsBlocks

$_showTemplateHintsBlocksAdmin


    protected
    static    mixed
    $_showTemplateHintsBlocksAdmin

$_sortedChildren

Sorted children list


    protected
        array<string|int, mixed>
    $_sortedChildren
     = []

$_sortInstructions

Array of block sort priority instructions


    protected
        array<string|int, mixed>
    $_sortInstructions
     = []

$_storeIds


    protected
        mixed
    $_storeIds
     = []

$_subtotals

SubTotals


    protected
        array<string|int, mixed>
    $_subtotals
     = []

$_syncFieldsMap

Map of fields to sync to other fields upon changing their data


    protected
        mixed
    $_syncFieldsMap
     = []

$_template

Path to template file in theme.


    protected
        string
    $_template
     = ''

$_translationHelper

Translation helper instance


    protected
        Mage_Core_Helper_Abstract|null
    $_translationHelper
     = \null

$_underscoreCache

Setter/Getter underscore transformation cache


    protected
    static    array<string|int, mixed>
    $_underscoreCache
     = []

$_urlModel

Url object


    protected
    static    Mage_Core_Model_Url
    $_urlModel

$_varNameDir


    protected
        mixed
    $_varNameDir
     = 'dir'

$_varNameFilter


    protected
        mixed
    $_varNameFilter
     = 'filter'

$_varNameLimit

Page and sorting var names


    protected
        string
    $_varNameLimit
     = 'limit'

$_varNamePage


    protected
        mixed
    $_varNamePage
     = 'page'

$_varNameSort


    protected
        mixed
    $_varNameSort
     = 'sort'

$_varTotals

Totals


    protected
        Varien_Object
    $_varTotals

$_viewDir

View scripts directory


    protected
        string
    $_viewDir
     = ''

$_viewVars

Assigned variables for view


    protected
        array<string|int, mixed>
    $_viewVars
     = []

$defaultColumnSettings


    protected
        null|array<string|int, array<string|int, array<string|int, mixed>>>
    $defaultColumnSettings
     = \null

$_transportObject


    private
    static    Varien_Object
    $_transportObject

__()

Translate block sentence


    public
                    __() : string

Return values

string

__call()

Set/Get attribute wrapper


    public
                    __call(string $method, array<string|int, mixed> $args) : mixed

Parameters

$method : string
$args : array<string|int, mixed>

__construct()

Mage_Adminhtml_Block_Report_Grid_Abstract constructor.


    public
                    __construct() : mixed

__get()

Attribute getter (deprecated)


    public
                    __get(string $var) : mixed

Parameters

$var : string

__set()

Attribute setter (deprecated)


    public
                    __set(string $var, mixed $value) : mixed

Parameters

$var : string
$value : mixed

__toArray()

Convert object attributes to array


    public
                    __toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

array<string|int, mixed>

_exportIterateCollection()

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


    public
                    _exportIterateCollection(string $callback, array<string|int, mixed> $args) : mixed

Parameters

$callback : string
$args : array<string|int, mixed>: additional arguments for callback method

addCacheTag()

Add tag to block


    public
                    addCacheTag(string|array<string|int, mixed> $tag) : $this

Parameters

$tag : string|array<string|int, mixed>

Return values

$this

addColumn()

Add column to grid Overridden 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


    public
                    addColumn(string $columnId, array<string|int, mixed> $column) : Mage_Adminhtml_Block_Report_Grid_Abstract

Parameters

$columnId : string
$column : array<string|int, mixed>

#[Override]

Return values

Mage_Adminhtml_Block_Report_Grid_Abstract

addColumnAfter()

Add column to grid after specified column.


    public
                    addColumnAfter(string $columnId, array<string|int, mixed>|Varien_Object $column, string $after) : $this

Parameters

$columnId : string
$column : array<string|int, mixed>|Varien_Object
$after : string

Return values

$this

addColumnDefaultData()


    public
                    addColumnDefaultData(array<string|int, mixed> $column) : array<string|int, mixed>

Parameters

$column : array<string|int, mixed>

Return values

array<string|int, mixed>

addColumnsOrder()

Add column view order


    public
                    addColumnsOrder(string $columnId, string $after) : $this

Parameters

$columnId : string
$after : string

Return values

$this

addData()

Add data to the object.


    public
                    addData(array<string|int, mixed> $arr) : $this

Retains previous data in the object.

Parameters

$arr : array<string|int, mixed>

Return values

$this

addExportType()

Add new export type to grid


    public
                    addExportType(string $url, string $label) : $this

Parameters

$url : string
$label : string

Return values

$this

addModelTags()

Add tags from specified model to current block


    public
                    addModelTags(Mage_Core_Model_Abstract $model) : $this

Parameters

$model : Mage_Core_Model_Abstract

Return values

$this

addRssList()

Add new rss list to grid


    public
                    addRssList(string $url, string $label) : $this

Parameters

$url : string
$label : string

Return values

$this

addToChildGroup()

Make sure specified block will be registered in the specified child groups


    public
                    addToChildGroup(string $groupName, Mage_Core_Block_Abstract $child) : mixed

Parameters

$groupName : string
$child : Mage_Core_Block_Abstract

addToParentGroup()

Add self to the specified group of parent block


    public
                    addToParentGroup(string $groupName) : $this

Parameters

$groupName : string

Return values

$this

append()

Append child block


    public
                    append(Mage_Core_Block_Abstract|string $block[, string $alias = '' ]) : $this

Parameters

$block : Mage_Core_Block_Abstract|string
$alias : string = ''

Return values

$this

assign()

Assign variable


    public
                    assign(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this

Parameters

$key : string|array<string|int, mixed>
$value : mixed = null

Return values

$this

canDisplayContainer()


    public
                    canDisplayContainer() : bool

Return values

bool

countChildren()

Get children blocks count


    public
                    countChildren() : int

Return values

int

debug()

Present object data as string in debug mode


    public
                    debug([mixed $data = null ][, array<string|int, mixed> &$objects = [] ]) : string|array<string|int, mixed>

Parameters

$data : mixed = null
$objects : array<string|int, mixed> = []

Return values

string|array<string|int, mixed>

escapeHtml()

Escape html entities


    public
                    escapeHtml(string|array<string|int, string> $data[, array<string|int, mixed>|null $allowedTags = null ]) : null|string|array<string|int, string>

Parameters

$data : string|array<string|int, string>
$allowedTags : array<string|int, mixed>|null = null

Return values

null|string|array<string|int, string>

escapeHtmlArrayAsObject()

Wrapper for escapeHtml() function with keeping original value


    public
                    escapeHtmlArrayAsObject(array<string|int, string> $data[, array<string|int, string>|null $allowedTags = null ]) : array<string|int, Mage_Core_Model_Security_HtmlEscapedString>

Parameters

$data : array<string|int, string>
$allowedTags : array<string|int, string>|null = null

Return values

array<string|int, Mage_Core_Model_Security_HtmlEscapedString> —

@see Mage_Core_Model_Security_HtmlEscapedString::getUnescapedValue()

escapeHtmlAsObject()

Wrapper for escapeHtml() function with keeping original value


    public
                    escapeHtmlAsObject(string $data[, array<string|int, string>|null $allowedTags = null ]) : Mage_Core_Model_Security_HtmlEscapedString

Parameters

$data : string
$allowedTags : array<string|int, string>|null = null

Return values

Mage_Core_Model_Security_HtmlEscapedString

escapeUrl()

Escape html entities in url


    public
                    escapeUrl(string $data) : string

Parameters

$data : string

Return values

string

fetchView()

Retrieve block view from file (template)


    public
                    fetchView(string $fileName) : string

Parameters

$fileName : string

Return values

string

flagDirty()


    public
                    flagDirty(string $field[, bool $flag = true ]) : $this

Parameters

$field : string
$flag : bool = true

Return values

$this

formatDate()

Retrieve formatting date


    public
                    formatDate([string|int|Zend_Date|null $date = null ][, string $format = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT ][, bool $showTime = false ]) : string

Parameters

$date : string|int|Zend_Date|null = null
$format : string = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT
$showTime : bool = false

Return values

string

formatTime()

Retrieve formatting time


    public
                    formatTime([string $time = null ][, string $format = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT ][, bool $showDate = false ]) : string

Parameters

$time : string = null
$format : string = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT
$showDate : bool = false

Return values

string

formatTimezoneDate()

Retrieve formatting timezone date


    public
                    formatTimezoneDate([string|int|Zend_Date|null $date = null ][, string $format = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT ][, bool $showTime = false ][, bool $useTimezone = true ]) : string

Parameters

$date : string|int|Zend_Date|null = null
$format : string = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT
$showTime : bool = false
$useTimezone : bool = true

Return values

string

getAbsoluteGridUrl()

Grid url getter Version of getGridUrl() but with parameters


    public
                    getAbsoluteGridUrl([array<string|int, mixed> $params = [] ]) : string

Parameters

$params : array<string|int, mixed> = []: url parameters

Return values

string —

current grid url

getAction()

Retrieve current action object


    public
                    getAction() : Mage_Core_Controller_Varien_Action

Return values

Mage_Core_Controller_Varien_Action

getAnonSuffix()

Returns anonymous block suffix


    public
                    getAnonSuffix() : string

Return values

string

getArea()

Get design area


    public
                    getArea() : string

Return values

string

getBaseUrl()

Get base url of the application


    public
                    getBaseUrl() : string

Return values

string

getBlockAlias()

Returns block alias


    public
                    getBlockAlias() : string

Return values

string

getBlockHtml()

Retrieve block html


    public
                    getBlockHtml(string $name) : string

Parameters

$name : string

Return values

string

getButtonHtml()

Create button and return its html


    public
                    getButtonHtml(string $label, string $onclick[, string $class = '' ][, string $id = null ]) : string

Parameters

$label : string
$onclick : string
$class : string = ''
$id : string = null

Return values

string

getCacheKey()

Get Key for caching block content


    public
                    getCacheKey() : string

Return values

string

getCacheKeyInfo()

Get cache key informative items Provide string array key to share specific info item with FPC placeholder


    public
                    getCacheKeyInfo() : array<string|int, mixed>

#[Override]

Return values

array<string|int, mixed>

getCacheLifetime()

Get block cache lifetime


    public
                    getCacheLifetime() : int|null

Return values

int|null

getCacheTags()

Get tags array for saving cache


    public
                    getCacheTags() : array<string|int, mixed>

Return values

array<string|int, mixed>

getChild()

Retrieve child block by name


    public
                    getChild([string $name = '' ]) : mixed

Parameters

$name : string = ''

getChildChildHtml()


    public
                    getChildChildHtml(string $name[, string $childName = '' ][, bool $useCache = true ][, bool $sorted = false ]) : string

Parameters

$name : string: Parent block name
$childName : string = '': OPTIONAL Child block name
$useCache : bool = true: OPTIONAL Use cache flag
$sorted : bool = false: OPTIONAL @see getChildHtml()

Return values

string

getChildData()

Get a value from child block by specified key


    public
                    getChildData(string $alias[, string $key = '' ]) : mixed|void

Parameters

$alias : string
$key : string = ''

Return values

mixed|void

getChildGroup()

Get a group of child blocks


    public
                    getChildGroup(string $groupName[, string $callback = null ][, bool $skipEmptyResults = true ]) : array<string|int, mixed>

Returns an array of => or an array of => <callback_result> The callback currently supports only $this methods and passes the alias as parameter

Parameters

$groupName : string
$callback : string = null
$skipEmptyResults : bool = true

Return values

array<string|int, mixed>

getChildHtml()

Retrieve child block HTML


    public
                    getChildHtml([string $name = '' ][, bool $useCache = true ][, bool $sorted = false ]) : string

Parameters

$name : string = ''
$useCache : bool = true
$sorted : bool = false

Return values

string

getCollection()

get collection object


    public
                    getCollection() : Mage_Core_Model_Resource_Db_Collection_Abstract|Mage_Reports_Model_Grouped_Collection

#[Override]

Return values

Mage_Core_Model_Resource_Db_Collection_Abstract|Mage_Reports_Model_Grouped_Collection

getColumn()

Retrieve grid column by column id


    public
                    getColumn(string $columnId) : Mage_Adminhtml_Block_Widget_Grid_Column|false

Parameters

$columnId : string

Return values

Mage_Adminhtml_Block_Widget_Grid_Column|false

getColumnCount()


    public
                    getColumnCount() : int

Return values

int

getColumns()

Retrieve all grid columns


    public
                    getColumns() : array<string|int, Mage_Adminhtml_Block_Widget_Grid_Column>

Return values

array<string|int, Mage_Adminhtml_Block_Widget_Grid_Column>

getColumnsOrder()

Retrieve columns order


    public
                    getColumnsOrder() : array<string|int, mixed>

Return values

array<string|int, mixed>

getConfigDefaultColumnSettings()


    public
                    getConfigDefaultColumnSettings() : array<string|int, mixed>

Return values

array<string|int, mixed>

getCountSubTotals()

Return count subtotals


    public
                    getCountSubTotals() : bool

Return values

bool

getCountTotals()

Return count totals


    public
                    getCountTotals() : bool

#[Override]

Return values

bool

getCsv()

Retrieve Grid data as CSV


    public
                    getCsv([string $fileName = '' ][, int $limit = 0 ]) : string

the original way (still working): $this->_prepareDownloadResponse($fileName, $grid->getCsv()); or (with right content type): $this->_prepareDownloadResponse($fileName, $grid->getCsv(), 'text/csv'); the new way: $this->_prepareDownloadResponse(...$grid->getCsv($fileName, -1));

Parameters

$fileName : string = ''
$limit : int = 0

Return values

string

getCsvFile()

Retrieve a file container array by grid data as CSV


    public
                    getCsvFile([string $fileName = '' ][, int $limit = 0 ]) : array<string|int, mixed>

Return array with keys type and value [the original way] Return array with keys file name, type and value, file mime type [the new way]

the original way (still working): $this->_prepareDownloadResponse($fileName, $grid->getCsvFile($fileName)); or (with right content type): $this->_prepareDownloadResponse($fileName, $grid->getCsvFile($fileName), 'text/csv'); the new way: $this->_prepareDownloadResponse(...$grid->getCsvFile($fileName, -1));

Parameters

$fileName : string = ''
$limit : int = 0

Return values

array<string|int, mixed>

getCurrentCurrencyCode()


    public
                    getCurrentCurrencyCode() : mixed

getCurrentUrl()

Get current url


    public
                    getCurrentUrl([array<string|int, mixed> $params = [] ]) : string

Parameters

$params : array<string|int, mixed> = []: url parameters

Return values

string —

current url

getData()

Object data getter


    public
                    getData([string $key = '' ][, string|int $index = null ]) : mixed

If $key is not defined will return all the data as an array. Otherwise, it will return value of the element specified by $key. It is possible to use keys like a/b/c for access nested array data

If $index is specified it will assume that attribute data is an array and retrieve corresponding member. If data is the string - it will be explode by new line character and converted to array.

Parameters

$key : string = ''
$index : string|int = null

getDataByKey()

Get object data by particular key


    public
                    getDataByKey(string $key) : mixed

Parameters

$key : string

getDataByPath()

Get object data by path


    public
                    getDataByPath(string $path) : mixed

Method consider the path as chain of keys: a/b/c => ['a']['b']['c']

Parameters

$path : string

getDataSetDefault()

Fast get data or set default if value is not available


    public
                    getDataSetDefault(string $key, mixed $default) : mixed

Parameters

$key : string
$default : mixed

getDataUsingMethod()

Get object data by key with calling getter method


    public
                    getDataUsingMethod(string $key[, mixed $args = null ]) : mixed

Parameters

$key : string
$args : mixed = null

getDirectOutput()

Check if direct output is allowed for block


    public
                    getDirectOutput() : bool

Return values

bool

getEmptyCellColspan()

Retrieve colspan for empty cell


    public
                    getEmptyCellColspan() : int

Return values

int

getEmptyCellLabel()

Retrieve label for empty cell


    public
                    getEmptyCellLabel() : string

Return values

string

getEmptyText()

Return empty text for grid


    public
                    getEmptyText() : string

Return values

string

getEmptyTextClass()

Return empty text CSS class


    public
                    getEmptyTextClass() : string

Return values

string

getExcel()

Retrieve grid data as MS Excel 2003 XML Document


    public
                    getExcel([string $fileName = '' ][, int $limit = 0 ]) : string

the original way (still working): $this->_prepareDownloadResponse($fileName, $grid->getExcel($fileName)); or (with right content type): $this->_prepareDownloadResponse($fileName, $grid->getExcel($fileName), 'application/vnd.ms-excel'); the new way: $this->_prepareDownloadResponse(...$grid->getExcel($fileName, -1));

Parameters

$fileName : string = ''
$limit : int = 0

Return values

string

getExcelFile()

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


    public
                    getExcelFile([string $sheetName = '' ][, int $limit = 0 ]) : array<string|int, mixed>

Return array with keys type and value [the original way] Return array with keys file name, type and value, file mime type [the new way]

the original way (still working): $this->_prepareDownloadResponse($fileName, $grid->getExcelFile($fileName)); or (with right content type): $this->_prepareDownloadResponse($fileName, $grid->getExcelFile($fileName), 'text/csv'); the new way: $this->_prepareDownloadResponse(...$grid->getExcelFile($fileName, -1));

Parameters

$sheetName : string = ''
$limit : int = 0

Return values

array<string|int, mixed>

getExportButtonHtml()


    public
                    getExportButtonHtml() : string

Return values

string

getExportTypes()

Retrieve grid export types


    public
                    getExportTypes() : array<string|int, mixed>|false

Return values

array<string|int, mixed>|false

getFilterVisibility()

Return visibility of filter


    public
                    getFilterVisibility() : bool

Return values

bool

getFormKey()

Retrieve Session Form Key


    public
                    getFormKey() : string

#[Override]

Return values

string

getGlobalIcon()


    public
                    getGlobalIcon() : string

Return values

string

getGridUrl()

Grid url getter


    public
                    getGridUrl() : string

after 1.3.2.3 Use getAbsoluteGridUrl() method instead

Return values

string —

current grid url

getHeadersVisibility()

Return visibility of column headers


    public
                    getHeadersVisibility() : bool

Return values

bool

getHelper()

Return block helper


    public
                    getHelper(string $type) : Mage_Core_Block_Abstract

Parameters

$type : string

Return values

Mage_Core_Block_Abstract

getHtml()

Retrieve grid HTML


    public
                    getHtml() : string

Return values

string

getHtmlId()


    public
                    getHtmlId() : string

Return values

string

getIconDataUrl()


    public
                    getIconDataUrl(string $name[, string $variant = 'outline' ][, array<string|int, mixed> $attributes = [] ]) : string

Parameters

$name : string
$variant : string = 'outline'
$attributes : array<string|int, mixed> = []

Return values

string

getIconSvg()


    public
                    getIconSvg(string $name[, string $variant = 'outline' ]) : string

Parameters

$name : string
$variant : string = 'outline'

Return values

string

getId()

Retrieve object id


    public
                    getId() : string

#[Override]

Return values

string

getIdFieldName()

Retrieve name of object id field


    public
                    getIdFieldName() : string

Return values

string

getIsAnonymous()

Check if block is using auto generated (Anonymous) name


    public
                    getIsAnonymous() : bool

Return values

bool

getItemsTags()

Collect and retrieve items tags.


    public
                    getItemsTags(array<string|int, mixed>|Varien_Data_Collection $items) : array<string|int, mixed>

Item should implement Mage_Core_Model_Abstract::getCacheIdTags method

Parameters

$items : array<string|int, mixed>|Varien_Data_Collection

Return values

array<string|int, mixed>

getJsObjectName()


    public
                    getJsObjectName() : string

Return values

string

getJsUrl()

Get url of base javascript file


    public
                    getJsUrl([string $fileName = '' ]) : string

To get url of skin javascript file use getSkinUrl()

Parameters

$fileName : string = ''

Return values

string

getLastColumnId()


    public
                    getLastColumnId() : mixed

getLayout()

Retrieve layout object


    public
                    getLayout() : Mage_Core_Model_Layout

Return values

Mage_Core_Model_Layout

getLimitOptions()


    public
                    getLimitOptions() : array<string|int, int>

Return values

array<string|int, int>

getMainButtonsHtml()


    public
                    getMainButtonsHtml() : string

Return values

string

getMassactionBlock()

Retrieve massaction block


    public
                    getMassactionBlock() : Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract

Return values

Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract

getMassactionBlockHtml()


    public
                    getMassactionBlockHtml() : string

Return values

string

getMassactionBlockName()

Retrieve massaction block name


    public
                    getMassactionBlockName() : string

Return values

string

getMassactionIdField()

Retrieve massaction row identifier field


    public
                    getMassactionIdField() : string

Return values

string

getMassactionIdFilter()

Retrieve massaction row identifier filter


    public
                    getMassactionIdFilter() : string

Return values

string

getMessageBlockVisibility()

Return visibility of filter


    public
                    getMessageBlockVisibility() : bool

Return values

bool

getMessagesBlock()

Retrieve messages block


    public
                    getMessagesBlock() : Mage_Core_Block_Messages

Return values

Mage_Core_Block_Messages

getModuleName()

Retrieve module name of block


    public
                    getModuleName() : string

Return values

string

getMultipleRowColumns()

Retrieve columns for multiple rows


    public
                    getMultipleRowColumns() : array<string|int, mixed>

Return values

array<string|int, mixed>

getMultipleRows()

Get children of specified item


    public
                    getMultipleRows(Varien_Object $item) : array<string|int, mixed>

Parameters

$item : Varien_Object

Return values

array<string|int, mixed>

getNameInLayout()

Alias for getName method.


    public
                    getNameInLayout() : string

Return values

string

getObjectData()

Get data from specified object


    public
                    getObjectData(Varien_Object $object, string $key) : mixed

Parameters

$object : Varien_Object
$key : string

getPagerVisibility()

Return visibility of pager


    public
                    getPagerVisibility() : bool

Return values

bool

getParam()

Retrieve grid


    public
                    getParam(string $paramName[, mixed $default = null ]) : mixed

Parameters

$paramName : string
$default : mixed = null

getParentBlock()

Retrieve parent block


    public
                    getParentBlock() : $this

Return values

$this

getPosition()


    public
                    getPosition() : string

Return values

string

getRate()

Get currency rate (base to given currency)


    public
                    getRate(string|Mage_Directory_Model_Currency $toCurrency) : float

Parameters

$toCurrency : string|Mage_Directory_Model_Currency

Return values

float

getRequest()

Retrieve request object


    public
                    getRequest() : Mage_Core_Controller_Request_Http

Return values

Mage_Core_Controller_Request_Http

getResetFilterButtonHtml()


    public
                    getResetFilterButtonHtml() : string

Return values

string

getResourceCollectionName()


    public
                    getResourceCollectionName() : string

Return values

string

getRowId()


    public
                    getRowId(Varien_Object $row) : string

since 1.1.7

Parameters

$row : Varien_Object

Return values

string

getRowspan()

Retrieve rowspan number


    public
                    getRowspan(Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column) : int|bool

Parameters

$item : Varien_Object
$column : Mage_Adminhtml_Block_Widget_Grid_Column

Return values

int|bool

getRowUrl()

Return row url for js event handlers


    public
                    getRowUrl(Varien_Object $row) : string

Parameters

$row : Varien_Object

Return values

string

getRssLists()

Retrieve rss lists types


    public
                    getRssLists() : array<string|int, mixed>|false

Return values

array<string|int, mixed>|false

getSearchButtonHtml()


    public
                    getSearchButtonHtml() : string

Return values

string

getShowTemplateHints()


    public
                    getShowTemplateHints() : bool

Return values

bool

getShowTemplateHintsAdmin()


    public
                    getShowTemplateHintsAdmin() : bool

Return values

bool

getSkinUrl()

Retrieve url of skins file


    public
                    getSkinUrl([string $file = null ][, array<string|int, mixed> $params = [] ]) : string

Parameters

$file : string = null: path to file in skin
$params : array<string|int, mixed> = []

Return values

string

getSortedChildBlocks()

Obtain sorted child blocks


    public
                    getSortedChildBlocks() : array<string|int, Mage_Core_Block_Abstract>

Return values

array<string|int, Mage_Core_Block_Abstract>

getSortedChildren()

Retrieve sorted list of children.


    public
                    getSortedChildren() : array<string|int, mixed>

Return values

array<string|int, mixed>

getSubTotalColumns()

Retrieve columns to render


    public
                    getSubTotalColumns() : array<string|int, Mage_Adminhtml_Block_Widget_Grid_Column>

Return values

array<string|int, Mage_Adminhtml_Block_Widget_Grid_Column>

getSubTotalItem()

Retrieve subtotal item


    public
                    getSubTotalItem(Varien_Object $item) : Varien_Object|string

Parameters

$item : Varien_Object

Return values

Varien_Object|string

getSubTotals()

Retrieve subtotal items


    public
                    getSubTotals() : array<string|int, mixed>

#[Override]

Return values

array<string|int, mixed>

getTemplate()

Get relevant path to template


    public
                    getTemplate() : string

Return values

string

getTemplateFile()

Get absolute path to template


    public
                    getTemplateFile() : string

Return values

string

getTotals()

Retrieve totals


    public
                    getTotals() : Varien_Object

Return values

Varien_Object

getTranslationHelper()

Helper getter for translations


    public
                    getTranslationHelper() : Mage_Core_Helper_Abstract

Return values

Mage_Core_Helper_Abstract

getUrl()

Generate url by route and parameters


    public
                    getUrl([string $route = '' ][, array<string|int, mixed> $params = [] ]) : string

Parameters

$route : string = ''
$params : array<string|int, mixed> = []

Return values

string

getUrlBase64()

Generate base64-encoded url by route and parameters


    public
                    getUrlBase64([string $route = '' ][, array<string|int, mixed> $params = [] ]) : string

Parameters

$route : string = ''
$params : array<string|int, mixed> = []

Return values

string

getUrlEncoded()

Generate url-encoded url by route and parameters


    public
                    getUrlEncoded([string $route = '' ][, array<string|int, mixed> $params = [] ]) : string

Parameters

$route : string = ''
$params : array<string|int, mixed> = []

Return values

string

getUrlSecure()

Generate security url by route and parameters (add form key if "Add Secret Key to URLs" disabled)


    public
                    getUrlSecure([string $route = '' ][, array<string|int, mixed> $params = [] ]) : string

Parameters

$route : string = ''
$params : array<string|int, mixed> = []

Return values

string

getVarNameDir()


    public
                    getVarNameDir() : string

Return values

string

getVarNameFilter()


    public
                    getVarNameFilter() : string

Return values

string

getVarNameLimit()


    public
                    getVarNameLimit() : string

Return values

string

getVarNamePage()


    public
                    getVarNamePage() : string

Return values

string

getVarNameSort()


    public
                    getVarNameSort() : string

Return values

string

getXml()


    public
                    getXml() : string

Return values

string

hasData()

If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.


    public
                    hasData([string $key = '' ]) : bool

Parameters

$key : string = ''

Return values

bool

hasDataChanges()

Get data change status


    public
                    hasDataChanges() : bool

Return values

bool

hasWrapperMustBeVisible()


    public
                    hasWrapperMustBeVisible() : bool

Return values

bool

helper()

Returns helper object


    public
                    helper(string $name) : Mage_Core_Helper_Abstract

Parameters

$name : string

Return values

Mage_Core_Helper_Abstract

htmlEscape()


    public
                    htmlEscape(string|array<string|int, mixed> $data[, array<string|int, mixed> $allowedTags = null ]) : string

after 1.4.0.0-rc1

Parameters

$data : string|array<string|int, mixed>
$allowedTags : array<string|int, mixed> = null

Return values

string

insert()

Insert child block


    public
                    insert(Mage_Core_Block_Abstract|string $block[, string $siblingName = '' ][, bool $after = false ][, string $alias = '' ]) : object

Parameters

$block : Mage_Core_Block_Abstract|string
$siblingName : string = ''
$after : bool = false
$alias : string = ''

Return values

object —

$this

isColumnGrouped()


    public
                    isColumnGrouped(string|object $column[, string|bool $value = null ]) : bool|$this

Parameters

$column : string|object
$value : string|bool = null

Return values

bool|$this

isDeleted()

Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value


    public
                    isDeleted([bool $isDeleted = null ]) : bool

Parameters

$isDeleted : bool = null

Return values

bool

isDirty()


    public
                    isDirty([string $field = null ]) : bool

Parameters

$field : string = null

Return values

bool

isEmpty()

checks whether the object is empty


    public
                    isEmpty() : bool

Return values

bool

isModuleEnabled()


    public
                    isModuleEnabled([string|null $moduleName = null ][, string $helperAlias = 'core' ]) : bool

Parameters

$moduleName : string|null = null
$helperAlias : string = 'core'

Return values

bool

isModuleOutputEnabled()

Check whether the module output is enabled


    public
                    isModuleOutputEnabled([string|null $moduleName = null ][, string $helperAlias = 'core' ]) : bool

Because many module blocks belong to Adminhtml module, the feature "Disable module output" doesn't cover Admin area

Parameters

$moduleName : string|null = null
$helperAlias : string = 'core'

Return values

bool

isOutputEnabled()


    public
                    isOutputEnabled([string $moduleName = null ]) : bool

Parameters

$moduleName : string = null: Full module name

Return values

bool

jsonDecode()

Decodes the given $encodedValue string which is encoded in the JSON format


    public
                    jsonDecode(string $encodedValue[, int $objectDecodeType = Zend_Json::TYPE_ARRAY ]) : mixed

Parameters

$encodedValue : string
$objectDecodeType : int = Zend_Json::TYPE_ARRAY

jsonEncode()

Encode the mixed $valueToEncode into the JSON format


    public
                    jsonEncode(mixed $valueToEncode[, bool $cycleCheck = false ][, array<string|int, mixed> $options = [] ]) : string

Parameters

$valueToEncode : mixed
$cycleCheck : bool = false
$options : array<string|int, mixed> = []

Return values

string

jsQuoteEscape()

Escape quotes in java scripts


    public
                    jsQuoteEscape(mixed $data[, string $quote = ''' ]) : mixed

Parameters

$data : mixed
$quote : string = '''

maliciousCodeFilter()

Deleting script tags from string


    public
                    maliciousCodeFilter(string $html) : string

Parameters

$html : string

Return values

string

offsetExists()

Implementation of ArrayAccess::offsetExists()


    public
                    offsetExists(string $offset) : bool

Parameters

$offset : string

Return values

bool

offsetGet()

Implementation of ArrayAccess::offsetGet()


    public
                    offsetGet(string $offset) : mixed

Parameters

$offset : string

offsetSet()

Implementation of ArrayAccess::offsetSet()


    public
                    offsetSet(string $offset, mixed $value) : void

Parameters

$offset : string
$value : mixed

offsetUnset()

Implementation of ArrayAccess::offsetUnset()


    public
                    offsetUnset(string $offset) : void

Parameters

$offset : string

quoteEscape()

Escape quotes inside html attributes Use $addSlashes = false for escaping js that inside html attribute (onClick, onSubmit etc)


    public
                    quoteEscape(string $data[, bool $addSlashes = false ]) : string

Parameters

$data : string
$addSlashes : bool = false

Return values

string

removeColumn()

Remove existing column


    public
                    removeColumn(string $columnId) : $this

Parameters

$columnId : string

Return values

$this

renderView()

Render block


    public
                    renderView() : string

Return values

string

resetSavedParametersInSession()


    public
                    resetSavedParametersInSession() : mixed

serialize()

serialize object attributes


    public
                    serialize([array<string|int, mixed> $attributes = [] ][, string $valueSeparator = '=' ][, string $fieldSeparator = ' ' ][, string $quote = '"' ]) : string

Parameters

$attributes : array<string|int, mixed> = []
$valueSeparator : string = '='
$fieldSeparator : string = ' '
$quote : string = '"'

Return values

string

setAdditionalHtml()


    public
                    setAdditionalHtml(string $value) : $this

Parameters

$value : string

Return values

$this

setAnonSuffix()

Set anonymous suffix for current block


    public
                    setAnonSuffix(string $suffix) : $this

Parameters

$suffix : string

Return values

$this

setAttribute()

Set block attribute value


    public
                    setAttribute(array<string|int, mixed>|string $name[, mixed $value = null ]) : $this

Wrapper for method "setData"

Parameters

$name : array<string|int, mixed>|string
$value : mixed = null

Return values

$this

setBlockAlias()

Set block alias


    public
                    setBlockAlias(string $alias) : $this

Parameters

$alias : string

Return values

$this

setBlockParams()


    public
                    setBlockParams(array<string|int, mixed> $value) : $this

Parameters

$value : array<string|int, mixed>

Return values

$this

setCacheKey()


    public
                    setCacheKey(string $value) : $this

Parameters

$value : string

Return values

$this

setCacheLifetime()


    public
                    setCacheLifetime(int|false $value) : $this

Parameters

$value : int|false

Return values

$this

setCacheTags()


    public
                    setCacheTags(array<string|int, mixed> $value) : $this

Parameters

$value : array<string|int, mixed>

Return values

$this

setChild()

Set child block


    public
                    setChild(string $alias, Mage_Core_Block_Abstract $block) : $this

Parameters

$alias : string
$block : Mage_Core_Block_Abstract

Return values

$this

setClass()


    public
                    setClass(string $value) : $this

Parameters

$value : string

Return values

$this

setCollection()

set collection object


    public
                    setCollection(Mage_Core_Model_Resource_Db_Collection_Abstract|Varien_Data_Collection_Db $collection) : mixed

Parameters

$collection : Mage_Core_Model_Resource_Db_Collection_Abstract|Varien_Data_Collection_Db

setContentHeading()


    public
                    setContentHeading(string $value) : $this

Parameters

$value : string

Return values

$this

setCountSubTotals()

Set subtotals


    public
                    setCountSubTotals([bool $flag = true ]) : $this

Parameters

$flag : bool = true

Return values

$this

setCountTotals()

Set count totals


    public
                    setCountTotals([bool $count = true ]) : mixed

Parameters

$count : bool = true

setData()

Overwrite data in the object.


    public
                    setData(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this

$key can be string or array. If $key is string, the attribute value will be overwritten by $value

If $key is an array, it will overwrite all the data in the object.

Parameters

$key : string|array<string|int, mixed>
$value : mixed = null

Return values

$this

setDataChanges()

Clears data changes status


    public
                    setDataChanges(bool $value) : $this

Parameters

$value : bool

Return values

$this

setDataUsingMethod()

Set object data with calling setter method


    public
                    setDataUsingMethod(string $key[, mixed $args = [] ]) : $this

Parameters

$key : string
$args : mixed = []

Return values

$this

setDefaultDir()


    public
                    setDefaultDir(string $dir) : $this

Parameters

$dir : string

Return values

$this

setDefaultFilter()


    public
                    setDefaultFilter(array<string|int, mixed> $filter) : $this

Parameters

$filter : array<string|int, mixed>

Return values

$this

setDefaultLimit()


    public
                    setDefaultLimit(int $limit) : $this

Parameters

$limit : int

Return values

$this

setDefaultPage()


    public
                    setDefaultPage(int $page) : $this

Parameters

$page : int

Return values

$this

setDefaultSort()


    public
                    setDefaultSort(string $sort) : $this

Parameters

$sort : string

Return values

$this

setDestElementId()


    public
                    setDestElementId(string $value) : $this

Parameters

$value : string

Return values

$this

setDisabled()


    public
                    setDisabled(bool $value) : $this

Parameters

$value : bool

Return values

$this

setDisplayMinimalPrice()


    public
                    setDisplayMinimalPrice(bool $value) : $this

Parameters

$value : bool

Return values

$this

setEmptyCellLabel()

Set label for empty cell


    public
                    setEmptyCellLabel(string $label) : $this

Parameters

$label : string

Return values

$this

setEmptyText()

Set empty text for grid


    public
                    setEmptyText(string $text) : $this

Parameters

$text : string

Return values

$this

setEmptyTextClass()

Set empty text CSS class


    public
                    setEmptyTextClass(string $cssClass) : $this

Parameters

$cssClass : string

Return values

$this

setFilterVisibility()

Set visibility of filter


    public
                    setFilterVisibility([bool $visible = true ]) : mixed

Parameters

$visible : bool = true

setFormAction()


    public
                    setFormAction(string $value) : $this

Parameters

$value : string

Return values

$this

setFrameTags()

Specify block output frame tags


    public
                    setFrameTags(string $openTag[, string $closeTag = null ]) : $this

Parameters

$openTag : string
$closeTag : string = null

Return values

$this

setHeaderCss()


    public
                    setHeaderCss(string $value) : $this

Parameters

$value : string

Return values

$this

setHeadersVisibility()

Set visibility of column headers


    public
                    setHeadersVisibility([bool $visible = true ]) : mixed

Parameters

$visible : bool = true

setId()

Set object id field value


    public
                    setId(mixed $value) : $this

Parameters

$value : mixed

Return values

$this

setIdFieldName()

set name of object id field


    public
                    setIdFieldName(string $name) : $this

Parameters

$name : string

Return values

$this

setIdSuffix()


    public
                    setIdSuffix(string $value) : $this

Parameters

$value : string

Return values

$this

setIsAnonymous()

Set the anonymous flag


    public
                    setIsAnonymous(bool $flag) : $this

Parameters

$flag : bool

Return values

$this

setLabel()


    public
                    setLabel(string $value) : $this

Parameters

$value : string

Return values

$this

setLayout()

Set layout object


    public
                    setLayout(Mage_Core_Model_Layout $layout) : $this

Parameters

$layout : Mage_Core_Model_Layout

Return values

$this

setMassactionBlockName()

Set massaction block name


    public
                    setMassactionBlockName(string $blockName) : $this

Parameters

$blockName : string

Return values

$this

setMassactionIdField()

Set massaction row identifier field


    public
                    setMassactionIdField(string $idField) : $this

Parameters

$idField : string

Return values

$this

setMassactionIdFilter()

Set massaction row identifier filter


    public
                    setMassactionIdFilter(string $idFilter) : $this

Parameters

$idFilter : string

Return values

$this

setMessageBlockVisibility()

Set visibility of filter


    public
                    setMessageBlockVisibility([bool $visible = true ]) : mixed

Parameters

$visible : bool = true

setMessagesBlock()

Set messages block


    public
                    setMessagesBlock(Mage_Core_Block_Messages $block) : $this

Parameters

$block : Mage_Core_Block_Messages

Return values

$this

setNameInLayout()

Set block's name in layout and unsets previous link if such exists.


    public
                    setNameInLayout(string $name) : $this

Parameters

$name : string

Return values

$this

setOnclick()


    public
                    setOnclick(string $value) : $this

Parameters

$value : string

Return values

$this

setPagerVisibility()

Set visibility of pager


    public
                    setPagerVisibility([bool $visible = true ]) : mixed

Parameters

$visible : bool = true

setParentBlock()

Set parent block


    public
                    setParentBlock(Mage_Core_Block_Abstract $block) : $this

Parameters

$block : Mage_Core_Block_Abstract

Return values

$this

setProduct()


    public
                    setProduct(Mage_Catalog_Model_Product $value) : $this

Parameters

$value : Mage_Catalog_Model_Product

Return values

$this

setSaveParametersInSession()


    public
                    setSaveParametersInSession(bool $flag) : $this

Parameters

$flag : bool

Return values

$this

setScriptPath()

Set template location directory


    public
                    setScriptPath(string $dir) : $this

Parameters

$dir : string

Return values

$this

setSortable()


    public
                    setSortable(bool $value) : $this

Parameters

$value : bool

Return values

$this

setStoreIds()


    public
                    setStoreIds(mixed $storeIds) : mixed

Parameters

$storeIds : mixed

setSubTotals()

Set subtotal items


    public
                    setSubTotals(array<string|int, mixed> $items) : $this

Parameters

$items : array<string|int, mixed>

Return values

$this

setTemplate()

Set path to template used for generating block's output.


    public
                    setTemplate(string $template) : $this

Parameters

$template : string

Return values

$this

setTemplate()


    public
                    setTemplate(string $value) : $this

Parameters

$value : string

Return values

$this

setTitle()


    public
                    setTitle(string $value) : $this

Parameters

$value : string

Return values

$this

setTotals()

Set totals


    public
                    setTotals(Varien_Object $totals) : mixed

Parameters

$totals : Varien_Object

setTranslationHelper()

Helper setter for translations


    public
                    setTranslationHelper(Mage_Core_Helper_Abstract $helper) : $this

Parameters

$helper : Mage_Core_Helper_Abstract

Return values

$this

setType()


    public
                    setType(string $value) : $this

Parameters

$value : string

Return values

$this

setUseAjax()


    public
                    setUseAjax(bool $value) : $this

Parameters

$value : bool

Return values

$this

setVarNameDir()


    public
                    setVarNameDir(string $name) : string

Parameters

$name : string

Return values

string

setVarNameFilter()


    public
                    setVarNameFilter(string $name) : string

Parameters

$name : string

Return values

string

setVarNameLimit()


    public
                    setVarNameLimit(string $name) : string

Parameters

$name : string

Return values

string

setVarNamePage()


    public
                    setVarNamePage(string $name) : string

Parameters

$name : string

Return values

string

setVarNameSort()


    public
                    setVarNameSort(string $name) : string

Parameters

$name : string

Return values

string

shouldRenderCell()

Check whether should render cell


    public
                    shouldRenderCell(Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column) : bool

Parameters

$item : Varien_Object
$column : Mage_Adminhtml_Block_Widget_Grid_Column

Return values

bool

shouldRenderEmptyCell()

Check whether should render empty cell


    public
                    shouldRenderEmptyCell(Varien_Object $item, Mage_Adminhtml_Block_Widget_Grid_Column $column) : bool

Parameters

$item : Varien_Object
$column : Mage_Adminhtml_Block_Widget_Grid_Column

Return values

bool

shouldRenderSubTotal()

Check whether subtotal should be rendered


    public
                    shouldRenderSubTotal(Varien_Object $item) : bool

Parameters

$item : Varien_Object

Return values

bool

sortChildren()

Sort block's children


    public
                    sortChildren([bool $force = false ]) : $this

Parameters

$force : bool = false: force re-sort all children

Return values

$this

sortColumnsByOrder()

Sort columns by predefined order


    public
                    sortColumnsByOrder() : $this

Return values

$this

stripTags()

Wrapper for standard strip_tags() function with extra functionality for html entities


    public
                    stripTags(string $data[, string $allowableTags = null ][, bool $allowHtmlEntities = false ]) : string

Parameters

$data : string
$allowableTags : string = null
$allowHtmlEntities : bool = false

Return values

string

toArray()

Public wrapper for __toArray


    public
                    toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

array<string|int, mixed>

toHtml()

Produce and return block's html output


    public
        final            toHtml() : string

It is a final method, but you can override _toHtml() method in descendants if needed.

Return values

string

toJson()

Public wrapper for __toJson


    public
                    toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

string

toString()

Public wrapper for __toString


    public
                    toString([string $format = '' ]) : string

Will use $format as an template and substitute {{key}} for attributes

Parameters

$format : string = ''

Return values

string

toXml()

Public wrapper for __toXml


    public
                    toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []
$rootName : string = 'item'
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

unsetCallChild()

Call a child and unset it, if callback matched result


    public
                    unsetCallChild(string $alias, string $callback, mixed $result, array<string|int, mixed> $params) : $this

$params will pass to child callback $params may be array, if called from layout with elements with same name, for example: ...value_1value_2value_3

Or, if called like this: ...value_1value_2value_3

then it will be $params1, $params2, $params3

It is no difference anyway, because they will be transformed in appropriate way.

Parameters

$alias : string
$callback : string
$result : mixed
$params : array<string|int, mixed>

Return values

$this

unsetChild()

Unset child block


    public
                    unsetChild(string $alias) : $this

Parameters

$alias : string

Return values

$this

unsetChildren()

Unset all children blocks


    public
                    unsetChildren() : $this

Return values

$this

unsetData()

Unset data from the object.


    public
                    unsetData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

unsetOldData()

Unset old fields data from the object.


    public
                    unsetOldData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

urlEscape()


    public
                    urlEscape(string $data) : string

after 1.4.0.0-rc1

Parameters

$data : string

Return values

string

__toJson()

Convert object attributes to JSON


    protected
                    __toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

string

__toXml()

Convert object attributes to XML


    protected
                    __toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes
$rootName : string = 'item': name of the root element
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

_addBreadcrumb()


    protected
                    _addBreadcrumb(mixed $label[, mixed $title = null ][, mixed $link = null ]) : mixed

Parameters

$label : mixed
$title : mixed = null
$link : mixed = null

_addColumnFilterToCollection()

Add filter


    protected
                    _addColumnFilterToCollection(Mage_Adminhtml_Block_Widget_Grid_Column $column) : $this

Parameters

$column : Mage_Adminhtml_Block_Widget_Grid_Column

Return values

$this

_addCustomFilter()

Adds custom filter to resource collection Can be overridden in child classes if custom filter needed


    protected
                    _addCustomFilter(Mage_Sales_Model_Resource_Report_Collection_Abstract $collection, Varien_Object $filterData) : $this

Parameters

$collection : Mage_Sales_Model_Resource_Report_Collection_Abstract
$filterData : Varien_Object

Return values

$this

_addFullNames()


    protected
                    _addFullNames() : mixed

_addLinkModelFilterCallback()

Add link model filter from grid column to collection


    protected
                    _addLinkModelFilterCallback(Mage_Catalog_Model_Resource_Product_Link_Product_Collection $collection, Mage_Adminhtml_Block_Widget_Grid_Column $column) : $this

Parameters

$collection : Mage_Catalog_Model_Resource_Product_Link_Product_Collection
$column : Mage_Adminhtml_Block_Widget_Grid_Column

Return values

$this

_addOrderStatusFilter()

Add order status filter


    protected
                    _addOrderStatusFilter(Mage_Sales_Model_Resource_Report_Collection_Abstract $collection, Varien_Object $filterData) : $this

Parameters

$collection : Mage_Sales_Model_Resource_Report_Collection_Abstract
$filterData : Varien_Object

Return values

$this

_afterCacheUrl()

Replace URLs from cache


    protected
                    _afterCacheUrl(string $html) : string

Parameters

$html : string

Return values

string

_afterLoadCollection()


    protected
                    _afterLoadCollection() : $this

Return values

$this

_afterToHtml()

Processing block html after rendering


    protected
                    _afterToHtml(string $html) : string

Parameters

$html : string

Return values

string

_beforeCacheUrl()

Prepare url for save to cache


    protected
                    _beforeCacheUrl() : $this

Return values

$this

_beforeChildToHtml()

Prepare child block before generate html


    protected
                    _beforeChildToHtml(string $name, Mage_Core_Block_Abstract $child) : mixed

Parameters

$name : string
$child : Mage_Core_Block_Abstract

_beforeLoadCollection()


    protected
                    _beforeLoadCollection() : $this

Return values

$this

_beforeToHtml()

Before rendering html, but after trying to load cache


    protected
                    _beforeToHtml() : $this

#[Override]

Return values

$this

_camelize()


    protected
                    _camelize(string $name) : string

Parameters

$name : string

Return values

string

_construct()

Internal constructor, that is called from real constructor


    protected
                    _construct() : void

#[Override]

_decodeFilter()

Decode URL encoded filter value recursive callback method


    protected
                    _decodeFilter(string &$value) : mixed

Parameters

$value : string

_exportCsvItem()

Write item data to csv export file


    protected
                    _exportCsvItem(Varien_Object $item, Varien_Io_File $adapter) : mixed

Parameters

$item : Varien_Object
$adapter : Varien_Io_File

_exportExcelItem()

Write item data to Excel 2003 XML export file


    protected
                    _exportExcelItem(Varien_Object $item, Varien_Io_File $adapter[, Varien_Convert_Parser_Xml_Excel $parser = null ]) : mixed

Parameters

$item : Varien_Object
$adapter : Varien_Io_File
$parser : Varien_Convert_Parser_Xml_Excel = null

_getAggregatedColumns()


    protected
                    _getAggregatedColumns() : array<string|int, mixed>

Return values

array<string|int, mixed>

_getAllowSymlinks()

Get is allowed symlinks flag


    protected
                    _getAllowSymlinks() : bool

Return values

bool

_getApp()

Retrieve application instance


    protected
                    _getApp() : Mage_Core_Model_App

Return values

Mage_Core_Model_App

_getChildHtml()

Retrieve child block HTML


    protected
                    _getChildHtml(string $name[, bool $useCache = true ]) : string

Parameters

$name : string
$useCache : bool = true

Return values

string

_getData()

Get value from _data array without parse key


    protected
                    _getData(string $key) : mixed

Parameters

$key : string

_getExportHeaders()

Retrieve Headers row array for Export


    protected
                    _getExportHeaders() : array<string|int, mixed>

Return values

array<string|int, mixed>

_getExportTotals()

Retrieve Totals row array for Export


    protected
                    _getExportTotals() : array<string|int, mixed>

Return values

array<string|int, mixed>

_getFactory()

Retrieve factory instance


    protected
                    _getFactory() : Mage_Core_Model_Factory

Return values

Mage_Core_Model_Factory

_getFileContainerContent()

Retrieve file content from file container array


    protected
                    _getFileContainerContent(array<string|int, mixed> $fileData) : string

Parameters

$fileData : array<string|int, mixed>

Return values

string

_getRssUrl()

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


    protected
                    _getRssUrl(string $url) : string

Parameters

$url : string

Return values

string

_getSidPlaceholder()

Get SID placeholder for cache


    protected
                    _getSidPlaceholder([null|string $cacheKey = null ]) : string

Parameters

$cacheKey : null|string = null

Return values

string

_getStoreIds()

Get allowed store ids array intersected with selected scope in store switcher


    protected
                    _getStoreIds() : array<string|int, mixed>

Return values

array<string|int, mixed>

_getTagsCacheKey()

Get cache key for tags


    protected
                    _getTagsCacheKey([string $cacheKey = null ]) : string

Parameters

$cacheKey : string = null

Return values

string

_getUrlModel()

Create and return url object


    protected
                    _getUrlModel() : Mage_Core_Model_Url

Return values

Mage_Core_Model_Url

_getUrlModelClass()

Returns url model class name


    protected
                    _getUrlModelClass() : string

#[Override]

Return values

string

_initOldFieldsMap()

Inits mapping array of object's previously used fields to new fields.


    protected
                    _initOldFieldsMap() : mixed

Must be overloaded by descendants to set concrete fields map.

_isSecure()

Checks is request Url is secure


    protected
                    _isSecure() : bool

Return values

bool

_loadCache()

Load block html from cache storage


    protected
                    _loadCache() : string|false

Return values

string|false

_prepareArray()

Set required array elements


    protected
                    _prepareArray(array<string|int, mixed> &$arr[, array<string|int, mixed> $elements = [] ]) : array<string|int, mixed>

Parameters

$arr : array<string|int, mixed>
$elements : array<string|int, mixed> = []

Return values

array<string|int, mixed>

_prepareCollection()

Prepare grid collection object


    protected
                    _prepareCollection() : $this

#[Override]

Return values

$this

_prepareColumns()

Prepare columns for grid


    protected
                    _prepareColumns() : $this

Return values

$this

_prepareGrid()


    protected
                    _prepareGrid() : $this

Return values

$this

_prepareLayout()

Preparing global layout


    protected
                    _prepareLayout() : $this

You can redefine this method in child classes for changing layout

#[Override]

Return values

$this

_prepareMassaction()

Prepare grid massaction actions


    protected
                    _prepareMassaction() : $this

Return values

$this

_prepareMassactionBlock()

Prepare grid massaction block


    protected
                    _prepareMassactionBlock() : $this

Return values

$this

_prepareMassactionColumn()

Prepare grid massaction column


    protected
                    _prepareMassactionColumn() : $this

Return values

$this

_preparePage()


    protected
                    _preparePage() : mixed

_prepareSyncFieldsMap()

Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.


    protected
                    _prepareSyncFieldsMap() : $this

Return values

$this

_saveCache()

Save block content to cache storage


    protected
                    _saveCache(string $data) : $this|false

Parameters

$data : string

Return values

$this|false

_setCollectionOrder()

Sets sorting order by some column


    protected
                    _setCollectionOrder(Mage_Adminhtml_Block_Widget_Grid_Column $column) : $this

Parameters

$column : Mage_Adminhtml_Block_Widget_Grid_Column

Return values

$this

_setFilterValues()


    protected
                    _setFilterValues(array<string|int, mixed> $data) : $this

Parameters

$data : array<string|int, mixed>

Return values

$this

_toHtml()

Prepare html output


    protected
                    _toHtml() : string

#[Override]

Return values

string

_underscore()

Converts field names for setters and getters


    protected
                    _underscore(string $name) : string

$this->setMyField($value) === $this->setData('my_field', $value) Uses cache to eliminate unnecessary preg_replace

Parameters

$name : string

Return values

string

_getCacheHintStatusColor()

Retrieve block cache status


    private
                    _getCacheHintStatusColor() : string

Return values

string

Mage_Adminhtml_Block_Report_Grid_Abstract extends Mage_Adminhtml_Block_Widget_Grid in package Mage Adminhtml

Tags

Table of Contents

Constants

Properties

Methods

Constants

CACHE_GROUP

CACHE_KEY_PREFIX

CACHE_TAGS_DATA_KEY

XML_PATH_DEBUG_TEMPLATE_HINTS

XML_PATH_DEBUG_TEMPLATE_HINTS_ADMIN

XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS

XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS_ADMIN

XML_PATH_TEMPLATE_ALLOW_SYMLINK

Properties

$_aggregatedColumns

$_alias

$_anonSuffix

$_app

$_baseUrl

$_childGroups

$_children

$_childrenHtmlCache

$_collection

$_columnGroupBy

$_columns

$_columnsOrder

$_countSubTotals

$_countTotals

$_currentCurrencyCode

$_data

$_defaultDir

$_defaultFilter

$_defaultLimit

$_defaultPage

$_defaultSort

$_dirty

$_emptyCellLabel

$_emptyText

$_emptyTextCss

$_exportPageSize

$_exportTypes

$_factory

$_filterVisibility

$_frameCloseTag

$_frameOpenTag

$_groupedColumn

$_hasDataChanges

$_headersVisibility

$_idFieldName

$_isAnonymous

$_isDeleted

$_isExport

$_jsUrl

$_lastColumnId

$_layout

$_massactionBlockName

$_massactionIdField

$_massactionIdFilter

$_messageBlockVisibility

$_messagesBlock

$_nameInLayout

$_oldFieldsMap

$_pagerVisibility

$_parent

$_parentBlock

$_request

$_resourceCollectionName

$_rssLists

$_saveParametersInSession

$_showTemplateHints

$_showTemplateHintsAdmin

$_showTemplateHintsBlocks

$_showTemplateHintsBlocksAdmin

$_sortedChildren

$_sortInstructions

$_storeIds

$_subtotals

$_syncFieldsMap

Mage_Adminhtml_Block_Report_Grid_Abstract extends Mage_Adminhtml_Block_Widget_Grid
in package

Mage

Adminhtml