Inheritance diagram for Extended:

Public Member Functions
	getColumnSet ()

	getExportButtonHtml ()

	addExportType ($url, $label)

	addColumn ($columnId, $column)

	removeColumn ($columnId)

	addColumnAfter ($columnId, $column, $after)

	addColumnsOrder ($columnId, $after)

	getColumnsOrder ()

	sortColumnsByOrder ()

	getLastColumnId ()

	getHtml ()

	getMassactionIdField ()

	setMassactionIdField ($idField)

	getMassactionIdFilter ()

	setMassactionIdFilter ($idFilter)

	getMassactionBlockName ()

	setMassactionBlockName ($blockName)

	getMassactionBlock ()

	getMassactionBlockHtml ()

	getSubTotalColumns ()

	shouldRenderCell ($item, $column)

	getEmptyCellLabel ()

	setEmptyCellLabel ($label)

	getRowUrl ($item)

	getMultipleRows ($item)

	getMultipleRowColumns ()

	shouldRenderSubTotal ($item)

	getRowspan ($item, $column)

	isColumnGrouped ($column, $value=null)

	shouldRenderEmptyCell ($item, $column)

	getEmptyCellColspan ()

	getSubTotalItem ($item)

	getColumnCount ()

	setHeadersVisibility ($visible=true)

	getHeadersVisibility ()

	setFilterVisibility ($visible=true)

	getFilterVisibility ()

	setEmptyText ($text)

	getEmptyText ()

	setEmptyTextClass ($cssClass)

	getEmptyTextClass ()

	setIsCollapsed ($isCollapsed)

	getIsCollapsed ()

	_exportIterateCollection ($callback, array $args)

	getCsvFile ()

	getCsv ()

	getXml ()

	getRowRecord (\Magento\Framework\DataObject $data)

	getExcelFile ($sheetName='')

	getExcel ()

	getExportTypes ()

	setCollection ($collection)

	getCollection ()

	setCountSubTotals ($flag=true)

	getCountSubTotals ()

	setSubTotals (array $items)

	getSubTotals ()

	getMainButtonsHtml ()

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

Public Member Functions inherited from ExportInterface
	getId ()

Protected Member Functions
	_construct ()

	_prepareLayout ()

	_prepareColumns ()

	_prepareMassactionBlock ()

	_prepareMassaction ()

	_prepareMassactionColumn ()

	_prepareCollection ()

	_afterLoadCollection ()

	_prepareGrid ()

	_getFileContainerContent (array $fileData)

	_getExportHeaders ()

	_getExportTotals ()

	_exportCsvItem (\Magento\Framework\DataObject $item, \Magento\Framework\Filesystem\File\WriteInterface $stream)

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
	$_columns = []

	$_collection

	$_isExport = false

	$_exportTypes = []

	$_exportPageSize = 1000

	$_lastColumnId

	$_massactionIdField

	$_massactionIdFilter

	$_massactionBlockName = \Magento\Backend\Block\Widget\Grid\Massaction\Extended::class

	$_columnsOrder = []

	$_emptyCellLabel = ''

	$_groupedColumn = []

	$_headersVisibility = true

	$_filterVisibility = true

	$_emptyText

	$_emptyTextCss = 'empty-text'

	$_isCollapsed

	$_countSubTotals = false

	$_subtotals = []

	$_template = 'Magento_Backend::widget/grid/extended.phtml'

	$_directory

	$_path = 'export'

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 = []

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_'

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

@api

Deprecated:: 100.2.0 in favour of UI component implementation @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.NumberOfChildren) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 20 of file Extended.php.

Member Function Documentation

◆ _afterLoadCollection()

_afterLoadCollection ( )

protected

Process collection after loading

Returns: $this

Definition at line 494 of file Extended.php.

     {
         return $this;
     }

◆ _construct()

_construct ( )

protected

Returns: void

Definition at line 182 of file Extended.php.

     {
         parent::_construct();
         $this->_emptyText = __('We couldn\'t find any records.');
 
         $this->_directory = $this->_filesystem->getDirectoryWrite(DirectoryList::VAR_DIR);
     }

◆ _exportCsvItem()

_exportCsvItem	(	\Magento\Framework\DataObject	$item,
		\Magento\Framework\Filesystem\File\WriteInterface	$stream
	)

protected

Write item data to csv export file

Parameters

\Magento\Framework\DataObject	$item
\Magento\Framework\Filesystem\File\WriteInterface	$stream

Returns: void

Definition at line 987 of file Extended.php.

       {
         $row = [];
         foreach ($this->getColumns() as $column) {
             if (!$column->getIsSystem()) {
                 $row[] = $column->getRowFieldExport($item);
             }
         }
         $stream->writeCsv($row);
     }

