Tree Class Reference

Inheritance diagram for Tree:

Public Member Functions
	__construct (\Magento\Backend\Block\Template\Context $context, \Magento\Catalog\Model\ResourceModel\Category\Tree $categoryTree, \Magento\Framework\Registry $registry, \Magento\Catalog\Model\CategoryFactory $categoryFactory, \Magento\Framework\Json\EncoderInterface $jsonEncoder, \Magento\Framework\DB\Helper $resourceHelper, \Magento\Backend\Model\Auth\Session $backendSession, array $data=[])
	getSuggestedCategoriesJson ($namePart)
	getAddRootButtonHtml ()
	getAddSubButtonHtml ()
	getExpandButtonHtml ()
	getCollapseButtonHtml ()
	getStoreSwitcherHtml ()
	getLoadTreeUrl ($expanded=null)
	getNodesUrl ()
	getSwitchTreeUrl ()
	getIsWasExpanded ()
	getMoveUrl ()
	getTree ($parenNodeCategory=null)
	getTreeJson ($parenNodeCategory=null)
	getBreadcrumbsJavascript ($path, $javascriptVarName)
	buildNodeName ($node)
	isClearEdit ()
	canAddRootCategory ()
	canAddSubCategory ()
Public Member Functions inherited from AbstractCategory
	__construct (\Magento\Backend\Block\Template\Context $context, \Magento\Catalog\Model\ResourceModel\Category\Tree $categoryTree, \Magento\Framework\Registry $registry, \Magento\Catalog\Model\CategoryFactory $categoryFactory, array $data=[])
	getCategory ()
	getCategoryId ()
	getCategoryName ()
	getCategoryPath ()
	hasStoreRootCategory ()
	getStore ()
	getRoot ($parentNodeCategory=null, $recursionLevel=3)
	getCategoryCollection ()
	getRootByIds ($ids)
	getNode ($parentNodeCategory, $recursionLevel=2)
	getSaveUrl (array $args=[])
	getEditUrl ()
	getRootIds ()
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 ()

Protected Member Functions
	_construct ()
	_prepareLayout ()
	_getNodeJson ($node, $level=0)
	_isCategoryMoveable ($node)
	_isParentSelectedCategory ($node)
Protected Member Functions inherited from AbstractCategory
	_getDefaultStoreId ()
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
	$_template = 'Magento_Catalog::catalog/category/tree.phtml'
	$_backendSession
	$_resourceHelper
	$_jsonEncoder
Protected Attributes inherited from AbstractCategory
	$_coreRegistry = null
	$_categoryTree
	$_categoryFactory
	$_withProductCount
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

Definition at line 25 of file Tree.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Backend\Block\Template\Context	$context,
		\Magento\Catalog\Model\ResourceModel\Category\Tree	$categoryTree,
		\Magento\Framework\Registry	$registry,
		\Magento\Catalog\Model\CategoryFactory	$categoryFactory,
		\Magento\Framework\Json\EncoderInterface	$jsonEncoder,
		\Magento\Framework\DB\Helper	$resourceHelper,
		\Magento\Backend\Model\Auth\Session	$backendSession,
		array	$data = []
	)

Parameters

\Magento\Backend\Block\Template\Context	$context
\Magento\Catalog\Model\ResourceModel\Category\Tree	$categoryTree
\Magento\Framework\Registry	$registry
\Magento\Catalog\Model\CategoryFactory	$categoryFactory
\Magento\Framework\Json\EncoderInterface	$jsonEncoder
\Magento\Framework\DB\Helper	$resourceHelper
\Magento\Backend\Model\Auth\Session	$backendSession
array	$data

Definition at line 57 of file Tree.php.

      {
        $this->_jsonEncoder = $jsonEncoder;
        $this->_resourceHelper = $resourceHelper;
        $this->_backendSession = $backendSession;
        parent::__construct($context, $categoryTree, $registry, $categoryFactory, $data);
    }

Member Function Documentation

_construct()

_construct ( )

protected

Returns

void

