Class JHtmlMenu

Utility class working with menu select lists

Abstract
Package: Joomla\Libraries\HTML
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.5
Located at cms/html/menu.php

Methods summary

`public static array`	# `menus( integer $clientId = 0 )` Get a list of the available menus. Get a list of the available menus. Parameters `$clientId` `integer` - $clientId The client id Returns `array` Since 1.6
`public static array`	# `menuItems( array $config = array() )` Returns an array of menu items grouped by menu. Returns an array of menu items grouped by menu. Parameters `$config` `array` - $config An array of configuration options [published, checkacl, clientid]. Returns `array` Since 1.6
`public static string`	# `menuItemList( string $name, string $selected = null, string $attribs = null, array $config = array() )` Displays an HTML select list of menu items. Displays an HTML select list of menu items. Parameters `$name` `string` - $name The name of the control. `$selected` `string` - $selected The value of the selected option. `$attribs` `string` - $attribs Attributes for the control. `$config` `array` - $config An array of options for the control [id, published, checkacl, clientid]. Returns `string` Since 1.6
`public static string`	# `ordering( object & $row, integer $id )` Build the select list for Menu Ordering Build the select list for Menu Ordering Parameters `$row` `object` - &$row The row object `$id` `integer` - $id The id for the row. Must exist to enable menu ordering Returns `string` Since 1.5
`public static string`	# `linkOptions( boolean $all = false, boolean $unassigned = false, integer $clientId = 0 )` Build the multiple select list for Menu Links/Pages Build the multiple select list for Menu Links/Pages Parameters `$all` `boolean` - $all True if all can be selected `$unassigned` `boolean` - $unassigned True if unassigned can be selected `$clientId` `integer` - $clientId The client id Returns `string` Since 1.5
`public static array`	# `treerecurse( integer $id, string $indent, array $list, array & $children, integer $maxlevel = 9999, integer $level = 0, integer $type = 1 )` Build the list representing the menu tree Build the list representing the menu tree Parameters `$id` `integer` - $id Id of the menu item `$indent` `string` - $indent The indentation string `$list` `array` - $list The list to process `$children` `array` - &$children The children of the current item `$maxlevel` `integer` - $maxlevel The maximum number of levels in the tree `$level` `integer` - $level The starting level `$type` `integer` - $type Set the type of spacer to use. Use 1 for \|_ or 0 for - Returns `array` Since 1.5

Magic methods summary

Properties summary

`protected static array`	`$menus`	# Cached array of the menus. Cached array of the menus. Since 1.6
`protected static array`	`$items`	# Cached array of the menus items. Cached array of the menus items. Since 1.6

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JHtmlMenu

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since