◆ _exportIterateCollection()

_exportIterateCollection	(		$callback,
		array	$args
	)

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

Parameters

string	$callback
array	$args	additional arguments for callback method

Returns: void

Definition at line 952 of file Extended.php.

     {
         $originalCollection = $this->getCollection();
         $count = null;
         $page = 1;
         $lPage = null;
         $break = false;
 
         while ($break !== true) {
             $collection = clone $originalCollection;
             $collection->setPageSize($this->_exportPageSize);
             $collection->setCurPage($page);
             $collection->load();
             if ($count === null) {
                 $count = $collection->getSize();
                 $lPage = $collection->getLastPageNumber();
             }
             if ($lPage == $page) {
                 $break = true;
             }
             $page++;
 
             foreach ($collection as $item) {
                 call_user_func_array([$this, $callback], array_merge([$item], $args));
             }
         }
     }

◆ _getExportHeaders()

_getExportHeaders ( )

protected

Retrieve Headers row array for Export

Returns: string[]

Definition at line 916 of file Extended.php.

     {
         $row = [];
         foreach ($this->getColumns() as $column) {
             if (!$column->getIsSystem()) {
                 $row[] = $column->getExportHeader();
             }
         }
         return $row;
     }

◆ _getExportTotals()

_getExportTotals ( )

protected

Retrieve Totals row array for Export

Returns: string[]

Definition at line 932 of file Extended.php.

     {
         $totals = $this->getTotals();
         $row = [];
         foreach ($this->getColumns() as $column) {
             if (!$column->getIsSystem()) {
                 $row[] = $column->hasTotalsLabel() ? $column->getTotalsLabel() : $column->getRowFieldExport($totals);
             }
         }
         return $row;
     }

◆ _getFileContainerContent()

_getFileContainerContent ( array $fileData )

protected

Retrieve file content from file container array

Parameters

array $fileData

Returns: string

Definition at line 906 of file Extended.php.

     {
         return $this->_directory->readFile('export/' . $fileData['value']);
     }

◆ _prepareCollection()

_prepareCollection ( )

protected

Apply sorting and filtering to collection

Returns: $this

Definition at line 471 of file Extended.php.

     {
         if ($this->getCollection()) {
             if ($this->getCollection()->isLoaded()) {
                 $this->getCollection()->clear();
             }
 
             parent::_prepareCollection();
 
             if (!$this->_isExport) {
                 $this->getCollection()->load();
                 $this->_afterLoadCollection();
             }
         }
 
         return $this;
     }

◆ _prepareColumns()

_prepareColumns ( )

protected

Initialize grid columns

Returns: $this

Definition at line 398 of file Extended.php.

     {
         $this->sortColumnsByOrder();
         return $this;
     }

◆ _prepareGrid()

_prepareGrid ( )

protected

Initialize grid before rendering

Returns: $this

Definition at line 504 of file Extended.php.

     {
         $this->_prepareColumns();
         $this->_prepareMassactionBlock();
         parent::_prepareGrid();
         return $this;
     }

◆ _prepareLayout()

_prepareLayout ( )

protected

Initialize child blocks

Returns: $this

Definition at line 195 of file Extended.php.

     {
         $this->setChild(
             'export_button',
             $this->getLayout()->createBlock(\Magento\Backend\Block\Widget\Button::class)->setData(
                 [
                     'label' => __('Export'),
                     'onclick' => $this->getJsObjectName() . '.doExport()',
                     'class' => 'task',
                 ]
             )
         );
         $this->setChild(
             'reset_filter_button',
             $this->getLayout()->createBlock(\Magento\Backend\Block\Widget\Button::class)->setData(
                 [
                     'label' => __('Reset Filter'),
                     'onclick' => $this->getJsObjectName() . '.resetFilter()',
                     'class' => 'action-reset action-tertiary'
                 ]
             )->setDataAttribute(
                 [
                     'action' => 'grid-filter-reset'
                 ]
             )
         );
         $this->setChild(
             'search_button',
             $this->getLayout()->createBlock(\Magento\Backend\Block\Widget\Button::class)->setData(
                 [
                     'label' => __('Search'),
                     'onclick' => $this->getJsObjectName() . '.doFilter()',
                     'class' => 'task action-secondary',
                 ]
             )->setDataAttribute(
                 [
                     'action' => 'grid-filter-apply'
                 ]
             )
         );
         return parent::_prepareLayout();
     }

◆ _prepareMassaction()

_prepareMassaction ( )

protected

Prepare grid massaction actions

Returns: $this

