Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JHtmlMenu

Fonctions membres publiques statiques

static menus ($clientId=0)
 
static menuItems ($config=array())
 
static menuItemList ($name, $selected=null, $attribs=null, $config=array())
 
static ordering (&$row, $id)
 
static linkOptions ($all=false, $unassigned=false, $clientId=0)
 
static treerecurse ($id, $indent, $list, &$children, $maxlevel=9999, $level=0, $type=1)
 

Attributs protégés statiques

static $menus = array()
 
static $items = array()
 

Description détaillée

Utility class working with menu select lists

Depuis
1.5

Documentation des fonctions membres

◆ linkOptions()

static linkOptions (   $all = false,
  $unassigned = false,
  $clientId = 0 
)
static

Build the multiple select list for Menu Links/Pages

Paramètres
boolean$allTrue if all can be selected
boolean$unassignedTrue if unassigned can be selected
int$clientIdThe client id
Renvoie
string
Depuis
1.5

Références $clientId, $db, $list, $query, et null.

◆ menuItemList()

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

Displays an HTML select list of menu items.

Paramètres
string$nameThe name of the control.
string$selectedThe value of the selected option.
string$attribsAttributes for the control.
array$configAn array of options for the control [id, published, checkacl, clientid].
Renvoie
string
Depuis
1.6

Références $attribs, $config, $count, $name, $options, $selected, et null.

◆ menuItems()

static menuItems (   $config = array())
static

Returns an array of menu items grouped by menu.

Paramètres
array$configAn array of configuration options [published, checkacl, clientid].
Renvoie
array
Depuis
1.6

Références $action, $clientId, $config, $db, $item, $items, $key, $menu, $query, $user, et elseif.

◆ menus()

static menus (   $clientId = 0)
static

Get a list of the available menus.

Paramètres
int$clientIdThe client id
Renvoie
array
Depuis
1.6

Références $clientId, $db, $key, et $query.

◆ ordering()

static ordering ( $row,
  $id 
)
static

Build the select list for Menu Ordering

Paramètres
object&$rowThe row object
integer$idThe id for the row. Must exist to enable menu ordering
Renvoie
string
Depuis
1.5

Références $db, $id, $ordering, $query, et $row.

◆ treerecurse()

static treerecurse (   $id,
  $indent,
  $list,
$children,
  $maxlevel = 9999,
  $level = 0,
  $type = 1 
)
static

Build the list representing the menu tree

Paramètres
integer$idId of the menu item
string$indentThe indentation string
array$listThe list to process
array&$childrenThe children of the current item
integer$maxlevelThe maximum number of levels in the tree
integer$levelThe starting level
int$typeSet the type of spacer to use. Use 1 for |_ or 0 for -
Renvoie
array
Depuis
1.5

Références $id, $list, et $type.

Documentation des champs

◆ $items

$items = array()
staticprotected

◆ $menus

$menus = array()
staticprotected

La documentation de cette classe a été générée à partir du fichier suivant :