Référence de la classe JMenu

Graphe d'héritage de JMenu:

Graphe de collaboration de JMenu:

Liste de tous les membres

Fonctions membres publiques

• __construct ($options=array())
• & getInstance ($client, $options=array())
• & getItem ($id)
• setDefault ($id)
• & getDefault ()
• & setActive ($id)
• & getActive ()
• getItems ($attribute, $value, $firstonly=false)
• & getParams ($id)
• getMenu ()
• authorize ($id, $accessid=0)
• load ()

Attributs publics

• $_items = array ()
• $_default = 0
• $_active = 0

---

Documentation des constructeurs et destructeur

JMenu::__construct

(

$

options = array()

)

Class constructor

public

Renvoie:

boolean True on success

Références $item, et $k.

---

Documentation des fonctions membres

JMenu::authorize	(	$	id,
		$	accessid = 0
	)

Method to check JMenu object authorization against an access control object and optionally an access extension object

public

Paramètres:

integer	$id	The menu id
integer	$accessid	The users access identifier

Renvoie:

boolean True if authorized

Références $id, et $menu.

& JMenu::getActive

(

)

Get menu item by id

public

Renvoie:

object The item object

Références $item.

& JMenu::getDefault

(

)

Get menu item by id

public

Renvoie:

object The item object

Références $item.

& JMenu::getInstance	(	$	client,
		$	options = array()
	)

Returns a reference to a JMenu object

This method must be invoked as:

  $menu = &JSite::getMenu();

public

Paramètres:

string	$client	The name of the client
array	$options	An associative array of options

Renvoie:

JMenu A menu object.

Depuis:

1.5

Références $classname, $client, $error, $path, et JApplicationHelper::getClientInfo().

Référencé par JApplication::getMenu().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

& JMenu::getItem

(

$

id

)

Get menu item by id

public

Paramètres:

int	The item id

Renvoie:

mixed The item object, or null if not found

Références $id.

JMenu::getItems	(	$	attribute,
		$	value,
		$	firstonly = false
	)

Gets menu items by attribute

public

Paramètres:

string	The field name
string	The value of the field
boolean	If true, only returns the first item found

Renvoie:

array

Références $item, et $items.

JMenu::getMenu

(

)

Getter for the menu array

public

Renvoie:

array

& JMenu::getParams

(

$

id

)

Gets the parameter object for a certain menu item

public

Paramètres:

int	The item id

Renvoie:

object A JParameter object

Références $id, et $menu.

JMenu::load

(

)

Loads the menu items

public

Renvoie:

array

Réimplémentée dans JMenuSite.

& JMenu::setActive

(

$

id

)

Set the default item by id

Paramètres:

int	The item id public

Renvoie:

If successfull the active item, otherwise null

Références $id.

JMenu::setDefault

(

$

id

)

Set the default item by id

Paramètres:

int	The item id public

Renvoie:

True, if succesfull

Références $id.

---

Documentation des données membres

JMenu::$_active = 0

Identifier of the active menu item

private

Paramètres:

integer

JMenu::$_default = 0

Identifier of the default menu item

private

Paramètres:

integer

JMenu::$_items = array ()

Array to hold the menu items

private

Paramètres:

array

---

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

• libraries/joomla/application/menu.php