Inheritance diagram for Topmenu:

Public Member Functions
	__construct (Template\Context $context, NodeFactory $nodeFactory, TreeFactory $treeFactory, array $data=[])

	getHtml ($outermostClass='', $childrenWrapClass='', $limit=0)

	addIdentity ($identity)

	getIdentities ()

	getCacheKeyInfo ()

	getMenu ()

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

	_columnBrake ($items, $limit)

	_addSubMenu ($child, $childLevel, $childrenWrapClass, $limit)

	_getRenderedMenuItemAttributes (\Magento\Framework\Data\Tree\Node $item)

	_getMenuItemAttributes (\Magento\Framework\Data\Tree\Node $item)

	_getMenuItemClasses (\Magento\Framework\Data\Tree\Node $item)

	getCacheTags ()

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
	$identities = []

	$_menu

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

Html page top menu block

@api

Since: 100.0.2

Definition at line 20 of file Topmenu.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Template\Context	$context,
		NodeFactory	$nodeFactory,
		TreeFactory	$treeFactory,
		array	$data = `[]`
	)

Parameters

Template\Context	$context
NodeFactory	$nodeFactory
TreeFactory	$treeFactory
array	$data

Definition at line 52 of file Topmenu.php.

       {
         parent::__construct($context, $data);
         $this->nodeFactory = $nodeFactory;
         $this->treeFactory = $treeFactory;
     }

Member Function Documentation

◆ _addSubMenu()

_addSubMenu	(	$child,
		$childLevel,
		$childrenWrapClass,
		$limit
	)

protected

Add sub menu HTML code for current menu item

Parameters

\Magento\Framework\Data\Tree\Node	$child
string	$childLevel
string	$childrenWrapClass
int	$limit

Returns: string HTML code

Definition at line 173 of file Topmenu.php.

     {
         $html = '';
         if (!$child->hasChildren()) {
             return $html;
         }
 
         $colStops = [];
         if ($childLevel == 0 && $limit) {
             $colStops = $this->_columnBrake($child->getChildren(), $limit);
         }
 
         $html .= '<ul class="level' . $childLevel . ' ' . $childrenWrapClass . '">';
         $html .= $this->_getHtml($child, $childrenWrapClass, $limit, $colStops);
         $html .= '</ul>';
 
         return $html;
     }

◆ _columnBrake()

_columnBrake	(	$items,
		$limit
	)

protected

Building Array with Column Brake Stops

Parameters

\Magento\Backend\Model\Menu	$items
int	$limit

Returns: array|void

Todo:: : Add Depth Level limit, and better logic for columns

Definition at line 130 of file Topmenu.php.

     {
         $total = $this->_countItems($items);
         if ($total <= $limit) {
             return;
         }
 
         $result[] = ['total' => $total, 'max' => (int)ceil($total / ceil($total / $limit))];
 
         $count = 0;
         $firstCol = true;
 
         foreach ($items as $item) {
             $place = $this->_countItems($item->getChildren()) + 1;
             $count += $place;
 
             if ($place >= $limit) {
                 $colbrake = !$firstCol;
                 $count = 0;
             } elseif ($count >= $limit) {
                 $colbrake = !$firstCol;
                 $count = $place;
             } else {
                 $colbrake = false;
             }
 
             $result[] = ['place' => $place, 'colbrake' => $colbrake];
 
             $firstCol = false;
         }
 
         return $result;
     }

◆ _getMenuItemAttributes()

_getMenuItemAttributes ( \Magento\Framework\Data\Tree\Node $item )

protected

Returns array of menu item's attributes

Parameters

\Magento\Framework\Data\Tree\Node $item

Returns: array

Definition at line 293 of file Topmenu.php.

     {
         $menuItemClasses = $this->_getMenuItemClasses($item);
         return ['class' => implode(' ', $menuItemClasses)];
     }

◆ _getMenuItemClasses()

_getMenuItemClasses ( \Magento\Framework\Data\Tree\Node $item )

protected

Returns array of menu item's classes

Parameters

\Magento\Framework\Data\Tree\Node $item

Returns: array

Definition at line 305 of file Topmenu.php.

     {
         $classes = [];
 
         $classes[] = 'level' . $item->getLevel();
         $classes[] = $item->getPositionClass();
 
         if ($item->getIsCategory()) {
             $classes[] = 'category-item';
         }
 
         if ($item->getIsFirst()) {
             $classes[] = 'first';
         }
 
         if ($item->getIsActive()) {
             $classes[] = 'active';
         } elseif ($item->getHasActive()) {
             $classes[] = 'has-active';
         }
 
         if ($item->getIsLast()) {
             $classes[] = 'last';
         }
 
         if ($item->getClass()) {
             $classes[] = $item->getClass();
         }
 
         if ($item->hasChildren()) {
             $classes[] = 'parent';
         }
 
         return $classes;
     }