Definition at line 76 of file Tree.php.

    {
        parent::_construct();
        $this->setUseAjax(0);
    }

_getNodeJson()

_getNodeJson (   $node,   $level = 0  )

protected

Get JSON of a tree node or an associative array

Parameters

Node | array	$node
int	$level

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 332 of file Tree.php.

    {
        // create a node from data array
        if (is_array($node)) {
            $node = new Node($node, 'entity_id', new \Magento\Framework\Data\Tree());
        }

        $item = [];
        $item['text'] = $this->buildNodeName($node);

        $rootForStores = in_array($node->getEntityId(), $this->getRootIds());

        $item['id'] = $node->getId();
        $item['store'] = (int)$this->getStore()->getId();
        $item['path'] = $node->getData('path');

        $item['cls'] = 'folder ' . ($node->getIsActive() ? 'active-category' : 'no-active-category');
        //$item['allowDrop'] = ($level<3) ? true : false;
        $allowMove = $this->_isCategoryMoveable($node);
        $item['allowDrop'] = $allowMove;
        // disallow drag if it's first level and category is root of a store
        $item['allowDrag'] = $allowMove && ($node->getLevel() == 1 && $rootForStores ? false : true);

        if ((int)$node->getChildrenCount() > 0) {
            $item['children'] = [];
        }

        $isParent = $this->_isParentSelectedCategory($node);

        if ($node->hasChildren()) {
            $item['children'] = [];
            if (!($this->getUseAjax() && $node->getLevel() > 1 && !$isParent)) {
                foreach ($node->getChildren() as $child) {
                    $item['children'][] = $this->_getNodeJson($child, $level + 1);
                }
            }
        }

        if ($isParent || $node->getLevel() < 2) {
            $item['expanded'] = true;
        }

        return $item;
    }

_isCategoryMoveable()

_isCategoryMoveable (   $node )

protected

Parameters

Node | array

$node

Returns

bool

Definition at line 396 of file Tree.php.

    {
        $options = new \Magento\Framework\DataObject(['is_moveable' => true, 'category' => $node]);

        $this->_eventManager->dispatch('adminhtml_catalog_category_tree_is_moveable', ['options' => $options]);

        return $options->getIsMoveable();
    }

_isParentSelectedCategory()

_isParentSelectedCategory (   $node )

protected

Parameters

Node | array

$node

Returns

bool

Definition at line 409 of file Tree.php.

    {
        if ($node && $this->getCategory()) {
            $pathIds = $this->getCategory()->getPathIds();
            if (in_array($node->getId(), $pathIds)) {
                return true;
            }
        }

        return false;
    }

_prepareLayout()

_prepareLayout ( )

protected

Returns

$this

Definition at line 85 of file Tree.php.

    {
        $addUrl = $this->getUrl("*/*/add", ['_current' => false, 'id' => null, '_query' => false]);
        if ($this->getStore()->getId() == Store::DEFAULT_STORE_ID) {
            $this->addChild(
                'add_sub_button',
                \Magento\Backend\Block\Widget\Button::class,
                [
                    'label' => __('Add Subcategory'),
                    'onclick' => "addNew('" . $addUrl . "', false)",
                    'class' => 'add',
                    'id' => 'add_subcategory_button',
                    'style' => $this->canAddSubCategory() ? '' : 'display: none;'
                ]
            );

            if ($this->canAddRootCategory()) {
                $this->addChild(
                    'add_root_button',
                    \Magento\Backend\Block\Widget\Button::class,
                    [
                        'label' => __('Add Root Category'),
                        'onclick' => "addNew('" . $addUrl . "', true)",
                        'class' => 'add',
                        'id' => 'add_root_category_button'
                    ]
                );
            }
        }

        return parent::_prepareLayout();
    }

buildNodeName()

buildNodeName

(

$node

)

Get category name

Parameters

\Magento\Framework\DataObject

$node

Returns

string

Definition at line 383 of file Tree.php.

    {
        $result = $this->escapeHtml($node->getName());
        if ($this->_withProductCount) {
            $result .= ' (' . $node->getProductCount() . ')';
        }
        return $result;
    }

