Class supporting creation of menus. More...

Inheritance diagram for Menu_Item:

Public Member Functions
	__construct ($id=false)
	count ()
	addSubmenu (Menu_ItemInterface $item, $pos=false, $insertAfter=false)
	Adds subitem.
	removeSubmenu ($itemOrPos)
	Removes submenu item.
	moveSubmenu ($itemOrPos, $pos=false, $insertAfter=false)
	Moves specified submenu to new position.
	mergeSubmenus ($menu)
	Merges two submenus together.
	mergeSubmenusLater ($merge)
	Works like mergeSubmenus(), but postpones merging, until mergePostponedSubmenus() is called.
	mergePostponedSubmenus ()
	sortSubmenus ($onField= 'title', $ascending=true)
	sortSubmenusCompare ($a, $b, $onField, $ascending)
	getMenuId ()
	getMenuOnClick ()
	Returns javascript for onClick.
	getMenuTitle ()
	getMenuIcon ()
	getMenuUrl ()
	Returns URL.
	setMenuId ($id)
	setMenuTitle ($title)
	setMenuIcon ($icon)
	setMenuUrl ($url)
	setMenuTarget ($target)
	setMenuOnClick ($onClick)
	getMenuInfo ()
	setMenuInfo ($info)
	getMenuOptions ()
	getMenuOption ($name, $default=null)
	setMenuOption ($name, $value)
	getSubmenus ()
	hasSubmenu ()
	getSubmenu ($id, $create=false)
	Returns submenu item with specified id.
	getMenuType ()
	isMenuVisible ()
	isMenuActive ()
	isMenuExpanded ()
	isMenuDisabled ()
	isMenuImportant ()
	setMenuVisible ($value)
	setMenuActive ($value)
	setMenuDisabled ($value)
	setMenuExpanded ($value)
	setMenuImportant ($value)
	setMenuType ($type)
	setInputType ($type, $name, $value)
	printMenu (Menu_PrinterInterface $printer, array $options=array())
	printMenuContent (Menu_PrinterInterface $printer, array $options=array())
	getCssClass ()
	setCssClass ($class)
	addCssClass ($class)
	getHtmlAttr ($name, $default=null)
	setHtmlAttr ($name, $value)
	getMenuTarget ()
Static Public Member Functions
static	create ($id=false, $title=null, $url=null, $icon=null, $onClick=null, array $options=array())
static	createMenu ($id=false, array $options=array())
static	instance ($id, $create=true)
	Returns registered menu, or creates it.
static	registerInstance (Menu_ItemInterface $menu)
	Registers menu as a named menu.
Data Fields
const	OPT_CSS_CLASS = 'cssClass'
const	OPT_HTML_ATTR = 'htmlAttr'
const	OPT_REL = 'rel'
const	OPT_VISIBLE = 'visible'
const	OPT_EXPANDED = 'expanded'
const	OPT_ACTIVE = 'active'
const	OPT_TARGET = 'target'
const	OPT_DISABLED = 'disabled'
const	OPT_IMPORTANT = 'important'
const	OPT_INFO = 'info'
const	OPT_TYPE = 'type'
const	OPT_INPUT_NAME = "inputName"
const	OPT_INPUT_VALUE = "inputValue"
const	OPT_PRINTER = "printer"
	Printer, which will print this item's contents (printMenuContent and printSubmenu.
const	OPT_PRINTER_OUTER = "printerOuter"
	Printer, which will print the whole item, including containing element, which normally should be printed by the parent item's printer.
const	OPT_HIDDEN_IF_EMPTY = "hiddenIfEmpty"
const	OPT_MERGE_LATER = "mergeLater"
const	TYPE_MENU = 'menu'
	Root menu - it doesn't have an item ot it's own.
const	TYPE_ACCORDION = 'accordion'
	Accordion type menu.
const	TYPE_OPTIONS = 'options'
	List of options type menu.
const	TYPE_ITEM = 'item'
	Standard menu item.
const	TYPE_CHECKBOX = 'checkbox'
const	TYPE_RADIO = 'radio'
const	TYPE_LIST = 'list'
	List of items type menu.