Definition at line 424 of file Extended.php.

     {
         return $this;
     }

◆ _prepareMassactionBlock()

_prepareMassactionBlock ( )

protected

Prepare grid massaction block

Returns: $this

Definition at line 409 of file Extended.php.

     {
         $this->setChild('massaction', $this->getLayout()->createBlock($this->getMassactionBlockName()));
         $this->_prepareMassaction();
         if ($this->getMassactionBlock()->isAvailable()) {
             $this->_prepareMassactionColumn();
         }
         return $this;
     }

◆ _prepareMassactionColumn()

_prepareMassactionColumn ( )

protected

Prepare grid massaction column

Returns: $this

Definition at line 434 of file Extended.php.

     {
         $columnId = 'massaction';
         $massactionColumn = $this->getLayout()
             ->createBlock(\Magento\Backend\Block\Widget\Grid\Column::class)
             ->setData(
                 [
                     'index' => $this->getMassactionIdField(),
                     'filter_index' => $this->getMassactionIdFilter(),
                     'type' => 'massaction',
                     'name' => $this->getMassactionBlock()->getFormFieldName(),
                     'is_system' => true,
                     'header_css_class' => 'col-select',
                     'column_css_class' => 'col-select',
                 ]
             );
 
         if ($this->getNoFilterMassactionColumn()) {
             $massactionColumn->setData('filter', false);
         }
 
         $massactionColumn->setSelected($this->getMassactionBlock()->getSelected())->setGrid($this)->setId($columnId);
 
         $this->getColumnSet()->insert(
             $massactionColumn,
             count($this->getColumnSet()->getColumns()) + 1,
             false,
             $columnId
         );
         return $this;
     }

◆ addColumn()

addColumn	(	$columnId,
		$column
	)

Add column to grid

Parameters

string	$columnId
array \| \Magento\Framework\DataObject	$column

Returns: $this

Exceptions

Definition at line 287 of file Extended.php.

     {
         if (is_array($column)) {
             $this->getColumnSet()->setChild(
                 $columnId,
                 $this->getLayout()
                     ->createBlock(\Magento\Backend\Block\Widget\Grid\Column\Extended::class)
                     ->setData($column)
                     ->setId($columnId)
                     ->setGrid($this)
             );
             $this->getColumnSet()->getChildBlock($columnId)->setGrid($this);
         } else {
             throw new \Exception(__('Please correct the column format and try again.'));
         }
 
         $this->_lastColumnId = $columnId;
         return $this;
     }

◆ addColumnAfter()

addColumnAfter	(	$columnId,
		$column,
		$after
	)

Add column to grid after specified column.

Parameters

string	$columnId
array \| \Magento\Framework\DataObject	$column
string	$after

Returns: $this

Definition at line 333 of file Extended.php.

     {
         $this->addColumn($columnId, $column);
         $this->addColumnsOrder($columnId, $after);
         return $this;
     }

◆ addColumnsOrder()

addColumnsOrder	(	$columnId,
		$after
	)

Add column view order

Parameters

string	$columnId
string	$after

Returns: $this

Definition at line 347 of file Extended.php.

     {
         $this->_columnsOrder[$columnId] = $after;
         return $this;
     }

◆ addExportType()

addExportType	(	$url,
		$label
	)

Add new export type to grid

Parameters

string	$url
string	$label

Returns: $this

Implements ExportInterface.

Definition at line 271 of file Extended.php.

     {
         $this->_exportTypes[] = new \Magento\Framework\DataObject(
             ['url' => $this->getUrl($url, ['_current' => true]), 'label' => $label]
         );
         return $this;
     }

◆ getCollection()

getCollection ( )

get collection object

Returns: \Magento\Framework\Data\Collection

Definition at line 1251 of file Extended.php.

     {
         return $this->_collection;
     }

◆ getColumnCount()

getColumnCount ( )

Count columns

Returns: int

Definition at line 784 of file Extended.php.

     {
         return count($this->getColumns());
     }

◆ getColumnSet()

getColumnSet ( )

Retrieve column set block

Returns: \Magento\Framework\View\Element\AbstractBlock

Definition at line 243 of file Extended.php.

     {
         if (!$this->getChildBlock('grid.columnSet')) {
             $this->setChild(
                 'grid.columnSet',
                 $this->getLayout()->createBlock(\Magento\Backend\Block\Widget\Grid\ColumnSet::class)
             );
         }
         return parent::getColumnSet();
     }

◆ getColumnsOrder()

getColumnsOrder ( )

Retrieve columns order

Returns: array

Definition at line 358 of file Extended.php.

     {
         return $this->_columnsOrder;
     }

