Joomla! API

Download
Launch

JHtmlMenu

Utility class working with menu select lists

abstract
since

1.5
package

Joomla.Libraries

Methods

linkOptions

Build the multiple select list for Menu Links/Pages

linkOptions(boolean $all = false, boolean $unassigned = false, integer $clientId) : string
static
since

1.5

Arguments

$all

booleanTrue if all can be selected

$unassigned

booleanTrue if unassigned can be selected

$clientId

integerThe client id

Response

string

menuItemList

Displays an HTML select list of menu items.

menuItemList(string $name, string $selected = null, string $attribs = null, array $config = array()) : string
static
since

1.6

Arguments

$name

stringThe name of the control.

$selected

stringThe value of the selected option.

$attribs

stringAttributes for the control.

$config

arrayAn array of options for the control [id, published, checkacl, clientid].

Response

string

menuItems

Returns an array of menu items grouped by menu.

menuItems(array $config = array()) : array
static
since

1.6

Arguments

$config

arrayAn array of configuration options [published, checkacl, clientid].

Response

array

menus

Get a list of the available menus.

menus(integer $clientId) : array
static
since

1.6

Arguments

$clientId

integerThe client id

Response

array

ordering

Build the select list for Menu Ordering

ordering( &$row, integer $id) : string
static
since

1.5

Arguments

$row

$id

integerThe id for the row. Must exist to enable menu ordering

Response

string

treerecurse

Build the list representing the menu tree

treerecurse(integer $id, string $indent, array $list,  &$children, integer $maxlevel = 9999, integer $level, integer $type = 1) : array
static
since

1.5

Arguments

$id

integerId of the menu item

$indent

stringThe indentation string

$list

arrayThe list to process

$children

$maxlevel

integerThe maximum number of levels in the tree

$level

integerThe starting level

$type

integerSet the type of spacer to use. Use 1 for |_ or 0 for -

Response

array

Properties

menus

Cached array of the menus.

static
since

1.6

Type(s)

array

items

Cached array of the menus items.

static
since

1.6

Type(s)

array
  • \ \
  • \ JHtmlMenu