Inheritance diagram for Navigation:

Public Member Functions
	__construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Catalog\Model\CategoryFactory $categoryFactory, \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory, \Magento\Catalog\Model\Layer\Resolver $layerResolver, \Magento\Framework\App\Http\Context $httpContext, \Magento\Catalog\Helper\Category $catalogCategory, \Magento\Framework\Registry $registry, \Magento\Catalog\Model\Indexer\Category\Flat\State $flatState, array $data=[])

	getCategory ()

	getCacheKeyInfo ()

	getCurrentCategoryKey ()

	isCategoryActive ($category)

	getCategoryUrl ($category)

	getCurrentCategory ()

	getIdentities ()

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 ()

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
	$_categoryInstance

	$_currentCategoryKey

	$_itemLevelPositions = []

	$_catalogCategory

	$_registry

	$httpContext

	$_catalogLayer

	$_productCollectionFactory

	$flatState

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

Catalog navigation

@api @SuppressWarnings(PHPMD.LongVariable) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 20 of file Navigation.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\View\Element\Template\Context	$context,
		\Magento\Catalog\Model\CategoryFactory	$categoryFactory,
		\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory	$productCollectionFactory,
		\Magento\Catalog\Model\Layer\Resolver	$layerResolver,
		\Magento\Framework\App\Http\Context	$httpContext,
		\Magento\Catalog\Helper\Category	$catalogCategory,
		\Magento\Framework\Registry	$registry,
		\Magento\Catalog\Model\Indexer\Category\Flat\State	$flatState,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\View\Element\Template\Context	$context
\Magento\Catalog\Model\CategoryFactory	$categoryFactory
\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory	$productCollectionFactory
\Magento\Catalog\Model\Layer\Resolver	$layerResolver
\Magento\Framework\App\Http\Context	$httpContext
\Magento\Catalog\Helper\Category	$catalogCategory
\Magento\Framework\Registry	$registry
\Magento\Catalog\Model\Indexer\Category\Flat\State	$flatState
array	$data

Definition at line 91 of file Navigation.php.

       {
         $this->_productCollectionFactory = $productCollectionFactory;
         $this->_catalogLayer = $layerResolver->get();
         $this->httpContext = $httpContext;
         $this->_catalogCategory = $catalogCategory;
         $this->_registry = $registry;
         $this->flatState = $flatState;
         $this->_categoryInstance = $categoryFactory->create();
         parent::__construct($context, $data);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Returns: void

Definition at line 115 of file Navigation.php.

     {
         $this->addData(
             [
                 'cache_lifetime' => false,
                 'cache_tags' => [Category::CACHE_TAG, \Magento\Store\Model\Group::CACHE_TAG],
             ]
         );
     }

◆ getCacheKeyInfo()

getCacheKeyInfo ( )

Get Key pieces for caching block content

Returns: array

Definition at line 140 of file Navigation.php.

     {
         $shortCacheId = [
             'CATALOG_NAVIGATION',
             $this->_storeManager->getStore()->getId(),
             $this->_design->getDesignTheme()->getId(),
             $this->httpContext->getValue(Context::CONTEXT_GROUP),
             'template' => $this->getTemplate(),
             'name' => $this->getNameInLayout(),
             $this->getCurrentCategoryKey(),
         ];
         $cacheId = $shortCacheId;
 
         $shortCacheId = array_values($shortCacheId);
         $shortCacheId = implode('|', $shortCacheId);
         $shortCacheId = md5($shortCacheId);
 
         $cacheId['category_path'] = $this->getCurrentCategoryKey();
         $cacheId['short_cache_id'] = $shortCacheId;
 
         return $cacheId;
     }

◆ getCategory()

getCategory ( )

Get current category

Returns: Category

Definition at line 130 of file Navigation.php.

     {
         return $this->_registry->registry('current_category');
     }

◆ getCategoryUrl()

getCategoryUrl ( $category )

Get url for category data

Parameters

Category $category

Returns: string

Definition at line 217 of file Navigation.php.

     {
         if ($category instanceof Category) {
             $url = $category->getUrl();
         } else {
             $url = $this->_categoryInstance->setData($category->getData())->getUrl();
         }
 
         return $url;
     }

◆ getCurrentCategory()

getCurrentCategory ( )

Enter description here...

Returns: Category

Definition at line 233 of file Navigation.php.

     {
         return $this->_catalogLayer->getCurrentCategory();
     }

◆ getCurrentCategoryKey()

getCurrentCategoryKey ( )

Get current category key

Returns: string

Definition at line 168 of file Navigation.php.

     {
         if (!$this->_currentCategoryKey) {
             $category = $this->_registry->registry('current_category');
             if ($category) {
                 $this->_currentCategoryKey = $category->getPath();
             } else {
                 $this->_currentCategoryKey = $this->_storeManager->getStore()->getRootCategoryId();
             }
         }
 
         return $this->_currentCategoryKey;
     }

◆ getIdentities()

getIdentities ( )

Return identifiers for produced content

Returns: array

Implements IdentityInterface.

Definition at line 243 of file Navigation.php.

     {
         return [\Magento\Catalog\Model\Category::CACHE_TAG, \Magento\Store\Model\Group::CACHE_TAG];
     }

◆ isCategoryActive()

isCategoryActive ( $category )

Check activity of category

Parameters

\Magento\Framework\DataObject $category

Returns: bool

Definition at line 203 of file Navigation.php.

     {
         if ($this->getCurrentCategory()) {
             return in_array($category->getId(), $this->getCurrentCategory()->getPathIds());
         }
         return false;
     }

Field Documentation

◆ $_catalogCategory

$_catalogCategory

protected

Definition at line 47 of file Navigation.php.

◆ $_catalogLayer

$_catalogLayer

protected

Definition at line 66 of file Navigation.php.

◆ $_categoryInstance

$_categoryInstance

protected

Definition at line 26 of file Navigation.php.

◆ $_currentCategoryKey

$_currentCategoryKey

protected

Definition at line 33 of file Navigation.php.

◆ $_itemLevelPositions

$_itemLevelPositions = []

protected

Definition at line 40 of file Navigation.php.

◆ $_productCollectionFactory

$_productCollectionFactory

protected

Definition at line 73 of file Navigation.php.

◆ $_registry

$_registry

protected

Definition at line 52 of file Navigation.php.

◆ $flatState

$flatState

protected

Definition at line 78 of file Navigation.php.

◆ $httpContext

$httpContext

protected

Definition at line 59 of file Navigation.php.

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

vendor/magento/module-catalog/Block/Navigation.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ getCacheKeyInfo()

◆ getCategory()

◆ getCategoryUrl()

◆ getCurrentCategory()

◆ getCurrentCategoryKey()

◆ getIdentities()

◆ isCategoryActive()

Field Documentation

◆ $_catalogCategory

◆ $_catalogLayer

◆ $_categoryInstance

◆ $_currentCategoryKey

◆ $_itemLevelPositions

◆ $_productCollectionFactory

◆ $_registry

◆ $flatState

◆ $httpContext