◆ _getRenderedMenuItemAttributes()

_getRenderedMenuItemAttributes ( \Magento\Framework\Data\Tree\Node $item )

protected

Generates string with all attributes that should be present in menu item element

Parameters

\Magento\Framework\Data\Tree\Node $item

Returns: string

Definition at line 277 of file Topmenu.php.

     {
         $html = '';
         $attributes = $this->_getMenuItemAttributes($item);
         foreach ($attributes as $attributeName => $attributeValue) {
             $html .= ' ' . $attributeName . '="' . str_replace('"', '\"', $attributeValue) . '"';
         }
         return $html;
     }

◆ addIdentity()

addIdentity ( $identity )

Add identity

Parameters

string | array $identity

Returns: void

Definition at line 347 of file Topmenu.php.

     {
         if (!in_array($identity, $this->identities)) {
             $this->identities[] = $identity;
         }
     }

◆ getCacheKeyInfo()

getCacheKeyInfo ( )

Get cache key informative items

Returns: array

Since: 100.1.0

Definition at line 370 of file Topmenu.php.

     {
         $keyInfo = parent::getCacheKeyInfo();
         $keyInfo[] = $this->getUrl('*/*/*', ['_current' => true, '_query' => '']);
         return $keyInfo;
     }

◆ getCacheLifetime()

getCacheLifetime ( )

protected

Get block cache life time

Returns: int

Since: 100.1.0

Definition at line 69 of file Topmenu.php.

     {
         return parent::getCacheLifetime() ?: 3600;
     }

◆ getCacheTags()

getCacheTags ( )

protected

Get tags array for saving cache

Returns: array

Since: 100.1.0

Definition at line 383 of file Topmenu.php.

     {
         return array_merge(parent::getCacheTags(), $this->getIdentities());
     }

◆ getHtml()

getHtml	(	$outermostClass = `''`,
		$childrenWrapClass = `''`,
		$limit = `0`
	)

Get top menu html

Parameters

string	$outermostClass
string	$childrenWrapClass
int	$limit

Returns: string

Definition at line 82 of file Topmenu.php.

     {
         $this->_eventManager->dispatch(
             'page_block_html_topmenu_gethtml_before',
             ['menu' => $this->getMenu(), 'block' => $this, 'request' => $this->getRequest()]
         );
 
         $this->getMenu()->setOutermostClass($outermostClass);
         $this->getMenu()->setChildrenWrapClass($childrenWrapClass);
 
         $html = $this->_getHtml($this->getMenu(), $childrenWrapClass, $limit);
 
         $transportObject = new \Magento\Framework\DataObject(['html' => $html]);
         $this->_eventManager->dispatch(
             'page_block_html_topmenu_gethtml_after',
             ['menu' => $this->getMenu(), 'transportObject' => $transportObject]
         );
         $html = $transportObject->getHtml();
         return $html;
     }

◆ getIdentities()

getIdentities ( )

Get identities

Returns: array

Implements IdentityInterface.

Definition at line 359 of file Topmenu.php.

     {
         return $this->identities;
     }

◆ getMenu()

getMenu ( )

Get menu object.

Creates \Magento\Framework\Data\Tree\Node root node object. The creation logic was moved from class constructor into separate method.

Returns: Node

Since: 100.1.0

Definition at line 397 of file Topmenu.php.

     {
         if (!$this->_menu) {
             $this->_menu = $this->nodeFactory->create(
                 [
                     'data' => [],
                     'idField' => 'root',
                     'tree' => $this->treeFactory->create()
                 ]
             );
         }
         return $this->_menu;
     }

Field Documentation

◆ $_menu

$_menu

protected

Definition at line 34 of file Topmenu.php.

◆ $identities

$identities = []

protected

Definition at line 27 of file Topmenu.php.

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

vendor/magento/module-theme/Block/Html/Topmenu.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addSubMenu()

◆ _columnBrake()

◆ _getMenuItemAttributes()

◆ _getMenuItemClasses()

◆ _getRenderedMenuItemAttributes()

◆ addIdentity()

◆ getCacheKeyInfo()

◆ getCacheLifetime()

◆ getCacheTags()

◆ getHtml()

◆ getIdentities()

◆ getMenu()

Field Documentation

◆ $_menu

◆ $identities