◆ getCountSubTotals()

getCountSubTotals ( )

Return count subtotals

Returns: boolean @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 1274 of file Extended.php.

     {
         return $this->_countSubTotals;
     }

◆ getCsv()

getCsv ( )

Retrieve Grid data as CSV

Returns: string

Implements ExportInterface.

Definition at line 1041 of file Extended.php.

     {
         $csv = '';
         $this->_isExport = true;
         $this->_prepareGrid();
         $this->getCollection()->getSelect()->limit();
         $this->getCollection()->setPageSize(0);
         $this->getCollection()->load();
         $this->_afterLoadCollection();
 
         $data = [];
         foreach ($this->getColumns() as $column) {
             if (!$column->getIsSystem()) {
                 $data[] = '"' . $column->getExportHeader() . '"';
             }
         }
         $csv .= implode(',', $data) . "\n";
 
         foreach ($this->getCollection() as $item) {
             $data = [];
             foreach ($this->getColumns() as $column) {
                 if (!$column->getIsSystem()) {
                     $data[] = '"' . str_replace(
                         ['"', '\\'],
                         ['""', '\\\\'],
                         $column->getRowFieldExport($item)
                     ) . '"';
                 }
             }
             $csv .= implode(',', $data) . "\n";
         }
 
         if ($this->getCountTotals()) {
             $data = [];
             foreach ($this->getColumns() as $column) {
                 if (!$column->getIsSystem()) {
                     $data[] = '"' . str_replace(
                         ['"', '\\'],
                         ['""', '\\\\'],
                         $column->getRowFieldExport($this->getTotals())
                     ) . '"';
                 }
             }
             $csv .= implode(',', $data) . "\n";
         }
 
         return $csv;
     }

◆ getCsvFile()

getCsvFile ( )

Retrieve a file container array by grid data as CSV

Return array with keys type and value

Returns: array

Implements ExportInterface.

Definition at line 1007 of file Extended.php.

     {
         $this->_isExport = true;
         $this->_prepareGrid();
 
         $name = md5(microtime());
         $file = $this->_path . '/' . $name . '.csv';
 
         $this->_directory->create($this->_path);
         $stream = $this->_directory->openFile($file, 'w+');
 
         $stream->lock();
         $stream->writeCsv($this->_getExportHeaders());
         $this->_exportIterateCollection('_exportCsvItem', [$stream]);
 
         if ($this->getCountTotals()) {
             $stream->writeCsv($this->_getExportTotals());
         }
 
         $stream->unlock();
         $stream->close();
 
         return [
             'type' => 'filename',
             'value' => $file,
             'rm' => true  // can delete file after use
         ];
     }

◆ getEmptyCellColspan()

getEmptyCellColspan ( )

Retrieve colspan for empty cell

Returns: int

Definition at line 756 of file Extended.php.

     {
         return $this->getColumnCount() - count($this->_groupedColumn);
     }

◆ getEmptyCellLabel()

getEmptyCellLabel ( )

Retrieve label for empty cell

Returns: string

Definition at line 641 of file Extended.php.

     {
         return $this->_emptyCellLabel;
     }

◆ getEmptyText()

getEmptyText ( )

Return empty text for grid

Returns: string

Definition at line 850 of file Extended.php.

     {
         return $this->_emptyText;
     }

◆ getEmptyTextClass()

getEmptyTextClass ( )

Return empty text CSS class

Returns: string

Definition at line 872 of file Extended.php.

     {
         return $this->_emptyTextCss;
     }

◆ getExcel()

getExcel ( )

Retrieve grid data as MS Excel 2003 XML Document

Returns: string

Implements ExportInterface.

Definition at line 1184 of file Extended.php.

     {
         $this->_isExport = true;
         $this->_prepareGrid();
         $this->getCollection()->getSelect()->limit();
         $this->getCollection()->setPageSize(0);
         $this->getCollection()->load();
         $this->_afterLoadCollection();
         $headers = [];
         $data = [];
         foreach ($this->getColumns() as $column) {
             if (!$column->getIsSystem()) {
                 $headers[] = $column->getHeader();
             }
         }
         $data[] = $headers;
 
         foreach ($this->getCollection() as $item) {
             $row = [];
             foreach ($this->getColumns() as $column) {
                 if (!$column->getIsSystem()) {
                     $row[] = $column->getRowField($item);
                 }
             }
             $data[] = $row;
         }
 
         if ($this->getCountTotals()) {
             $row = [];
             foreach ($this->getColumns() as $column) {
                 if (!$column->getIsSystem()) {
                     $row[] = $column->getRowField($this->getTotals());
                 }
             }
             $data[] = $row;
         }
 
         $convert = new \Magento\Framework\Convert\Excel(new \ArrayIterator($data));
         return $convert->convert('single_sheet');
     }

