Inheritance diagram for Freshy2Menu:

Public Member Functions
	init ()

	run ()

	init ()

	run ()

Data Fields
	$items =array()

	$itemTemplate

	$encodeLabel =true

	$activeCssClass ='active'

	$activateItems =true

	$activateParents =false

	$hideEmptyItems =true

	$htmlOptions =array()

	$submenuHtmlOptions =array()

	$linkLabelWrapper

	$firstItemCssClass

	$lastItemCssClass

Protected Member Functions
	renderMenu ($items)

	renderMenuRecursive ($items)

	normalizeItems ($items, $route, &$active)

	isItemActive ($item, $route)

	renderMenu ($items)

	renderMenuRecursive ($items)

	normalizeItems ($items, $route, &$active)

	isItemActive ($item, $route)

Detailed Description

Definition at line 59 of file Freshy2Menu.php.

Member Function Documentation

init ( )

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

Definition at line 153 of file Freshy2Menu.php.

init ( )

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

Definition at line 153 of file Freshy2Menu.php.

isItemActive	(	$item,
		$route
	)

protected

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.

Parameters

array	the menu item to be checked
string	the route of the current request

Returns: boolean whether the menu item is active

Definition at line 284 of file Freshy2Menu.php.

isItemActive	(	$item,
		$route
	)

protected

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.

Parameters

array	the menu item to be checked
string	the route of the current request

Returns: boolean whether the menu item is active

Definition at line 284 of file Freshy2Menu.php.

normalizeItems	(		$items,
			$route,
		&	$active
	)

protected

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

Parameters

array	the items to be normalized.
string	the route of the current request.
boolean	whether there is an active child menu item.

Returns: array the normalized menu items

Definition at line 245 of file Freshy2Menu.php.

normalizeItems	(		$items,
			$route,
		&	$active
	)

protected

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

Parameters

array	the items to be normalized.
string	the route of the current request.
boolean	whether there is an active child menu item.

Returns: array the normalized menu items

Definition at line 245 of file Freshy2Menu.php.

renderMenu ( $items)

protected

Renders the menu items.

Parameters

array menu items. Each menu item will be an array with at least two elements: 'label' and 'active'. It may have three other optional elements: 'items', 'linkOptions' and 'itemOptions'.

Definition at line 173 of file Freshy2Menu.php.

renderMenu ( $items)

protected

Renders the menu items.

Parameters

array menu items. Each menu item will be an array with at least two elements: 'label' and 'active'. It may have three other optional elements: 'items', 'linkOptions' and 'itemOptions'.

Definition at line 173 of file Freshy2Menu.php.

renderMenuRecursive ( $items)

protected

Recursively renders the menu items.

Parameters

array the menu items to be rendered recursively

Definition at line 187 of file Freshy2Menu.php.

renderMenuRecursive ( $items)

protected

Recursively renders the menu items.

Parameters

array the menu items to be rendered recursively

Definition at line 187 of file Freshy2Menu.php.

run ( )

Calls renderMenu to render the menu.

Definition at line 163 of file Freshy2Menu.php.

run ( )

Calls renderMenu to render the menu.

Definition at line 163 of file Freshy2Menu.php.

Field Documentation

$activateItems =true

Definition at line 106 of file Freshy2Menu.php.

$activateParents =false

Definition at line 112 of file Freshy2Menu.php.

$activeCssClass ='active'

Definition at line 100 of file Freshy2Menu.php.

$encodeLabel =true

Definition at line 95 of file Freshy2Menu.php.

$firstItemCssClass

Definition at line 140 of file Freshy2Menu.php.

$hideEmptyItems =true

Definition at line 117 of file Freshy2Menu.php.

$htmlOptions =array()

Definition at line 121 of file Freshy2Menu.php.

$items =array()

Definition at line 83 of file Freshy2Menu.php.

$itemTemplate

Definition at line 91 of file Freshy2Menu.php.

$lastItemCssClass

Definition at line 146 of file Freshy2Menu.php.

$linkLabelWrapper

Definition at line 134 of file Freshy2Menu.php.

$submenuHtmlOptions =array()

Definition at line 125 of file Freshy2Menu.php.

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

test/protected/components/Freshy2Menu.php
test/themes/freshy2/Freshy2Menu.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Member Function Documentation

Field Documentation