Inheritance diagram for AbstractCategory:

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, 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
	_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
	$_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

Class AbstractCategory

Definition at line 14 of file AbstractCategory.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,
		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
array	$data

Definition at line 45 of file AbstractCategory.php.

       {
         $this->_categoryTree = $categoryTree;
         $this->_coreRegistry = $registry;
         $this->_categoryFactory = $categoryFactory;
         $this->_withProductCount = true;
         parent::__construct($context, $data);
     }

Member Function Documentation

◆ _getDefaultStoreId()

_getDefaultStoreId ( )

protected

Returns: int

Definition at line 167 of file AbstractCategory.php.

     {
         return \Magento\Store\Model\Store::DEFAULT_STORE_ID;
     }

◆ getCategory()

getCategory ( )

Retrieve current category instance

Returns: array|null

Definition at line 64 of file AbstractCategory.php.

     {
         return $this->_coreRegistry->registry('category');
     }

◆ getCategoryCollection()

getCategoryCollection ( )

Returns: \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection

Definition at line 175 of file AbstractCategory.php.

     {
         $storeId = $this->getRequest()->getParam('store', $this->_getDefaultStoreId());
         $collection = $this->getData('category_collection');
         if ($collection === null) {
             $collection = $this->_categoryFactory->create()->getCollection();
 
             $collection->addAttributeToSelect(
                 'name'
             )->addAttributeToSelect(
                 'is_active'
             )->setProductStoreId(
                 $storeId
             )->setLoadProductCount(
                 $this->_withProductCount
             )->setStoreId(
                 $storeId
             );
 
             $this->setData('category_collection', $collection);
         }
         return $collection;
     }

◆ getCategoryId()

getCategoryId ( )

Returns: int|string|null

Definition at line 72 of file AbstractCategory.php.

     {
         if ($this->getCategory()) {
             return $this->getCategory()->getId();
         }
         return \Magento\Catalog\Model\Category::TREE_ROOT_ID;
     }

◆ getCategoryName()

getCategoryName ( )

Returns: string

Definition at line 83 of file AbstractCategory.php.

     {
         return $this->getCategory()->getName();
     }

◆ getCategoryPath()

getCategoryPath ( )

Returns: mixed

Definition at line 91 of file AbstractCategory.php.

     {
         if ($this->getCategory()) {
             return $this->getCategory()->getPath();
         }
         return \Magento\Catalog\Model\Category::TREE_ROOT_ID;
     }

◆ getEditUrl()

getEditUrl ( )

Returns: string

Definition at line 265 of file AbstractCategory.php.

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

◆ getNode()

getNode	(	$parentNodeCategory,
		$recursionLevel = `2`
	)

Parameters

mixed	$parentNodeCategory
int	$recursionLevel

Returns: Node

Definition at line 234 of file AbstractCategory.php.

     {
         $nodeId = $parentNodeCategory->getId();
         $node = $this->_categoryTree->loadNode($nodeId);
         $node->loadChildren($recursionLevel);
 
         if ($node && $nodeId != \Magento\Catalog\Model\Category::TREE_ROOT_ID) {
             $node->setIsVisible(true);
         } elseif ($node && $node->getId() == \Magento\Catalog\Model\Category::TREE_ROOT_ID) {
             $node->setName(__('Root'));
         }
 
         $this->_categoryTree->addCollectionData($this->getCategoryCollection());
 
         return $node;
     }

◆ getRoot()

getRoot	(	$parentNodeCategory = `null`,
		$recursionLevel = `3`
	)

Parameters

mixed \| null	$parentNodeCategory
int	$recursionLevel

Returns: Node|array|null @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 126 of file AbstractCategory.php.

     {
         if ($parentNodeCategory !== null && $parentNodeCategory->getId()) {
             return $this->getNode($parentNodeCategory, $recursionLevel);
         }
         $root = $this->_coreRegistry->registry('root');
         if ($root === null) {
             $storeId = (int)$this->getRequest()->getParam('store');
 
             if ($storeId) {
                 $store = $this->_storeManager->getStore($storeId);
                 $rootId = $store->getRootCategoryId();
             } else {
                 $rootId = \Magento\Catalog\Model\Category::TREE_ROOT_ID;
             }
 
             $tree = $this->_categoryTree->load(null, $recursionLevel);
 
             if ($this->getCategory()) {
                 $tree->loadEnsuredNodes($this->getCategory(), $tree->getNodeById($rootId));
             }
 
             $tree->addCollectionData($this->getCategoryCollection());
 
             $root = $tree->getNodeById($rootId);
 
             if ($root && $rootId != \Magento\Catalog\Model\Category::TREE_ROOT_ID) {
                 $root->setIsVisible(true);
             } elseif ($root && $root->getId() == \Magento\Catalog\Model\Category::TREE_ROOT_ID) {
                 $root->setName(__('Root'));
             }
 
             $this->_coreRegistry->register('root', $root);
         }
 
         return $root;
     }

