Class JHtmlMenu

Description

Utility class working with menu select lists

  • abstract:
  • since: 11.1

Located in /libraries/joomla/html/html/menu.php (line 19)


	
			
Variable Summary
static array $items
static array $menus
Method Summary
static string linkoptions ([boolean $all = false], [boolean $unassigned = false])
static string menuitemlist (string $name, [string $selected = null], [string $attribs = null], [array $config = array()])
static array menuitems ([array $config = array()])
static string menus ()
static string ordering (object &$row, integer $id)
static array treerecurse (integer $id, string $indent, array $list, array &$children, [integer $maxlevel = 9999], [integer $level = 0], [string $type = 1])
Variables
static array $items = null (line 35)

Cached array of the menus items.

  • since: 11.1
  • access: protected
static array $menus = null (line 27)

Cached array of the menus.

  • since: 11.1
  • access: protected
Methods
static method linkoptions (line 217)

Build the multiple select list for Menu Links/Pages

  • since: 11.1
  • access: public
static string linkoptions ([boolean $all = false], [boolean $unassigned = false])
  • boolean $all: True if all can be selected
  • boolean $unassigned: True if unassigned can be selected
static method menuitemlist (line 153)

Displays an HTML select list of menu items.

  • access: public
static string menuitemlist (string $name, [string $selected = null], [string $attribs = null], [array $config = array()])
  • string $name: The name of the control.
  • string $selected: The value of the selected option.
  • string $attribs: Attributes for the control.
  • array $config: An array of options for the control.
static method menuitems (line 67)

Returns an array of menu items grouped by menu.

  • access: public
static array menuitems ([array $config = array()])
  • array $config: An array of configuration options.
static method menus (line 44)

Get a list of the available menus.

  • since: 11.1
  • access: public
static string menus ()
static method ordering (line 180)

Build the select list for Menu Ordering

  • since: 11.1
  • access: public
static string ordering (object &$row, integer $id)
  • object &$row: The row object
  • integer $id: The id for the row. Must exist to enable menu ordering
static method treerecurse (line 316)

Build the list representing the menu tree

  • since: 11.1
  • access: public
static array treerecurse (integer $id, string $indent, array $list, array &$children, [integer $maxlevel = 9999], [integer $level = 0], [string $type = 1])
  • integer $id: Id of the menu item
  • string $indent: The indentation string
  • array $list: The list to process
  • array &$children: The children of the current item
  • integer $maxlevel: The maximum number of levels in the tree
  • integer $level: The starting level
  • string $type: Type of link: component, URL, alias, separator

Documentation generated on Mon, 25 Jun 2012 13:57:01 -0500 by phpDocumentor 1.4.4