◆ getExcelFile()

getExcelFile ( $sheetName = '' )

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

Return array with keys type and value

Parameters

string $sheetName

Returns: array

Implements ExportInterface.

Definition at line 1146 of file Extended.php.

     {
         $this->_isExport = true;
         $this->_prepareGrid();
 
         $convert = new \Magento\Framework\Convert\Excel(
             $this->getCollection()->getIterator(),
             [$this, 'getRowRecord']
         );
 
         $name = md5(microtime());
         $file = $this->_path . '/' . $name . '.xml';
 
         $this->_directory->create($this->_path);
         $stream = $this->_directory->openFile($file, 'w+');
         $stream->lock();
 
         $convert->setDataHeader($this->_getExportHeaders());
         if ($this->getCountTotals()) {
             $convert->setDataFooter($this->_getExportTotals());
         }
 
         $convert->write($stream, $sheetName);
         $stream->unlock();
         $stream->close();
 
         return [
             'type' => 'filename',
             'value' => $file,
             'rm' => true // can delete file after use
         ];
     }

◆ getExportButtonHtml()

getExportButtonHtml ( )

Generate export button

Returns: string

Implements ExportInterface.

Definition at line 259 of file Extended.php.

     {
         return $this->getChildHtml('export_button');
     }

◆ getExportTypes()

getExportTypes ( )

Retrieve grid export types

Returns: \Magento\Framework\DataObject[]|false

Implements ExportInterface.

Definition at line 1230 of file Extended.php.

     {
         return empty($this->_exportTypes) ? false : $this->_exportTypes;
     }

◆ getFilterVisibility()

getFilterVisibility ( )

Return visibility of filter

Returns: boolean @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 828 of file Extended.php.

     {
         return $this->_filterVisibility;
     }

◆ getHeadersVisibility()

getHeadersVisibility ( )

Return visibility of column headers

Returns: boolean @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 806 of file Extended.php.

     {
         return $this->_headersVisibility;
     }

◆ getHtml()

getHtml ( )

Retrieve grid HTML

Returns: string

Definition at line 517 of file Extended.php.

     {
         return $this->toHtml();
     }

◆ getIsCollapsed()

getIsCollapsed ( )

Retrieve flag is collapsed

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 895 of file Extended.php.

     {
         return $this->_isCollapsed;
     }

◆ getLastColumnId()

getLastColumnId ( )

Retrieve identifier of last column

Returns: string

Definition at line 388 of file Extended.php.

     {
         return $this->_lastColumnId;
     }

◆ getMainButtonsHtml()

getMainButtonsHtml ( )

Generate list of grid buttons

Returns: string

Definition at line 1306 of file Extended.php.

     {
         $html = '';
         if ($this->getFilterVisibility()) {
             $html .= $this->getSearchButtonHtml();
             $html .= $this->getResetFilterButtonHtml();
         }
         return $html;
     }

◆ getMassactionBlock()

getMassactionBlock ( )

Retrieve massaction block

Returns: $this

Definition at line 593 of file Extended.php.

     {
         return $this->getChildBlock('massaction');
     }

◆ getMassactionBlockHtml()

getMassactionBlockHtml ( )

Generate massaction block

Returns: string

Definition at line 603 of file Extended.php.

     {
         return $this->getChildHtml('massaction');
     }

◆ getMassactionBlockName()

getMassactionBlockName ( )

Retrieve massaction block name

Returns: string

Definition at line 571 of file Extended.php.

     {
         return $this->_massactionBlockName;
     }

◆ getMassactionIdField()

getMassactionIdField ( )

Retrieve massaction row identifier field

Returns: string

Definition at line 527 of file Extended.php.

     {
         return $this->_massactionIdField;
     }

◆ getMassactionIdFilter()

getMassactionIdFilter ( )

Retrieve massaction row identifier filter

Returns: string

Definition at line 549 of file Extended.php.

     {
         return $this->_massactionIdFilter;
     }

◆ getMultipleRowColumns()

getMultipleRowColumns ( )

Retrieve columns for multiple rows

Returns: array

Definition at line 685 of file Extended.php.

     {
         $columns = $this->getColumns();
         foreach ($this->_groupedColumn as $column) {
             unset($columns[$column]);
         }
         return $columns;
     }

◆ getMultipleRows()

getMultipleRows ( $item )

Get children of specified item

Parameters

\Magento\Framework\DataObject $item

Returns: array

Definition at line 676 of file Extended.php.

     {
         return $item->getChildren();
     }