const	TYPE_TITLE = 'title'
const	TYPE_PANEL = 'panel'
const	TYPE_ICONS = 'icons'
	$title
	$icon
	$url
	$onClick
	$options = array()
Protected Attributes
	$id
	$items = array()
Static Protected Attributes
static	$instances

Detailed Description

Class supporting creation of menus.

Constructor & Destructor Documentation

Menu_Item::__construct ( $ id = false )

Reimplemented in KWebMenu_FormAction_Clipboard, and KWebMenu_FormAction.

Member Function Documentation

Menu_Item::addCssClass ( $ class )

Returns:: Menu_Item

Menu_Item::addSubmenu	(	Menu_ItemInterface $	item,
		$	pos = `false`,
		$	insertAfter = `false`
	)

Adds subitem.

Returns THIS item for fluent interface.

Returns:: Menu_Item

Menu_Item::count ( )

static Menu_Item::create	(	$	id = `false`,
		$	title = `null`,
		$	url = `null`,
		$	icon = `null`,
		$	onClick = `null`,
		array $	options = `array()`
	)		`[static]`

Returns:: Menu_Item

static Menu_Item::createMenu	(	$	id = `false`,
		array $	options = `array()`
	)		`[static]`

Returns:: Menu_Item

Menu_Item::getCssClass ( )

Menu_Item::getHtmlAttr	(	$	name,
		$	default = `null`
	)

Menu_Item::getMenuIcon ( )

Implements Menu_ItemInterface.

Reimplemented in KWebMenu_ObjectItem.

Menu_Item::getMenuId ( )

Implements Menu_ItemInterface.

Menu_Item::getMenuInfo ( )

Menu_Item::getMenuOnClick ( )

Returns javascript for onClick.

Implements Menu_ItemInterface.

Reimplemented in KWebMenu_FormAction_Clipboard, and KWebMenu_FormAction.

Menu_Item::getMenuOption	(	$	name,
		$	default = `null`
	)

Implements Menu_ItemInterface.

Reimplemented in KWebMenu_ObjectItem.

Menu_Item::getMenuOptions ( )

Menu_Item::getMenuTarget ( )

Implements Menu_ItemInterface.

Menu_Item::getMenuTitle ( )

Implements Menu_ItemInterface.

Reimplemented in KWebMenu_ObjectItem.

Menu_Item::getMenuType ( )

Implements Menu_ItemInterface.

Menu_Item::getMenuUrl ( )

Returns URL.

Implements Menu_ItemInterface.

Reimplemented in KWebMenu_ObjectItem.

Menu_Item::getSubmenu	(	$	id,
		$	create = `false`
	)

Returns submenu item with specified id.

Parameters:

$create - if TRUE, the submenu will be created

Returns:: Menu_Item

Menu_Item::getSubmenus ( )

Returns:: array

Implements Menu_ItemInterface.

Menu_Item::hasSubmenu ( )

Implements Menu_ItemInterface.

static Menu_Item::instance	(	$	id,
		$	create = `true`
	)		`[static]`

Returns registered menu, or creates it.

Returns:: Menu_Item

Menu_Item::isMenuActive ( )

Implements Menu_ItemInterface.

Menu_Item::isMenuDisabled ( )

Menu_Item::isMenuExpanded ( )

Implements Menu_ItemInterface.

Menu_Item::isMenuImportant ( )

Menu_Item::isMenuVisible ( )

Implements Menu_ItemInterface.

Menu_Item::mergePostponedSubmenus ( )

Returns:: Menu_Item

Menu_Item::mergeSubmenus ( $ menu )

Merges two submenus together.

Parameters:

$menu - Menu_Item object - all subitems will be added to this menu You can pass an array with $position => Menu_Item elements. If position is an integer, the item will be prepended, if it's a string, it will be passed as position to addSubmenu() if it's prepended with '+', the item will be inserted after specified position. If the item object equals null, the item at that position will be removed If the item is an array, mergeSubmenus will be called for that item (or an item created)

For example: array(0 => $item1, ' 1' => $item2, 'id' => $item3, '+id' => $item4, 'menu' => false); $item1 will be appended to the submenu $item2 will be inserted at position 1 $item3 will be inserted at position of item with id 'id' (or appended) $item4 will be inserted after position of item with id 'id' (or appended) 'menu' will be removed