*/
class Mage_Page_Block_Html_Topmenu extends Mage_Core_Block_Template
{
/**
* Top menu data tree
*
* @var Varien_Data_Tree_Node
*/
protected $_menu;
/**
* Current entity key
*
* @var string|int
*/
protected $_currentEntityKey;
/**
* Init top menu tree structure
*/
public function _construct()
{
$this->_menu = new Varien_Data_Tree_Node(array(), 'root', new Varien_Data_Tree());
$this->addData(array(
'cache_lifetime' => false,
));
}
/**
* Get top menu html
*
* @param string $outermostClass
* @param string $childrenWrapClass
* @return string
*/
public function getHtml($outermostClass = '', $childrenWrapClass = '')
{
Mage::dispatchEvent('page_block_html_topmenu_gethtml_before', array(
'menu' => $this->_menu,
'block' => $this
));
$this->_menu->setOutermostClass($outermostClass);
$this->_menu->setChildrenWrapClass($childrenWrapClass);
$html = $this->_getHtml($this->_menu, $childrenWrapClass);
Mage::dispatchEvent('page_block_html_topmenu_gethtml_after', array(
'menu' => $this->_menu,
'html' => $html
));
return $html;
}
/**
* Recursively generates top menu html from data that is specified in $menuTree
*
* @param Varien_Data_Tree_Node $menuTree
* @param string $childrenWrapClass
* @return string
*/
protected function _getHtml(Varien_Data_Tree_Node $menuTree, $childrenWrapClass)
{
$html = '';
$children = $menuTree->getChildren();
$parentLevel = $menuTree->getLevel();
$childLevel = is_null($parentLevel) ? 0 : $parentLevel + 1;
$counter = 1;
$childrenCount = $children->count();
$parentPositionClass = $menuTree->getPositionClass();
$itemPositionClassPrefix = $parentPositionClass ? $parentPositionClass . '-' : 'nav-';
foreach ($children as $child) {
$child->setLevel($childLevel);
$child->setIsFirst($counter == 1);
$child->setIsLast($counter == $childrenCount);
$child->setPositionClass($itemPositionClassPrefix . $counter);
$outermostClassCode = '';
$outermostClass = $menuTree->getOutermostClass();
if ($childLevel == 0 && $outermostClass) {
$outermostClassCode = ' class="' . $outermostClass . '" ';
$child->setClass($outermostClass);
}
$html .= '
_getRenderedMenuItemAttributes($child) . '>';
$html .= ''
. $this->escapeHtml($child->getName()) . '';
if ($child->hasChildren()) {
if (!empty($childrenWrapClass)) {
$html .= '';
}
$html .= '
';
$html .= $this->_getHtml($child, $childrenWrapClass);
$html .= '
';
if (!empty($childrenWrapClass)) {
$html .= '
';
}
}
$html .= '';
$counter++;
}
return $html;
}
/**
* Generates string with all attributes that should be present in menu item element
*
* @param Varien_Data_Tree_Node $item
* @return string
*/
protected function _getRenderedMenuItemAttributes(Varien_Data_Tree_Node $item)
{
$html = '';
$attributes = $this->_getMenuItemAttributes($item);
foreach ($attributes as $attributeName => $attributeValue) {
$html .= ' ' . $attributeName . '="' . str_replace('"', '\"', $attributeValue) . '"';
}
return $html;
}
/**
* Returns array of menu item's attributes
*
* @param Varien_Data_Tree_Node $item
* @return array
*/
protected function _getMenuItemAttributes(Varien_Data_Tree_Node $item)
{
$menuItemClasses = $this->_getMenuItemClasses($item);
$attributes = array(
'class' => implode(' ', $menuItemClasses)
);
return $attributes;
}
/**
* Returns array of menu item's classes
*
* @param Varien_Data_Tree_Node $item
* @return array
*/
protected function _getMenuItemClasses(Varien_Data_Tree_Node $item)
{
$classes = array();
$classes[] = 'level' . $item->getLevel();
$classes[] = $item->getPositionClass();
if ($item->getIsFirst()) {
$classes[] = 'first';
}
if ($item->getIsActive()) {
$classes[] = 'active';
}
if ($item->getIsLast()) {
$classes[] = 'last';
}
if ($item->getClass()) {
$classes[] = $item->getClass();
}
if ($item->hasChildren()) {
$classes[] = 'parent';
}
return $classes;
}
/**
* Retrieve cache key data
*
* @return array
*/
public function getCacheKeyInfo()
{
$shortCacheId = array(
'TOPMENU',
Mage::app()->getStore()->getId(),
Mage::getDesign()->getPackageName(),
Mage::getDesign()->getTheme('template'),
Mage::getSingleton('customer/session')->getCustomerGroupId(),
'template' => $this->getTemplate(),
'name' => $this->getNameInLayout(),
$this->getCurrentEntityKey()
);
$cacheId = $shortCacheId;
$shortCacheId = array_values($shortCacheId);
$shortCacheId = implode('|', $shortCacheId);
$shortCacheId = md5($shortCacheId);
$cacheId['entity_key'] = $this->getCurrentEntityKey();
$cacheId['short_cache_id'] = $shortCacheId;
return $cacheId;
}
/**
* Retrieve current entity key
*
* @return int|string
*/
public function getCurrentEntityKey()
{
if (null === $this->_currentEntityKey) {
$this->_currentEntityKey = Mage::registry('current_entity_key')
? Mage::registry('current_entity_key') : Mage::app()->getStore()->getRootCategoryId();
}
return $this->_currentEntityKey;
}
}