I have an idea of creating a widget, one of the features of which would be to choose a product/category, and get their URL to pass on and fool around with it later.
I looked at default widgets, there’s this “Catalog Category Link” and the one for the product, and they both use a built-in Chooser.php. I tried to use it, but it returned me some sort of relative URL like product/3/4, while I wanted the absolute one. So I tried to override the Chooser.php so it would return that. I added a method to get category Url based on ID, and the value is what I actually want – however, I don’t know how to make the Chooser pass exactly that value.
I tried to use setData() but either I did it wrong, or it somehow didn’t work for me. Here’s the code for Chooser.php:
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* Product Chooser for "Product Link" Cms Widget Plugin
*
* @author Magento Core Team <[email protected]>
*/
namespace ScandiwebDemoWidgetBlockAdminhtmlWidget;
use MagentoBackendBlockWidgetGrid;
use MagentoBackendBlockWidgetGridColumn;
use MagentoBackendBlockWidgetGridExtended;
use MagentoFrameworkDataFormElementAbstractElement;
use MagentoCatalogApiCategoryRepositoryInterface;
class Chooser extends Extended
{
/**
* @var array
*/
protected $_selectedProducts = [];
/**
* @var MagentoCatalogModelResourceModelCategory
*/
protected $_resourceCategory;
/**
* @var MagentoCatalogModelResourceModelProduct
*/
protected $_resourceProduct;
/**
* @var MagentoCatalogModelResourceModelProductCollectionFactory
*/
protected $_collectionFactory;
/**
* @var MagentoCatalogModelCategoryFactory
*/
protected $_categoryFactory;
protected $_storeManager;
protected $categoryRepository;
/**
* @param MagentoBackendBlockTemplateContext $context
* @param MagentoBackendHelperData $backendHelper
* @param MagentoCatalogModelCategoryFactory $categoryFactory
* @param MagentoCatalogModelResourceModelProductCollectionFactory $collectionFactory
* @param MagentoCatalogModelResourceModelCategory $resourceCategory
* @param MagentoCatalogModelResourceModelProduct $resourceProduct
* @param array $data
*/
public function __construct(
MagentoBackendBlockTemplateContext $context,
MagentoBackendHelperData $backendHelper,
MagentoCatalogModelCategoryFactory $categoryFactory,
MagentoCatalogModelResourceModelProductCollectionFactory $collectionFactory,
MagentoCatalogModelResourceModelCategory $resourceCategory,
MagentoCatalogModelResourceModelProduct $resourceProduct,
MagentoStoreModelStoreManagerInterface $storeManager,
MagentoCatalogModelCategoryRepository $categoryRepository,
array $data = []
) {
$this->_categoryFactory = $categoryFactory;
$this->_collectionFactory = $collectionFactory;
$this->_resourceCategory = $resourceCategory;
$this->_resourceProduct = $resourceProduct;
$this->_storeManager = $storeManager;
$this->categoryRepository = $categoryRepository;
parent::__construct($context, $backendHelper, $data);
}
/**
* Block construction, prepare grid params
*
* @return void
*/
protected function _construct()
{
parent::_construct();
$this->setDefaultSort('name');
$this->setUseAjax(true);
}
/**
* Prepare chooser element HTML
*
* @param AbstractElement $element Form Element
* @return AbstractElement
*/
public function getCategoryUrl($id) {
$category = $this->categoryRepository->get($id, $this->_storeManager->getStore()->getId());
return $category->getUrl();
}
public function prepareElementHtml(AbstractElement $element)
{
$uniqId = $element->getId();
$sourceUrl = $this->getUrl(
'catalog/product_widget/chooser',
['uniq_id' => $uniqId, 'use_massaction' => false]
);
$chooser = $this->getLayout()->createBlock(
MagentoWidgetBlockAdminhtmlWidgetChooser::class
)->setElement(
$element
)->setConfig(
$this->getConfig()
)->setFieldsetId(
$this->getFieldsetId()
)->setSourceUrl(
$sourceUrl
)->setUniqId(
$uniqId
);
if ($element->getValue()) {
$value = explode('/', $element->getValue());
$productId = false;
if (isset($value[0]) && isset($value[1]) && $value[0] == 'product') {
$productId = $value[1];
}
$categoryId = isset($value[2]) ? $value[2] : false;
$label = '';
if ($categoryId) {
$label = $this->_resourceCategory->getAttributeRawValue(
$categoryId,
'name',
$this->_storeManager->getStore()
) . '/';
$categoryUrl = $this->getCategoryUrl($categoryId);
$element->setData('after_element_html', $categoryUrl);
print_r($element->getValue());
}
if ($productId) {
$label .= $this->_resourceProduct->getAttributeRawValue(
$productId,
'name',
$this->_storeManager->getStore()
);
}
$chooser->setLabel($label);
}
$element->setData('after_element_html', $chooser->toHtml());
return $element;
}
/**
* Checkbox Check JS Callback
*
* @return string
*/
public function getCheckboxCheckCallback()
{
if ($this->getUseMassaction()) {
return "function (grid, element) {
$(grid.containerId).fire('product:changed', {element: element});
}";
}
}
/**
* Grid Row JS Callback
*
* @return string
*/
public function getRowClickCallback()
{
if (!$this->getUseMassaction()) {
$chooserJsObject = $this->getId();
return '
function (grid, event) {
var trElement = Event.findElement(event, "tr");
var productId = trElement.down("td").innerHTML;
var productName = trElement.down("td").next().next().innerHTML;
var optionLabel = productName;
var optionValue = "product/" + productId.replace(/^s+|s+$/g,"");
if (grid.categoryId) {
optionValue += "/" + grid.categoryId;
}
if (grid.categoryName) {
optionLabel = grid.categoryName + " / " + optionLabel;
}
' .
$chooserJsObject .
'.setElementValue(optionValue);
' .
$chooserJsObject .
'.setElementLabel(optionLabel);
' .
$chooserJsObject .
'.close();
}
';
}
}
/**
* Category Tree node onClick listener js function
*
* @return string
*/
public function getCategoryClickListenerJs()
{
$js = '
function (node, e) {
{jsObject}.addVarToUrl("category_id", node.attributes.id);
{jsObject}.reload({jsObject}.url);
{jsObject}.categoryId = node.attributes.id != "none" ? node.attributes.id : false;
{jsObject}.categoryName = node.attributes.id != "none" ? node.text : false;
}
';
$js = str_replace('{jsObject}', $this->escapeJs($this->getJsObjectName()), $js);
return $js;
}
/**
* Filter checked/unchecked rows in grid
*
* @param Column $column
* @return $this
*/
protected function _addColumnFilterToCollection($column)
{
if ($column->getId() == 'in_products') {
$selected = $this->getSelectedProducts();
if ($column->getFilter()->getValue()) {
$this->getCollection()->addFieldToFilter('entity_id', ['in' => $selected]);
} else {
$this->getCollection()->addFieldToFilter('entity_id', ['nin' => $selected]);
}
} else {
parent::_addColumnFilterToCollection($column);
}
return $this;
}
/**
* Prepare products collection, defined collection filters (category, product type)
*
* @return Extended
*/
protected function _prepareCollection()
{
/* @var $collection MagentoCatalogModelResourceModelProductCollection */
$collection = $this->_collectionFactory->create()->setStoreId(0)->addAttributeToSelect('name');
if ($categoryId = $this->getCategoryId()) {
$category = $this->_categoryFactory->create()->load($categoryId);
if ($category->getId()) {
// $collection->addCategoryFilter($category);
$productIds = $category->getProductsPosition();
$productIds = array_keys($productIds);
if (empty($productIds)) {
$productIds = 0;
}
$collection->addFieldToFilter('entity_id', ['in' => $productIds]);
}
}
if ($productTypeId = $this->getProductTypeId()) {
$collection->addAttributeToFilter('type_id', $productTypeId);
}
$this->setCollection($collection);
return parent::_prepareCollection();
}
/**
* Prepare columns for products grid
*
* @return Extended
*/
protected function _prepareColumns()
{
if ($this->getUseMassaction()) {
$this->addColumn(
'in_products',
[
'header_css_class' => 'a-center',
'type' => 'checkbox',
'name' => 'in_products',
'inline_css' => 'checkbox entities',
'field_name' => 'in_products',
'values' => $this->getSelectedProducts(),
'align' => 'center',
'index' => 'entity_id',
'use_index' => true
]
);
}
$this->addColumn(
'entity_id',
[
'header' => __('ID'),
'sortable' => true,
'index' => 'entity_id',
'header_css_class' => 'col-id',
'column_css_class' => 'col-id'
]
);
$this->addColumn(
'chooser_sku',
[
'header' => __('SKU'),
'name' => 'chooser_sku',
'index' => 'sku',
'header_css_class' => 'col-sku',
'column_css_class' => 'col-sku'
]
);
$this->addColumn(
'chooser_name',
[
'header' => __('Product'),
'name' => 'chooser_name',
'index' => 'name',
'header_css_class' => 'col-product',
'column_css_class' => 'col-product'
]
);
return parent::_prepareColumns();
}
/**
* Adds additional parameter to URL for loading only products grid
*
* @return string
*/
public function getGridUrl()
{
return $this->getUrl(
'catalog/product_widget/chooser',
[
'products_grid' => true,
'_current' => true,
'uniq_id' => $this->getId(),
'use_massaction' => $this->getUseMassaction(),
'product_type_id' => $this->getProductTypeId()
]
);
}
/**
* Setter
*
* @param array $selectedProducts
* @return $this
*/
public function setSelectedProducts($selectedProducts)
{
$this->_selectedProducts = $selectedProducts;
return $this;
}
/**
* Getter
*
* @return array
*/
public function getSelectedProducts()
{
if ($selectedProducts = $this->getRequest()->getParam('selected_products', null)) {
$this->setSelectedProducts($selectedProducts);
}
return $this->_selectedProducts;
}
}
I have a feeling that it’s something that I have to add to $chooser at prepareElementHtml(), but again, I don’t know what to do and googlind haven’t helped so far. Any help would be appreciated!