How is the categories chooser implemented on a backend product's screen?

dmitry_fedyuk · February 18, 2016, 10:21am

magento/magento2/blob/2ea8cdd7/app/code/Magento/Catalog/Block/Adminhtml/Product/Helper/Form/Category.php#L125-L145


    $selectorOptions = $this->_jsonEncoder->encode($this->_getSelectorOptions());
    $newCategoryCaption = __('New Category');


    $button = $this->_layout->createBlock(
        'Magento\Backend\Block\Widget\Button'
    )->setData(
            [
                'id' => 'add_category_button',
                'label' => $newCategoryCaption,
                'title' => $newCategoryCaption,
                'onclick' => 'jQuery("#new-category").modal("openModal")',
                'disabled' => $this->getDisabled(),
            ]
        );
    $return = <<<HTML
<input id="{$htmlId}-suggest" placeholder="$suggestPlaceholder" />
<script>
    require(["jquery", "mage/mage"], function($){
        $('#{$htmlId}-suggest').mage('treeSuggest', {$selectorOptions});
    });
</script>

github.com

magento/magento2/blob/2ea8cdd7/app/code/Magento/Catalog/Block/Adminhtml/Product/Helper/Form/Category.php#L150-L164


/**
 * Get selector options
 *
 * @return array
 */
protected function _getSelectorOptions()
{
    return [
        'source' => $this->_backendData->getUrl('catalog/category/suggestCategories'),
        'valueField' => '#' . $this->getHtmlId(),
        'className' => 'category-select',
        'multiselect' => true,
        'showAll' => true
    ];
}

github.com

magento/magento2/blob/2ea8cdd7/app/code/Magento/Catalog/Controller/Adminhtml/Category/SuggestCategories.php#L36-L49


/**
 * Category list suggestion based on already entered symbols
 *
 * @return \Magento\Framework\Controller\Result\Json
 */
public function execute()
{
    /** @var \Magento\Framework\Controller\Result\Json $resultJson */
    $resultJson = $this->resultJsonFactory->create();
    return $resultJson->setJsonData(
        $this->layoutFactory->create()->createBlock('Magento\Catalog\Block\Adminhtml\Category\Tree')
            ->getSuggestedCategoriesJson($this->getRequest()->getParam('label_part'))
    );
}

github.com

magento/magento2/blob/2ea8cdd7/app/code/Magento/Catalog/Block/Adminhtml/Category/Tree.php#L109-L115


/**
 * Retrieve list of categories with name containing $namePart and their parents
 *
 * @param string $namePart
 * @return string
 */
public function getSuggestedCategoriesJson($namePart)

dmitry_fedyuk · February 18, 2016, 10:37am

See also:

Magento 2 standard form field (element) types

twistedindustries · May 2, 2016, 5:19pm

Trying to make a module that will allow me to make a “repeatable field”. Seems like using this as a base would be a good start, the thing I am struggling with is where is it assigned that attribute ‘category_ids’ should use this code? Aren’t helpers usually applied through the xml in etc?

dmitry_fedyuk · May 2, 2016, 5:30pm

The article does not contain the category_ids word.
Please give the exact link to the Magento 2 source code what you are talking about.

twistedindustries · May 2, 2016, 5:34pm

I can’t find the source code, thats the problem I was hoping you could help with. The question here is: How is the categories chooser implemented on a backend product’s screen? The categories chooser is just an attribute called ‘category_ids’ that is set as a ‘Text’ type field. Where would it tell it to use the code here: magento/magento2/blob/2ea8cdd7/app/code/Magento/Catalog/Block/Adminhtml/Product/Helper/Form/Category.php#L125-L145

dmitry_fedyuk · May 2, 2016, 5:45pm

Thanks for the clarification, I understand now.
The association is here:
https://github.com/magento/magento2/blob/958164/app/code/Magento/Catalog/Setup/CategorySetup.php#L731-L741