Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-backend/Block/Widget/Grid/Massaction/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Backend\Block\Widget\Grid\Massaction;
use Magento\Backend\Block\Template\Context;
use Magento\Backend\Block\Widget;
use Magento\Backend\Block\Widget\Grid\Column;
use Magento\Backend\Block\Widget\Grid\ColumnSet;
use Magento\Backend\Block\Widget\Grid\Massaction\VisibilityCheckerInterface as VisibilityChecker;
use Magento\Framework\Data\Collection\AbstractDb;
use Magento\Framework\DataObject;
use Magento\Framework\DB\Select;
use Magento\Framework\Json\EncoderInterface;
use Magento\Quote\Model\Quote;
/**
* Grid widget massaction block
*
* phpcs:disable Magento2.Classes.AbstractApi
* @api
* @method Quote setHideFormElement(boolean $value) Hide Form element to prevent IE errors
* @method boolean getHideFormElement()
* @deprecated 100.2.0 in favour of UI component implementation
* @since 100.0.2
*/
abstract class AbstractMassaction extends Widget
{
/**
* @var EncoderInterface
*/
protected $_jsonEncoder;
/**
* Massaction items
*
* @var array
*/
protected $_items = [];
/**
* @var string
*/
protected $_template = 'Magento_Backend::widget/grid/massaction.phtml';
/**
* @param Context $context
* @param EncoderInterface $jsonEncoder
* @param array $data
*/
public function __construct(
Context $context,
EncoderInterface $jsonEncoder,
array $data = []
) {
$this->_jsonEncoder = $jsonEncoder;
parent::__construct($context, $data);
}
/**
* @inheritdoc
*/
protected function _construct()
{
parent::_construct();
$this->setErrorText($this->escapeHtml(__('An item needs to be selected. Select and try again.')));
if (null !== $this->getOptions()) {
foreach ($this->getOptions() as $optionId => $option) {
$this->addItem($optionId, $option);
}
$this->unsetData('options');
}
}
/**
* Add new massaction item
*
* Item array to be passed in looks like:
* $item = array(
* 'label' => string,
* 'complete' => string, // Only for ajax enabled grid (optional)
* 'url' => string,
* 'confirm' => string, // text of confirmation of this action (optional)
* 'additional' => string, // (optional)
* 'visible' => object // instance of VisibilityCheckerInterface (optional)
* );
*
* @param string $itemId
* @param array|DataObject $item
* @return $this
*/
public function addItem($itemId, $item)
{
if (is_array($item)) {
$item = new DataObject($item);
}
if ($item instanceof DataObject && $this->isVisible($item)) {
$item->setId($itemId);
$item->setUrl($this->getUrl($item->getUrl()));
$this->_items[$itemId] = $item;
}
return $this;
}
/**
* Check that item can be added to list
*
* @param DataObject $item
* @return bool
*/
private function isVisible(DataObject $item)
{
/** @var VisibilityChecker $checker */
$checker = $item->getData('visible');
return (!$checker instanceof VisibilityChecker) || $checker->isVisible();
}
/**
* Retrieve massaction item with id $itemId
*
* @param string $itemId
* @return \Magento\Backend\Block\Widget\Grid\Massaction\Item|null
*/
public function getItem($itemId)
{
return $this->_items[$itemId] ?? null;
}
/**
* Retrieve massaction items
*
* @return array
*/
public function getItems()
{
return $this->_items;
}
/**
* Retrieve massaction items JSON
*
* @return string
*/
public function getItemsJson()
{
$result = [];
foreach ($this->getItems() as $itemId => $item) {
$result[$itemId] = $item->toArray();
}
return $this->_jsonEncoder->encode($result);
}
/**
* Retrieve massaction items count
*
* @return integer
*/
public function getCount()
{
return count($this->_items);
}
/**
* Checks are massactions available
*
* @return boolean
*/
public function isAvailable()
{
return $this->getCount() > 0 && $this->getMassactionIdField();
}
/**
* Retrieve global form field name for all massaction items
*
* @return string
*/
public function getFormFieldName()
{
return $this->getData('form_field_name') ? $this->getData('form_field_name') : 'massaction';
}
/**
* Retrieve form field name for internal use. Based on $this->getFormFieldName()
*
* @return string
*/
public function getFormFieldNameInternal()
{
return 'internal_' . $this->getFormFieldName();
}
/**
* Retrieve massaction block js object name
*
* @return string
*/
public function getJsObjectName()
{
return $this->getHtmlId() . 'JsObject';
}
/**
* Retrieve grid block js object name
*
* @return string
*/
public function getGridJsObjectName()
{
return $this->getParentBlock()->getJsObjectName();
}
/**
* Retrieve JSON string of selected checkboxes
*
* @return string
* @SuppressWarnings(PHPMD.RequestAwareBlockMethod)
*/
public function getSelectedJson()
{
if ($selected = $this->getRequest()->getParam($this->getFormFieldNameInternal())) {
$selected = explode(',', $selected);
return join(',', $selected);
}
return '';
}
/**
* Retrieve array of selected checkboxes
*
* @return string[]
* @SuppressWarnings(PHPMD.RequestAwareBlockMethod)
*/
public function getSelected()
{
if ($selected = $this->getRequest()->getParam($this->getFormFieldNameInternal())) {
$selected = explode(',', $selected);
return $selected;
}
return [];
}
/**
* Retrieve apply button html
*
* @return string
*/
public function getApplyButtonHtml()
{
return $this->getButtonHtml(__('Submit'), $this->getJsObjectName() . ".apply()");
}
/**
* Get mass action javascript code.
*
* @return string
*/
public function getJavaScript()
{
return " {$this->getJsObjectName()} = new varienGridMassaction('{$this->getHtmlId()}', " .
"{$this->getGridJsObjectName()}, '{$this->getSelectedJson()}'" .
", '{$this->getFormFieldNameInternal()}', '{$this->getFormFieldName()}');" .
"{$this->getJsObjectName()}.setItems({$this->getItemsJson()}); " .
"{$this->getJsObjectName()}.setGridIds('{$this->getGridIdsJson()}');" .
($this->getUseAjax() ? "{$this->getJsObjectName()}.setUseAjax(true);" : '') .
($this->getUseSelectAll() ? "{$this->getJsObjectName()}.setUseSelectAll(true);" : '') .
"{$this->getJsObjectName()}.errorText = '{$this->getErrorText()}';" . "\n" .
"window.{$this->getJsObjectName()} = {$this->getJsObjectName()};";
}
/**
* Get grid ids in JSON format.
*
* @return string
*/
public function getGridIdsJson()
{
if (!$this->getUseSelectAll()) {
return '';
}
/** @var \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection $collection */
$collection = clone $this->getParentBlock()->getCollection();
if ($collection instanceof AbstractDb) {
$idsSelect = clone $collection->getSelect();
$idsSelect->reset(Select::ORDER);
$idsSelect->reset(Select::LIMIT_COUNT);
$idsSelect->reset(Select::LIMIT_OFFSET);
$idsSelect->reset(Select::COLUMNS);
$idsSelect->columns($this->getMassactionIdField());
$idList = $collection->getConnection()->fetchCol($idsSelect);
} else {
$idList = $collection->setPageSize(0)->getColumnValues($this->getMassactionIdField());
}
return implode(',', $idList);
}
/**
* Get Html id.
*
* @return string
*/
public function getHtmlId()
{
return $this->getParentBlock()->getHtmlId() . '_massaction';
}
/**
* Remove existing massaction item by its id
*
* @param string $itemId
* @return $this
*/
public function removeItem($itemId)
{
if (isset($this->_items[$itemId])) {
unset($this->_items[$itemId]);
}
return $this;
}
/**
* Retrieve select all functionality flag check
*
* @return boolean
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getUseSelectAll()
{
return $this->_getData('use_select_all') === null || $this->_getData('use_select_all');
}
/**
* Retrieve select all functionality flag check
*
* @param boolean $flag
* @return $this
*/
public function setUseSelectAll($flag)
{
$this->setData('use_select_all', (bool)$flag);
return $this;
}
/**
* Prepare grid massaction column
*
* @return $this
*/
public function prepareMassactionColumn()
{
$columnId = 'massaction';
$massactionColumn = $this->getLayout()->createBlock(
Column::class
)->setData(
[
'index' => $this->getMassactionIdField(),
'filter_index' => $this->getMassactionIdFilter(),
'type' => 'massaction',
'name' => $this->getFormFieldName(),
'is_system' => true,
'header_css_class' => 'col-select',
'column_css_class' => 'col-select',
]
);
if ($this->getNoFilterMassactionColumn()) {
$massactionColumn->setData('filter', false);
}
$gridBlock = $this->getParentBlock();
$massactionColumn->setSelected($this->getSelected())->setGrid($gridBlock)->setId($columnId);
/** @var $columnSetBlock ColumnSet */
$columnSetBlock = $gridBlock->getColumnSet();
$childNames = $columnSetBlock->getChildNames();
$siblingElement = count($childNames) ? current($childNames) : 0;
$columnSetBlock->insert($massactionColumn, $siblingElement, false, $columnId);
return $this;
}
}