canAddRootCategory()

canAddRootCategory

(

)

Check availability of adding root category

Returns

boolean

Definition at line 436 of file Tree.php.

    {
        $options = new \Magento\Framework\DataObject(['is_allow' => true]);
        $this->_eventManager->dispatch(
            'adminhtml_catalog_category_tree_can_add_root_category',
            ['category' => $this->getCategory(), 'options' => $options, 'store' => $this->getStore()->getId()]
        );

        return $options->getIsAllow();
    }

canAddSubCategory()

canAddSubCategory

(

)

Check availability of adding sub category

Returns

boolean

Definition at line 452 of file Tree.php.

    {
        $options = new \Magento\Framework\DataObject(['is_allow' => true]);
        $this->_eventManager->dispatch(
            'adminhtml_catalog_category_tree_can_add_sub_category',
            ['category' => $this->getCategory(), 'options' => $options, 'store' => $this->getStore()->getId()]
        );

        return $options->getIsAllow();
    }

getAddRootButtonHtml()

getAddRootButtonHtml

(

)

Returns

string

Definition at line 187 of file Tree.php.

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

getAddSubButtonHtml()

getAddSubButtonHtml

(

)

Returns

string

Definition at line 195 of file Tree.php.

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

getBreadcrumbsJavascript()

getBreadcrumbsJavascript	(		$path,
			$javascriptVarName
	)

Get JSON of array of categories, that are breadcrumbs for specified category path

Parameters

string	$path
string	$javascriptVarName

Returns

string

Definition at line 302 of file Tree.php.

    {
        if (empty($path)) {
            return '';
        }

        $categories = $this->_categoryTree->setStoreId($this->getStore()->getId())->loadBreadcrumbsArray($path);
        if (empty($categories)) {
            return '';
        }
        foreach ($categories as $key => $category) {
            $categories[$key] = $this->_getNodeJson($category);
        }
        return '<script>require(["prototype"], function(){' . $javascriptVarName . ' = ' . $this->_jsonEncoder->encode(
            $categories
        ) .
            ';' .
            ($this->canAddSubCategory() ? '$("add_subcategory_button").show();' : '$("add_subcategory_button").hide();')
            . '});</script>';
    }

getCollapseButtonHtml()

getCollapseButtonHtml

(

)

Returns

string

Definition at line 211 of file Tree.php.

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

getExpandButtonHtml()

getExpandButtonHtml

(

)

Returns

string

Definition at line 203 of file Tree.php.

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

getIsWasExpanded()

getIsWasExpanded

(

)

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 260 of file Tree.php.

    {
        return $this->_backendSession->getIsTreeWasExpanded();
    }

getLoadTreeUrl()

getLoadTreeUrl

(

$expanded = null

)

Parameters

bool | null

$expanded

Returns

string

Definition at line 228 of file Tree.php.

    {
        $params = ['_current' => true, 'id' => null, 'store' => null];
        if ($expanded === null && $this->_backendSession->getIsTreeWasExpanded() || $expanded == true) {
            $params['expand_all'] = true;
        }
        return $this->getUrl('*/*/categoriesJson', $params);
    }

getMoveUrl()

getMoveUrl

(

)

Returns

string

Definition at line 268 of file Tree.php.

    {
        return $this->getUrl('catalog/category/move', ['store' => $this->getRequest()->getParam('store')]);
    }

getNodesUrl()

getNodesUrl

(

)

Returns

string

Definition at line 240 of file Tree.php.

    {
        return $this->getUrl('catalog/category/jsonTree');
    }

getStoreSwitcherHtml()

getStoreSwitcherHtml

(

)

Returns

string

Definition at line 219 of file Tree.php.

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

getSuggestedCategoriesJson()

getSuggestedCategoriesJson

(

$namePart

)

Retrieve list of categories with name containing $namePart and their parents

Parameters

string

$namePart

Returns

string

