Mage_Adminhtml_Block_Page_Menu Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Page_Menu:

List of all members.

Public Member Functions
	getCacheLifetime ()
	getCacheKey ()
	getMenuArray ()
Public Attributes
const	CACHE_TAGS = 'BACKEND_MAINMENU'
Protected Member Functions
	_construct ()
	_getHelperValue (Varien_Simplexml_Element $child)
	_buildMenuArray (Varien_Simplexml_Element $parent=null, $path='', $level=0)
	_sortMenu ($a, $b)
	_checkDepends (Varien_Simplexml_Element $depends)
	_checkAcl ($resource)
Protected Attributes
	$_url

---

Detailed Description

Definition at line 34 of file Menu.php.

---

Member Function Documentation

_buildMenuArray	(	Varien_Simplexml_Element $	parent = null,
		$	path = '',
		$	level = 0
	)			[protected]

Definition at line 79 of file Menu.php.

    {
        if (is_null($parent)) {
            $parent = Mage::getConfig()->getNode('adminhtml/menu');
//        $parent = Mage::getSingleton('adminhtml/config')->getNode('admin/menu');

        }
        $parentArr = array();
        $sortOrder = 0;
        foreach ($parent->children() as $childName=>$child) {

            $aclResource = 'admin/'.$path.$childName;
            if (!$this->_checkAcl($aclResource)) {
                continue;
            }

            if ($child->depends && !$this->_checkDepends($child->depends)) {
                continue;
            }

            $menuArr = array();

            $menuArr['label'] = $this->_getHelperValue($child);

            $menuArr['sort_order'] = $child->sort_order ? (int)$child->sort_order : $sortOrder;

            if ($child->action) {
                $menuArr['url'] = $this->_url->getUrl((string)$child->action);
            } else {
                $menuArr['url'] = '#';
                $menuArr['click'] = 'return false';
            }
            #print_r($this->getActive().','.$path.$childName."<hr>");
            $menuArr['active'] = ($this->getActive()==$path.$childName)
                || (strpos($this->getActive(), $path.$childName.'/')===0);

            $menuArr['level'] = $level;

            if ($child->children) {
                $menuArr['children'] = $this->_buildMenuArray($child->children, $path.$childName.'/', $level+1);
            }
            $parentArr[$childName] = $menuArr;

            $sortOrder++;
        }

        uasort($parentArr, array($this, '_sortMenu'));

        while (list($key, $value) = each($parentArr)) {
            $last = $key;
        }
        if (isset($last)) {
            $parentArr[$last]['last'] = true;
        }

        return $parentArr;
    }

_checkAcl

(

$

resource

)

[protected]

Definition at line 172 of file Menu.php.

    {
        try {
            $res =  Mage::getSingleton('admin/session')->isAllowed($resource);
        } catch (Exception $e) {
            return false;
        }
        return $res;
    }

_checkDepends

(

Varien_Simplexml_Element $

depends

)

[protected]

Definition at line 142 of file Menu.php.

    {
        if ($depends->module) {
            $modulesConfig = Mage::getConfig()->getNode('modules');
            foreach ($depends->module as $module) {
                if (!$modulesConfig->$module || !$modulesConfig->$module->is('active')) {
                    return false;
                }
            }
        }

        if ($depends->config) {
            foreach ($depends->config as $path) {
                if (!Mage::getStoreConfigFlag((string)$path)) {
                    return false;
                }
            }
        }

        return true;
    }

_construct

(

)

[protected]

Internal constructor, that is called from real constructor

Please override this one instead of overriding real __construct constructor

Please override this one instead of overriding real __construct constructor

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 39 of file Menu.php.

    {
        parent::_construct();
        $this->setTemplate('page/menu.phtml');
        $this->_url = Mage::getModel('adminhtml/url');
        $this->setCacheTags(array(self::CACHE_TAGS));
    }

_getHelperValue

(

Varien_Simplexml_Element $

child

)

[protected]

Definition at line 64 of file Menu.php.

    {
        $helperName         = 'adminhtml';
        $titleNodeName      = 'title';
        $childAttributes    = $child->attributes();
        if (isset($childAttributes['module'])) {
            $helperName     = (string)$childAttributes['module'];
        }
//        if (isset($childAttributes['translate'])) {
//            $titleNodeName  = (string)$childAttributes['translate'];
//        }

        return Mage::helper($helperName)->__((string)$child->$titleNodeName);
    }

_sortMenu	(	$	a,
		$	b
	)			[protected]

Definition at line 137 of file Menu.php.

    {
        return $a['sort_order']<$b['sort_order'] ? -1 : ($a['sort_order']>$b['sort_order'] ? 1 : 0);
    }

getCacheKey

(

)

Get Key for caching block content

Returns:

string

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 52 of file Menu.php.

    {
        // getting roles for current user, for now one role per user
        $id = Mage::getSingleton('admin/session')->getUser()->getId();
        return 'admin_top_nav_'.$this->getActive().'_'.$id.'_'.Mage::app()->getLocale()->getLocaleCode();
    }

getCacheLifetime

(

)

Get block cache life time

Returns:

int

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 47 of file Menu.php.

    {
        return 86400;
    }

getMenuArray

(

)

Definition at line 59 of file Menu.php.

    {
        return $this->_buildMenuArray();
    }

---

Member Data Documentation

$_url [protected]

Definition at line 36 of file Menu.php.

const CACHE_TAGS = 'BACKEND_MAINMENU'

Definition at line 37 of file Menu.php.

---

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

• app/code/core/Mage/Adminhtml/Block/Page/Menu.php