◆ getRootByIds()

getRootByIds ( $ids )

Get and register categories root by specified categories IDs

IDs can be arbitrary set of any categories ids. Tree with minimal required nodes (all parents and neighbours) will be built. If ids are empty, default tree with depth = 2 will be returned.

Parameters

array $ids

Returns: mixed

Definition at line 209 of file AbstractCategory.php.

     {
         $root = $this->_coreRegistry->registry('root');
         if (null === $root) {
             $ids = $this->_categoryTree->getExistingCategoryIdsBySpecifiedIds($ids);
             $tree = $this->_categoryTree->loadByIds($ids);
             $rootId = \Magento\Catalog\Model\Category::TREE_ROOT_ID;
             $root = $tree->getNodeById($rootId);
             if ($root && $rootId != \Magento\Catalog\Model\Category::TREE_ROOT_ID) {
                 $root->setIsVisible(true);
             } elseif ($root && $root->getId() == \Magento\Catalog\Model\Category::TREE_ROOT_ID) {
                 $root->setName(__('Root'));
             }
 
             $tree->addCollectionData($this->getCategoryCollection());
             $this->_coreRegistry->register('root', $root);
         }
         return $root;
     }

◆ getRootIds()

getRootIds ( )

Return ids of root categories as array

Returns: array

Definition at line 278 of file AbstractCategory.php.

     {
         $ids = $this->getData('root_ids');
         if ($ids === null) {
             $ids = [\Magento\Catalog\Model\Category::TREE_ROOT_ID];
             foreach ($this->_storeManager->getGroups() as $store) {
                 $ids[] = $store->getRootCategoryId();
             }
             $this->setData('root_ids', $ids);
         }
         return $ids;
     }

◆ getSaveUrl()

getSaveUrl ( array $args = [] )

Parameters

array $args

Returns: string

Definition at line 255 of file AbstractCategory.php.

     {
         $params = ['_current' => false, '_query' => false, 'store' => $this->getStore()->getId()];
         $params = array_merge($params, $args);
         return $this->getUrl('catalog/*/save', $params);
     }

◆ getStore()

getStore ( )

Returns: Store

Definition at line 114 of file AbstractCategory.php.

     {
         $storeId = (int)$this->getRequest()->getParam('store');
         return $this->_storeManager->getStore($storeId);
     }

◆ hasStoreRootCategory()

hasStoreRootCategory ( )

Returns: bool

Definition at line 102 of file AbstractCategory.php.

     {
         $root = $this->getRoot();
         if ($root && $root->getId()) {
             return true;
         }
         return false;
     }

Field Documentation

◆ $_categoryFactory

$_categoryFactory

protected

Definition at line 31 of file AbstractCategory.php.

◆ $_categoryTree

$_categoryTree

protected

Definition at line 26 of file AbstractCategory.php.

◆ $_coreRegistry

$_coreRegistry = null

protected

Definition at line 21 of file AbstractCategory.php.

◆ $_withProductCount

$_withProductCount

protected

Definition at line 36 of file AbstractCategory.php.

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

vendor/magento/module-catalog/Block/Adminhtml/Category/AbstractCategory.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getDefaultStoreId()

◆ getCategory()

◆ getCategoryCollection()

◆ getCategoryId()

◆ getCategoryName()

◆ getCategoryPath()

◆ getEditUrl()

◆ getNode()

◆ getRoot()

◆ getRootByIds()

◆ getRootIds()

◆ getSaveUrl()

◆ getStore()

◆ hasStoreRootCategory()

Field Documentation

◆ $_categoryFactory

◆ $_categoryTree

◆ $_coreRegistry

◆ $_withProductCount