Definition at line 124 of file Tree.php.

    {
        $storeId = $this->getRequest()->getParam('store', $this->_getDefaultStoreId());

        /* @var $collection Collection */
        $collection = $this->_categoryFactory->create()->getCollection();

        $matchingNamesCollection = clone $collection;
        $escapedNamePart = $this->_resourceHelper->addLikeEscape(
            $namePart,
            ['position' => 'any']
        );
        $matchingNamesCollection->addAttributeToFilter(
            'name',
            ['like' => $escapedNamePart]
        )->addAttributeToFilter(
            'entity_id',
            ['neq' => \Magento\Catalog\Model\Category::TREE_ROOT_ID]
        )->addAttributeToSelect(
            'path'
        )->setStoreId(
            $storeId
        );

        $shownCategoriesIds = [];
        foreach ($matchingNamesCollection as $category) {
            foreach (explode('/', $category->getPath()) as $parentId) {
                $shownCategoriesIds[$parentId] = 1;
            }
        }

        $collection->addAttributeToFilter(
            'entity_id',
            ['in' => array_keys($shownCategoriesIds)]
        )->addAttributeToSelect(
            ['name', 'is_active', 'parent_id']
        )->setStoreId(
            $storeId
        );

        $categoryById = [
            \Magento\Catalog\Model\Category::TREE_ROOT_ID => [
                'id' => \Magento\Catalog\Model\Category::TREE_ROOT_ID,
                'children' => [],
            ],
        ];
        foreach ($collection as $category) {
            foreach ([$category->getId(), $category->getParentId()] as $categoryId) {
                if (!isset($categoryById[$categoryId])) {
                    $categoryById[$categoryId] = ['id' => $categoryId, 'children' => []];
                }
            }
            $categoryById[$category->getId()]['is_active'] = $category->getIsActive();
            $categoryById[$category->getId()]['label'] = $category->getName();
            $categoryById[$category->getParentId()]['children'][] = & $categoryById[$category->getId()];
        }

        return $this->_jsonEncoder->encode($categoryById[\Magento\Catalog\Model\Category::TREE_ROOT_ID]['children']);
    }

getSwitchTreeUrl()

getSwitchTreeUrl

(

)

Returns

string

Definition at line 248 of file Tree.php.

    {
        return $this->getUrl(
            'catalog/category/tree',
            ['_current' => true, 'store' => null, '_query' => false, 'id' => null, 'parent' => null]
        );
    }

getTree()

getTree

(

$parenNodeCategory = null

)

Parameters

mixed | null

$parenNodeCategory

Returns

array

Parameters

\Magento\Framework\Data\Tree\Node	$node
int	$depth
int	$currentLevel

Returns

\Magento\Catalog\Api\Data\CategoryTreeInterface

Definition at line 277 of file Tree.php.

    {
        $rootArray = $this->_getNodeJson($this->getRoot($parenNodeCategory));
        $tree = isset($rootArray['children']) ? $rootArray['children'] : [];
        return $tree;
    }

getTreeJson()

getTreeJson

(

$parenNodeCategory = null

)

Parameters

mixed | null

$parenNodeCategory

Returns

string

Definition at line 288 of file Tree.php.

    {
        $rootArray = $this->_getNodeJson($this->getRoot($parenNodeCategory));
        $json = $this->_jsonEncoder->encode(isset($rootArray['children']) ? $rootArray['children'] : []);
        return $json;
    }

isClearEdit()

isClearEdit

(

)

Check if page loaded by outside link to category edit

Returns

boolean

Definition at line 426 of file Tree.php.

    {
        return (bool)$this->getRequest()->getParam('clear');
    }

Field Documentation

$_backendSession

$_backendSession

protected

Definition at line 35 of file Tree.php.

$_jsonEncoder

$_jsonEncoder

protected

Definition at line 45 of file Tree.php.

$_resourceHelper

$_resourceHelper

protected

Definition at line 40 of file Tree.php.

$_template

$_template = 'Magento_Catalog::catalog/category/tree.phtml'

protected

Definition at line 30 of file Tree.php.

---

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

• vendor/magento/module-catalog/Block/Adminhtml/Category/Tree.php