Référence de la classe Menu

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	$all	True if all can be selected
boolean	$unassigned	True if unassigned can be selected
int	$clientId	The client id

Renvoie

string

Depuis

1.5

Références $clientId, $db, $list, $query, Text\_(), HTMLHelper\_(), Factory\getDbo(), ParameterType\INTEGER, et null.

menuItemList()

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

static

Displays an HTML select list of menu items.

Paramètres

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 [id, published, checkacl, clientid].

Renvoie

string

Depuis

1.6

Références $attribs, $config, $count, $name, $options, $selected, et HTMLHelper\_().

menuItems()

static menuItems (   $config = array() )

static

Returns an array of menu items grouped by menu.

Paramètres

array

$config

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

Renvoie

array

Depuis

1.6

Références $clientId, $config, $db, $item, $items, $key, $menu, $query, $user, Text\_(), HTMLHelper\_(), elseif, Factory\getDbo(), Factory\getUser(), et ParameterType\INTEGER.

menus()

static menus (   $clientId = 0 )

static

Get a list of the available menus.

Paramètres

int

$clientId

The client id

Renvoie

array

Depuis

1.6

Références $clientId, $db, $key, $query, Factory\getDbo(), et ParameterType\INTEGER.

ordering()

static ordering ( &  $row,   $id  )

static

Build the select list for Menu Ordering

Paramètres

object	$row	The row object
integer	$id	The id for the row. Must exist to enable menu ordering

Renvoie

string

Depuis

1.5

Références $db, $id, $ordering, $query, Text\_(), HTMLHelper\_(), Factory\getDbo(), et ParameterType\INTEGER.

treerecurse()

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

static

Build the list representing the menu tree

Paramètres

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
int	$type	Set 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 :

• libraries/src/HTML/Helpers/Menu.php