◆ getRowRecord()

getRowRecord ( \Magento\Framework\DataObject $data )

Get a row data of the particular columns

Parameters

\Magento\Framework\DataObject $data

Returns: string[]

Definition at line 1127 of file Extended.php.

     {
         $row = [];
         foreach ($this->getColumns() as $column) {
             if (!$column->getIsSystem()) {
                 $row[] = $column->getRowFieldExport($data);
             }
         }
         return $row;
     }

◆ getRowspan()

getRowspan	(	$item,
		$column
	)

Retrieve rowspan number

Parameters

\Magento\Framework\DataObject	$item
\Magento\Backend\Block\Widget\Grid\Column	$column

Returns: int|false

Definition at line 712 of file Extended.php.

     {
         if ($this->isColumnGrouped($column)) {
             return count($this->getMultipleRows($item)) + count($this->_groupedColumn);
         }
         return false;
     }

◆ getRowUrl()

getRowUrl ( $item )

Return row url for js event handlers

Parameters

\Magento\Catalog\Model\Product | \Magento\Framework\DataObject $item

Returns: string

Definition at line 664 of file Extended.php.

     {
         $res = parent::getRowUrl($item);
         return $res ? $res : '#';
     }

◆ getSubTotalColumns()

getSubTotalColumns ( )

Retrieve columns to render

Returns: array

Definition at line 613 of file Extended.php.

     {
         return $this->getColumns();
     }

◆ getSubTotalItem()

getSubTotalItem ( $item )

Retrieve subtotal item

Parameters

\Magento\Framework\DataObject $item

Returns: \Magento\Framework\DataObject|string

Definition at line 767 of file Extended.php.

     {
         foreach ($this->_subtotals as $subtotalItem) {
             foreach ($this->_groupedColumn as $groupedColumn) {
                 if ($subtotalItem->getData($groupedColumn) == $item->getData($groupedColumn)) {
                     return $subtotalItem;
                 }
             }
         }
         return '';
     }

◆ getSubTotals()

getSubTotals ( )

Retrieve subtotal items

Returns: \Magento\Framework\DataObject[]

Definition at line 1296 of file Extended.php.

     {
         return $this->_subtotals;
     }

◆ getXml()

getXml ( )

Retrieve data in xml

Returns: string

Implements ExportInterface.

Definition at line 1095 of file Extended.php.

     {
         $this->_isExport = true;
         $this->_prepareGrid();
         $this->getCollection()->getSelect()->limit();
         $this->getCollection()->setPageSize(0);
         $this->getCollection()->load();
         $this->_afterLoadCollection();
         $indexes = [];
         foreach ($this->getColumns() as $column) {
             if (!$column->getIsSystem()) {
                 $indexes[] = $column->getIndex();
             }
         }
         $xml = '<?xml version="1.0" encoding="UTF-8"?>';
         $xml .= '<items>';
         foreach ($this->getCollection() as $item) {
             $xml .= $item->toXml($indexes);
         }
         if ($this->getCountTotals()) {
             $xml .= $this->getTotals()->toXml($indexes);
         }
         $xml .= '</items>';
         return $xml;
     }

◆ isColumnGrouped()

isColumnGrouped	(	$column,
		$value = `null`
	)

Check whether given column is grouped

Parameters

string \| object	$column
string	$value

Returns: boolean|$this

Definition at line 727 of file Extended.php.

     {
         if (null === $value) {
             if (is_object($column)) {
                 return in_array($column->getIndex(), $this->_groupedColumn);
             }
             return in_array($column, $this->_groupedColumn);
         }
         $this->_groupedColumn[] = $column;
         return $this;
     }

◆ removeColumn()

removeColumn ( $columnId )

Remove existing column

Parameters

string $columnId

Returns: $this

Definition at line 313 of file Extended.php.

     {
         if ($this->getColumnSet()->getChildBlock($columnId)) {
             $this->getColumnSet()->unsetChild($columnId);
             if ($this->_lastColumnId == $columnId) {
                 $names = $this->getColumnSet()->getChildNames();
                 $this->_lastColumnId = array_pop($names);
             }
         }
         return $this;
     }

◆ setCollection()

setCollection ( $collection )

Set collection object

Parameters

\Magento\Framework\Data\Collection $collection

Returns: void

Definition at line 1241 of file Extended.php.

     {
         $this->_collection = $collection;
     }

◆ setCountSubTotals()

setCountSubTotals ( $flag = true )

Set subtotals

Parameters

boolean $flag

Returns: $this

Definition at line 1262 of file Extended.php.

     {
         $this->_countSubTotals = $flag;
         return $this;
     }

