CMenu

$this->widget('zii.widgets.CMenu', array(
    'items'=>array(
        array('label'=>'Home', 'url'=>array('site/index')),
        array('label'=>'Products', 'url'=>array('product/index'), 'items'=>array(
            array('label'=>'New Arrivals', 'url'=>array('product/new', 'tag'=>'new')),
            array('label'=>'Most Popular', 'url'=>array('product/index', 'tag'=>'popular')),
        )),
        array('label'=>'Login', 'url'=>array('site/login'), 'visible'=>Yii::app()->user->isGuest),
    ),
));

Property Details

whether to automatically activate items according to whether their route setting matches the currently requested route. Defaults to true.

whether to activate parent menu items when one of the corresponding child menu items is active. The activated parent menu items will also have its CSS classes appended with activeCssClass. Defaults to false.

the CSS class to be appended to the active menu item. Defaults to 'active'. If empty, the CSS class of menu items will not be changed.

whether the labels for menu items should be HTML-encoded. Defaults to true.

whether to hide empty menu items. An empty menu item is one whose 'url' option is not set and which doesn't contain visible child menu items. Defaults to true.

HTML attributes for the menu's root container tag

the template used to render an individual menu item. In this template, the token "{menu}" will be replaced with the corresponding menu link or text. If this property is not set, each menu will be rendered without any decoration. This property will be overridden by the 'template' option set in individual menu items via {@items}.

list of menu items. Each menu item is specified as an array of name-value pairs. Possible option names include the following:

• label: string, required, specifies the menu item label. When encodeLabel is true, the label will be HTML-encoded.
• url: string or array, optional, specifies the URL of the menu item. It is passed to CHtml::normalizeUrl to generate a valid URL. If this is not set, the menu item will be rendered as a span text.
• visible: boolean, optional, whether this menu item is visible. Defaults to true. This can be used to control the visibility of menu items based on user permissions.
• items: array, optional, specifies the sub-menu items. Its format is the same as the parent items.
• active: boolean, optional, whether this menu item is in active state (currently selected). If a menu item is active and activeClass is not empty, its CSS class will be appended with activeClass. If this option is not set, the menu item will be set active automatically when the current request is triggered by url. Note that the GET parameters not specified in the 'url' option will be ignored.
• template: string, optional, the template used to render this menu item. In this template, the token "{menu}" will be replaced with the corresponding menu link or text. Please see itemTemplate for more details. This option has been available since version 1.1.1.
• linkOptions: array, optional, additional HTML attributes to be rendered for the link or span tag of the menu item.
• itemOptions: array, optional, additional HTML attributes to be rendered for the container tag of the menu item.

HTML attributes for the submenu's container tag.

Method Details

Initializes the menu widget. This method mainly normalizes the items property. If this method is overridden, make sure the parent implementation is invoked.

Checks whether a menu item is active. This is done by checking if the currently requested URL is generated by the 'url' option of the menu item. Note that the GET parameters not specified in the 'url' option will be ignored.

Normalizes the items property so that the 'active' state is properly identified for every menu item.

Renders the menu items.

Recursively renders the menu items.

Calls renderMenu to render the menu.