Inheritance diagram for Checkbox:

Public Member Functions
	__construct (\Magento\Backend\Block\Context $context, \Magento\Backend\Block\Widget\Grid\Column\Renderer\Options\Converter $converter, array $data=[])

	getValues ()

	render (\Magento\Framework\DataObject $row)

	renderHeader ()

Public Member Functions inherited from AbstractRenderer
	setColumn ($column)

	getColumn ()

	render (DataObject $row)

	renderExport (DataObject $row)

	_getInputValueElement (DataObject $row)

	renderHeader ()

	renderProperty ()

	renderCss ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Backend\Block\Context $context, array $data=[])

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

Protected Member Functions
	_getValues ()

	_getCheckboxHtml ($value, $checked)

Protected Member Functions inherited from AbstractRenderer
	_getValue (DataObject $row)

	_getInputValue (DataObject $row)

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
	$_defaultWidth = 55

	$_values

	$_converter

Protected Attributes inherited from AbstractRenderer
	$_defaultWidth

	$_column

Protected Attributes inherited from AbstractBlock
	$_authorization

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

Grid checkbox column renderer

@api

Deprecated:: 100.2.0 in favour of UI component implementation

Since: 100.0.2

Definition at line 15 of file Checkbox.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Backend\Block\Context	$context,
		\Magento\Backend\Block\Widget\Grid\Column\Renderer\Options\Converter	$converter,
		array	$data = `[]`
	)

Parameters

\Magento\Backend\Block\Context	$context
\Magento\Backend\Block\Widget\Grid\Column\Renderer\Options\Converter	$converter
array	$data

Definition at line 37 of file Checkbox.php.

       {
         parent::__construct($context, $data);
         $this->_converter = $converter;
     }

Member Function Documentation

◆ _getCheckboxHtml()

_getCheckboxHtml	(	$value,
		$checked
	)

protected

Parameters

string	$value	Value of the element
bool	$checked	Whether it is checked

Returns: string

Definition at line 119 of file Checkbox.php.

     {
         $html = '<label class="data-grid-checkbox-cell-inner" ';
         $html .= ' for="id_' . $this->escapeHtml($value) . '">';
         $html .= '<input type="checkbox" ';
         $html .= 'name="' . $this->getColumn()->getFieldName() . '" ';
         $html .= 'value="' . $this->escapeHtml($value) . '" ';
         $html .= 'id="id_' . $this->escapeHtml($value) . '" ';
         $html .= 'class="' .
             ($this->getColumn()->getInlineCss() ? $this->getColumn()->getInlineCss() : 'checkbox') .
             ' admin__control-checkbox' . '"';
         $html .= $checked . $this->getDisabled() . '/>';
         $html .= '<label for="id_' . $this->escapeHtml($value) . '"></label>';
         $html .= '</label>';
         /* ToDo UI: add class="admin__field-label" after some refactoring _fields.less */
         return $html;
     }

◆ _getValues()

_getValues ( )

protected

Prepare data for renderer

Returns: array

Definition at line 64 of file Checkbox.php.

     {
         $values = $this->getColumn()->getValues();
         return $this->_converter->toFlatArray($values);
     }

◆ getValues()

getValues ( )

Returns values of the column

Returns: array

Definition at line 51 of file Checkbox.php.

     {
         if ($this->_values === null) {
             $this->_values = $this->getColumn()->getData('values') ? $this->getColumn()->getData('values') : [];
         }
         return $this->_values;
     }

◆ render()

render ( \Magento\Framework\DataObject $row )

Renders grid column

Parameters

\Magento\Framework\DataObject $row

Returns: string @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Implements RendererInterface.

Definition at line 78 of file Checkbox.php.

     {
         $values = $this->_getValues();
         $value = $row->getData($this->getColumn()->getIndex());
         $checked = '';
         if (is_array($values)) {
             $checked = in_array($value, $values) ? ' checked="checked"' : '';
         } else {
             $checkedValue = $this->getColumn()->getValue();
             if ($checkedValue !== null) {
                 $checked = $value === $checkedValue ? ' checked="checked"' : '';
             }
         }
 
         $disabled = '';
         $disabledValues = $this->getColumn()->getDisabledValues();
         if (is_array($disabledValues)) {
             $disabled = in_array($value, $disabledValues) ? ' disabled="disabled"' : '';
         } else {
             $disabledValue = $this->getColumn()->getDisabledValue();
             if ($disabledValue !== null) {
                 $disabled = $value === $disabledValue ? ' disabled="disabled"' : '';
             }
         }
 
         $this->setDisabled($disabled);
 
         if ($this->getNoObjectId() || $this->getColumn()->getUseIndex()) {
             $v = $value;
         } else {
             $v = $row->getId() != "" ? $row->getId() : $value;
         }
 
         return $this->_getCheckboxHtml($v, $checked);
     }

◆ renderHeader()

renderHeader ( )

Renders header of the column

Returns: string

Definition at line 142 of file Checkbox.php.

     {
         if ($this->getColumn()->getHeader()) {
             return parent::renderHeader();
         }
 
         $checked = '';
         if ($filter = $this->getColumn()->getFilter()) {
             $checked = $filter->getValue() ? ' checked="checked"' : '';
         }
 
         $disabled = '';
         if ($this->getColumn()->getDisabled()) {
             $disabled = ' disabled="disabled"';
         }
         $html = '<th class="data-grid-th data-grid-actions-cell"><input type="checkbox" ';
         $html .= 'name="' . $this->getColumn()->getFieldName() . '" ';
         $html .= 'onclick="' . $this->getColumn()->getGrid()->getJsObjectName() . '.checkCheckboxes(this)" ';
         $html .= 'class="admin__control-checkbox"' . $checked . $disabled . ' ';
         $html .= 'title="' . __('Select All') . '"/><label></label></th>';
         return $html;
     }

Field Documentation

◆ $_converter

$_converter

protected

Definition at line 30 of file Checkbox.php.

◆ $_defaultWidth

$_defaultWidth = 55

protected

Definition at line 20 of file Checkbox.php.

◆ $_values

$_values

protected

Definition at line 25 of file Checkbox.php.

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

vendor/magento/module-backend/Block/Widget/Grid/Column/Renderer/Checkbox.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getCheckboxHtml()

◆ _getValues()

◆ getValues()

◆ render()

◆ renderHeader()

Field Documentation

◆ $_converter

◆ $_defaultWidth

◆ $_values