◆ setEmptyCellLabel()

setEmptyCellLabel ( $label )

Set label for empty cell

Parameters

string $label

Returns: $this

Definition at line 652 of file Extended.php.

     {
         $this->_emptyCellLabel = $label;
         return $this;
     }

◆ setEmptyText()

setEmptyText ( $text )

Set empty text for grid

Parameters

string $text

Returns: $this

Definition at line 839 of file Extended.php.

     {
         $this->_emptyText = $text;
         return $this;
     }

◆ setEmptyTextClass()

setEmptyTextClass ( $cssClass )

Set empty text CSS class

Parameters

string $cssClass

Returns: $this

Definition at line 861 of file Extended.php.

     {
         $this->_emptyTextCss = $cssClass;
         return $this;
     }

◆ setFilterVisibility()

setFilterVisibility ( $visible = true )

Set visibility of filter

Parameters

bool $visible

Returns: void

Definition at line 817 of file Extended.php.

     {
         $this->_filterVisibility = $visible;
     }

◆ setHeadersVisibility()

setHeadersVisibility ( $visible = true )

Set visibility of column headers

Parameters

bool $visible

Returns: void

Definition at line 795 of file Extended.php.

     {
         $this->_headersVisibility = $visible;
     }

◆ setIsCollapsed()

setIsCollapsed ( $isCollapsed )

Set flag whether is collapsed

Parameters

bool $isCollapsed

Returns: $this

Definition at line 883 of file Extended.php.

     {
         $this->_isCollapsed = $isCollapsed;
         return $this;
     }

◆ setMassactionBlockName()

setMassactionBlockName ( $blockName )

Set massaction block name

Parameters

string $blockName

Returns: $this

Definition at line 582 of file Extended.php.

     {
         $this->_massactionBlockName = $blockName;
         return $this;
     }

◆ setMassactionIdField()

setMassactionIdField ( $idField )

Set massaction row identifier field

Parameters

string $idField

Returns: $this

Definition at line 538 of file Extended.php.

     {
         $this->_massactionIdField = $idField;
         return $this;
     }

◆ setMassactionIdFilter()

setMassactionIdFilter ( $idFilter )

Set massaction row identifier filter

Parameters

string $idFilter

Returns: $this

Definition at line 560 of file Extended.php.

     {
         $this->_massactionIdFilter = $idFilter;
         return $this;
     }

◆ setSubTotals()

setSubTotals ( array $items )

Set subtotal items

Parameters

Definition at line 1285 of file Extended.php.

     {
         $this->_subtotals = $items;
         return $this;
     }

◆ shouldRenderCell()

shouldRenderCell	(	$item,
		$column
	)

Check whether should render cell

Parameters

\Magento\Framework\DataObject	$item
\Magento\Backend\Block\Widget\Grid\Column	$column

Returns: boolean

Definition at line 625 of file Extended.php.

     {
         if ($this->isColumnGrouped($column) && $item->getIsEmpty()) {
             return true;
         }
         if (!$item->getIsEmpty()) {
             return true;
         }
         return false;
     }

◆ shouldRenderEmptyCell()

shouldRenderEmptyCell	(	$item,
		$column
	)

Check whether should render empty cell

Parameters

\Magento\Framework\DataObject	$item
\Magento\Backend\Block\Widget\Grid\Column	$column

Returns: boolean

Definition at line 746 of file Extended.php.

     {
         return $item->getIsEmpty() && in_array($column['index'], $this->_groupedColumn);
     }

◆ shouldRenderSubTotal()

shouldRenderSubTotal ( $item )

Check whether subtotal should be rendered

Parameters

\Magento\Framework\DataObject $item

Returns: boolean

Definition at line 700 of file Extended.php.

     {
         return $this->_countSubTotals && count($this->_subtotals) > 0 && count($this->getMultipleRows($item)) > 0;
     }

◆ sortColumnsByOrder()

sortColumnsByOrder ( )

Sort columns by predefined order

Returns: $this

Definition at line 368 of file Extended.php.

     {
         foreach ($this->getColumnsOrder() as $columnId => $after) {
             $this->getLayout()->reorderChild(
                 $this->getColumnSet()->getNameInLayout(),
                 $this->getColumn($columnId)->getNameInLayout(),
                 $this->getColumn($after)->getNameInLayout()
             );
         }
 
         $columns = $this->getColumnSet()->getChildNames();
         $this->_lastColumnId = array_pop($columns);
         return $this;
     }

Field Documentation

◆ $_collection

$_collection

protected

Definition at line 43 of file Extended.php.

◆ $_columns

$_columns = []

