QuickMenu Class Reference
[QuickMenu]

Server part of QuickMenu component. More...

List of all members.

Public Member Functions
	activeItemHREF ()
	Active menu item HREF attribute.
	addItem ($szText, $szHREF, $idParent=0)
	Add menu item somewhere to menu.
	genHead ()
	Generate head section of component and send direct to output.
	genMenu ()
	Generate body section of component and send direct to output.
	loadXmlTemplate ($qmTemplate, $idParent=0)
	Add menu items from XML template.
	minimalInputLength ()
	Minimal length of input to invoke search action.
	setActiveItemHREF ($activeItemHREF)
	Set active menu item using HREF attribute.
	setMinimalInputLength ($minimalInputLength)
	Minimal length of input to invoke search action.
	setVisibleDepth ($visibleDepth)
	Set menu tree visible depth.
	visibleDepth ()
	Menu tree visible depth.

---

Detailed Description

Server part of QuickMenu component.

Definition at line 21 of file QuickMenu.class.php.

---

Member Function Documentation

QuickMenu::activeItemHREF

(

)

Active menu item HREF attribute.

Returns:

HREF of active menu item.

Definition at line 74 of file QuickMenu.class.php.

QuickMenu::addItem	(	$	szText,
		$	szHREF,
		$	idParent = 0
	)

Add menu item somewhere to menu.

Parameters:

	szText	Menu item text.
	szHREF	Menu item HREF. Item HREF is relative to webRoot!!!
	idParent	Parent menu item ID. ID must be an number previously returned by addItem() method or zero for base level menu item.

Returns:

Return ID of just added menu item.

Definition at line 170 of file QuickMenu.class.php.

QuickMenu::genHead

(

)

Generate head section of component and send direct to output.

Remarks:

• Generate link to QuickMenu.class.js
• Generate initialization inline script
• Use JSOnloadList singleton to run scripts on page load (at client's side).

Definition at line 92 of file QuickMenu.class.php.

References JSOnloadList::instance(), Config::instance(), minimalInputLength(), and visibleDepth().

Here is the call graph for this function:

QuickMenu::genMenu

(

)

Generate body section of component and send direct to output.

Remarks:

• DIV #qmWrapper
  • DIV #qmInputBox
    • INPUT #qmInput
    • INPUT #qmFacade
    • IMG #qmClearSearch
    • IMG #qmExpandAll
  • UL #QuickMenu (with dynamic content inside)
    • LI (optional item)
      • IMG
      • A
      • UL (optional subitem list)
        • LI ...
    • ...

Definition at line 266 of file QuickMenu.class.php.

References Indentor::singleton().

Here is the call graph for this function:

QuickMenu::loadXmlTemplate	(	$	qmTemplate,
		$	idParent = 0
	)

Add menu items from XML template.

DTD available at http://dudka.cz/dtd/QuickMenu.dtd

Parameters:

	qmTemplate	Path to XML document containing menu template.
	idParent	Parent item ID or zero for base level item.

Definition at line 316 of file QuickMenu.class.php.

QuickMenu::minimalInputLength

(

)

Minimal length of input to invoke search action.

Default is 1.

Returns:

Minimal length of input to invoke search action.

Definition at line 58 of file QuickMenu.class.php.

Referenced by genHead().

QuickMenu::setActiveItemHREF

(

$

activeItemHREF

)

Set active menu item using HREF attribute.

This attribute should be equally to HREF given by addItem() method.

Parameters:

activeItemHREF

HREF of menu item to active.

Definition at line 81 of file QuickMenu.class.php.

QuickMenu::setMinimalInputLength

(

$

minimalInputLength

)

Minimal length of input to invoke search action.

Default is 1.

Parameters:

minimalInputLength

Minimal length of input to invoke search action.

Definition at line 65 of file QuickMenu.class.php.

QuickMenu::setVisibleDepth

(

$

visibleDepth

)

Set menu tree visible depth.

Experimental!
Default is 1.

Parameters:

visibleDepth

Menu tree visible depth.

Definition at line 49 of file QuickMenu.class.php.

QuickMenu::visibleDepth

(

)

Menu tree visible depth.

Default is 1.

Returns:

Menu tree visible depth.

Definition at line 42 of file QuickMenu.class.php.

Referenced by genHead().

---

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

• lib/QuickMenu.class.php

---