Grid Class Reference

Inheritance diagram for Grid:

Public Member Functions
	getRowClickCallback ()
	getRowInitCallback ()
Public Member Functions inherited from Grid
	__construct (\Magento\Backend\Block\Template\Context $context, \Magento\Backend\Helper\Data $backendHelper, array $data=[])
	setCollection ($collection)
	getCollection ()
	getColumnSet ()
	getExportBlock ()
	getColumns ()
	getColumnCount ()
	getColumn ($columnId)
	getPreparedCollection ()
	getMassactionBlock ()
	getVarNameLimit ()
	getVarNamePage ()
	getVarNameSort ()
	getVarNameDir ()
	getVarNameFilter ()
	setVarNameLimit ($name)
	setVarNamePage ($name)
	setVarNameSort ($name)
	setVarNameDir ($name)
	setVarNameFilter ($name)
	setPagerVisibility ($visible=true)
	getPagerVisibility ()
	setMessageBlockVisibility ($visible=true)
	getMessageBlockVisibility ()
	setDefaultLimit ($limit)
	setDefaultPage ($page)
	setDefaultSort ($sort)
	setDefaultDir ($dir)
	setDefaultFilter ($filter)
	canDisplayContainer ()
	getGridUrl ()
	getAbsoluteGridUrl ($params=[])
	getParam ($paramName, $default=null)
	setSaveParametersInSession ($flag)
	getJsObjectName ()
	setCountTotals ($count=true)
	getCountTotals ()
	setTotals (\Magento\Framework\DataObject $totals)
	getTotals ()
	getMainButtonsHtml ()
	getResetFilterButtonHtml ()
	getSearchButtonHtml ()
Public Member Functions inherited from Widget
	getId ()
	getSuffixId ($suffix)
	getHtmlId ()
	getCurrentUrl ($params=[])
	getButtonHtml ($label, $onclick, $class='', $buttonId=null, $dataAttr=[])
Public Member Functions inherited from Template
	__construct (\Magento\Backend\Block\Template\Context $context, array $data=[])
	getFormKey ()
	isOutputEnabled ($moduleName=null)
	getAuthorization ()
	getToolbar ()
Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])
	setTemplateContext ($templateContext)
	getTemplate ()
	setTemplate ($template)
	getTemplateFile ($template=null)
	getArea ()
	assign ($key, $value=null)
	fetchView ($fileName)
	getBaseUrl ()
	getObjectData (\Magento\Framework\DataObject $object, $key)
	getCacheKeyInfo ()
Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])
	getJsLayout ()
	getRequest ()
	getParentBlock ()
	setLayout (\Magento\Framework\View\LayoutInterface $layout)
	getLayout ()
	setNameInLayout ($name)
	getChildNames ()
	setAttribute ($name, $value=null)
	setChild ($alias, $block)
	addChild ($alias, $block, $data=[])
	unsetChild ($alias)
	unsetCallChild ($alias, $callback, $result, $params)
	unsetChildren ()
	getChildBlock ($alias)
	getChildHtml ($alias='', $useCache=true)
	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)
	getBlockHtml ($name)
	insert ($element, $siblingName=0, $after=true, $alias='')
	append ($element, $alias='')
	getGroupChildNames ($groupName)
	getChildData ($alias, $key='')
	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
	getUrl ($route='', $params=[])
	getViewFileUrl ($fileId, array $params=[])
	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)
	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)
	getModuleName ()
	escapeHtml ($data, $allowedTags=null)
	escapeJs ($string)
	escapeHtmlAttr ($string, $escapeSingleQuote=true)
	escapeCss ($string)
	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)
	escapeUrl ($string)
	escapeXssInUrl ($data)
	escapeQuote ($data, $addSlashes=false)
	escapeJsQuote ($data, $quote='\'')
	getNameInLayout ()
	getCacheKeyInfo ()
	getCacheKey ()
	getVar ($name, $module=null)
	isScopePrivate ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
Public Member Functions inherited from BlockInterface
	toHtml ()

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)
Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'
Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER
const	CACHE_KEY_PREFIX = 'BLOCK_'
Protected Member Functions inherited from Grid
	_construct ()
	_setFilterValues ($data)
	_addColumnFilterToCollection ($column)
	_setCollectionOrder ($column)
	_prepareCollection ()
	_preparePage ()
	_prepareGrid ()
	_prepareFilterButtons ()
	_beforeToHtml ()
Protected Member Functions inherited from Widget
	_addBreadcrumb ($label, $title=null, $link=null)
Protected Member Functions inherited from Template
	_toHtml ()
Protected Member Functions inherited from Template
	_construct ()
	_toHtml ()
	getRootDirectory ()
	getMediaDirectory ()
Protected Member Functions inherited from AbstractBlock
	_construct ()
	_prepareLayout ()
	_beforeToHtml ()
	_afterToHtml ($html)
	_toHtml ()
	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])
	getCacheTags ()
	getCacheLifetime ()
	_loadCache ()
	_saveCache ($data)
	_getSidPlaceholder ($cacheKey=null)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Protected Attributes inherited from Grid
	$_varNameLimit = 'limit'
	$_varNamePage = 'page'
	$_varNameSort = 'sort'
	$_varNameDir = 'dir'
	$_varNameFilter = 'filter'
	$_defaultLimit = 20
	$_defaultPage = 1
	$_defaultSort = false
	$_defaultDir = 'desc'
	$_defaultFilter = []
	$_emptyText
	$_emptyTextCss = 'empty-text'
	$_pagerVisibility = true
	$_messageBlockVisibility = false
	$_saveParametersInSession = false
	$_countTotals = false
	$_varTotals
	$_template = 'Magento_Backend::widget/grid.phtml'
	$_backendSession
	$_backendHelper
Protected Attributes inherited from Template
	$_authorization
	$mathRandom
	$_backendSession
	$formKey
	$nameBuilder
Protected Attributes inherited from Template
	$_viewVars = []
	$_baseUrl
	$_jsUrl
	$_allowSymlinks
	$_filesystem
	$_template
	$templateEnginePool
	$_storeManager
	$_appState
	$directory
	$templateContext
	$pageConfig
	$resolver
	$validator
Protected Attributes inherited from AbstractBlock
	$_design
	$_session
	$_sidResolver
	$_nameInLayout
	$_layout
	$jsLayout = []
	$_request
	$_urlBuilder
	$_eventManager
	$_frontController
	$_assetRepo
	$_viewConfig
	$_cacheState
	$_logger
	$_escaper
	$filterManager
	$_localeDate
	$inlineTranslation
	$_isScopePrivate = false
	$_scopeConfig
	$_cache
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

@api @codeCoverageIgnore

Since

100.0.2

Definition at line 17 of file Grid.php.

Member Function Documentation

getRowClickCallback()

getRowClickCallback

(

)

Disable javascript callback on row clicking.

Returns

string

Definition at line 24 of file Grid.php.

    {
        return '';
    }

getRowInitCallback()

getRowInitCallback

(

)

Disable javascript callback on row init.

Returns

string

Definition at line 34 of file Grid.php.

    {
        return '';
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-integration/Block/Adminhtml/Integration/Grid.php