protected

Definition at line 36 of file Extended.php.

◆ $_columnsOrder

$_columnsOrder = []

protected

Definition at line 99 of file Extended.php.

◆ $_countSubTotals

$_countSubTotals = false

protected

Definition at line 153 of file Extended.php.

◆ $_directory

$_directory

protected

Definition at line 170 of file Extended.php.

◆ $_emptyCellLabel

$_emptyCellLabel = ''

protected

Definition at line 106 of file Extended.php.

◆ $_emptyText

$_emptyText

protected

Definition at line 134 of file Extended.php.

◆ $_emptyTextCss

$_emptyTextCss = 'empty-text'

protected

Definition at line 141 of file Extended.php.

◆ $_exportPageSize

$_exportPageSize = 1000

protected

Definition at line 64 of file Extended.php.

◆ $_exportTypes

$_exportTypes = []

protected

Definition at line 57 of file Extended.php.

◆ $_filterVisibility

$_filterVisibility = true

protected

Definition at line 127 of file Extended.php.

◆ $_groupedColumn

$_groupedColumn = []

protected

Definition at line 113 of file Extended.php.

◆ $_headersVisibility

$_headersVisibility = true

protected

Definition at line 120 of file Extended.php.

◆ $_isCollapsed

$_isCollapsed

protected

Definition at line 146 of file Extended.php.

◆ $_isExport

$_isExport = false

protected

Definition at line 50 of file Extended.php.

◆ $_lastColumnId

$_lastColumnId

protected

Definition at line 71 of file Extended.php.

◆ $_massactionBlockName

$_massactionBlockName = \Magento\Backend\Block\Widget\Grid\Massaction\Extended::class

protected

Definition at line 92 of file Extended.php.

◆ $_massactionIdField

$_massactionIdField

protected

Definition at line 78 of file Extended.php.

◆ $_massactionIdFilter

$_massactionIdFilter

protected

Definition at line 85 of file Extended.php.

◆ $_path

$_path = 'export'

protected

Definition at line 177 of file Extended.php.

◆ $_subtotals

$_subtotals = []

protected

Definition at line 160 of file Extended.php.

◆ $_template

$_template = 'Magento_Backend::widget/grid/extended.phtml'

protected

Definition at line 165 of file Extended.php.

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

vendor/magento/module-backend/Block/Widget/Grid/Extended.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _afterLoadCollection()

◆ _construct()

◆ _exportCsvItem()

◆ _exportIterateCollection()

◆ _getExportHeaders()

◆ _getExportTotals()

◆ _getFileContainerContent()

◆ _prepareCollection()

◆ _prepareColumns()

◆ _prepareGrid()

◆ _prepareLayout()

◆ _prepareMassaction()

◆ _prepareMassactionBlock()

◆ _prepareMassactionColumn()

◆ addColumn()

◆ addColumnAfter()

◆ addColumnsOrder()

◆ addExportType()

◆ getCollection()

◆ getColumnCount()

◆ getColumnSet()

◆ getColumnsOrder()

◆ getCountSubTotals()

◆ getCsv()

◆ getCsvFile()

◆ getEmptyCellColspan()

◆ getEmptyCellLabel()

◆ getEmptyText()

◆ getEmptyTextClass()

◆ getExcel()

◆ getExcelFile()

◆ getExportButtonHtml()

◆ getExportTypes()

◆ getFilterVisibility()

◆ getHeadersVisibility()

◆ getHtml()

◆ getIsCollapsed()

◆ getLastColumnId()

◆ getMainButtonsHtml()

◆ getMassactionBlock()

◆ getMassactionBlockHtml()

◆ getMassactionBlockName()

◆ getMassactionIdField()

◆ getMassactionIdFilter()

◆ getMultipleRowColumns()

◆ getMultipleRows()

◆ getRowRecord()

◆ getRowspan()

◆ getRowUrl()

◆ getSubTotalColumns()

◆ getSubTotalItem()

◆ getSubTotals()

◆ getXml()

◆ isColumnGrouped()

◆ removeColumn()

◆ setCollection()

◆ setCountSubTotals()

◆ setEmptyCellLabel()

◆ setEmptyText()

◆ setEmptyTextClass()

◆ setFilterVisibility()

◆ setHeadersVisibility()

◆ setIsCollapsed()

◆ setMassactionBlockName()

◆ setMassactionIdField()

◆ setMassactionIdFilter()

◆ setSubTotals()

◆ shouldRenderCell()

◆ shouldRenderEmptyCell()

◆ shouldRenderSubTotal()

◆ sortColumnsByOrder()

Field Documentation

◆ $_collection

◆ $_columns