Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
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())
 getItem ($id)
 setDefault ($id, $language= '')
 getDefault ($language= '*')
 setActive ($id)
 getActive ()
 getItems ($attributes, $values, $firstonly=false)
 getParams ($id)
 getMenu ()
 authorise ($id)
 load ()
- Fonctions membres publiques inherited from JObject
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Fonctions membres publiques statiques

static getInstance ($client, $options=array())

Attributs protégés

 $_items = array()
 $_default = array()
 $_active = 0
- Attributs protégés inherited from JObject
 $_errors = array()

Attributs protégés statiques

static $instances = array()

Documentation des constructeurs et destructeur

JMenu::__construct (   $options = array())

Class constructor

Paramètres:
array$optionsAn array of configuration options.
Depuis:
11.1

Réimplémentée à partir de JObject.

Références $item, et JRegistry\loadString().

+ Voici le graphe d'appel pour cette fonction :


Documentation des fonctions membres

JMenu::authorise (   $id)

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

Paramètres:
integer$idThe menu id
Renvoie:
boolean True if authorised
Depuis:
11.1

Références $id, $menu, $user, et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

JMenu::getActive ( )

Get menu item by id.

Renvoie:
object The item object.
Depuis:
11.1

Références $item, et null.

JMenu::getDefault (   $language = '*')

Get the default item by language code.

Paramètres:
string$languageThe language code, default value of * means all.
Renvoie:
object The item object
Depuis:
11.1

Réimplémentée dans JMenuSite.

Références $language, et elseif.

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

Returns a JMenu object

Paramètres:
string$clientThe name of the client
array$optionsAn associative array of options
Renvoie:
JMenu A menu object.
Depuis:
11.1

Références $client, $options, $path, JApplicationHelper\getClientInfo(), et null.

+ Voici le graphe d'appel pour cette fonction :

JMenu::getItem (   $id)

Get menu item by id

Paramètres:
integer$idThe item id
Renvoie:
mixed The item object, or null if not found
Depuis:
11.1

Références $id, et null.

JMenu::getItems (   $attributes,
  $values,
  $firstonly = false 
)

Gets menu items by attribute

Paramètres:
mixed$attributesThe field name(s).
mixed$valuesThe value(s) of the field. If an array, need to match field names each attribute may have multiple values to lookup for.
boolean$firstonlyIf true, only returns the first item found
Renvoie:
array
Depuis:
11.1

Réimplémentée dans JMenuSite.

Références $count, $i, et $item.

JMenu::getMenu ( )

Getter for the menu array

Renvoie:
array
Depuis:
11.1
JMenu::getParams (   $id)

Gets the parameter object for a certain menu item

Paramètres:
integer$idThe item id
Renvoie:
JRegistry A JRegistry object
Depuis:
11.1

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

JMenu::load ( )

Loads the menu items

Renvoie:
array
Depuis:
11.1

Réimplémentée dans JMenuSite.

JMenu::setActive (   $id)

Set the default item by id

Paramètres:
integer$idThe item id
Renvoie:
mixed If successful the active item, otherwise null
Depuis:
11.1

Références $id, et null.

JMenu::setDefault (   $id,
  $language = '' 
)

Set the default item by id and language code.

Paramètres:
integer$idThe menu item id.
string$languageThe language cod (since 1.6).
Renvoie:
boolean True, if successful
Depuis:
11.1

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


Documentation des données membres

JMenu::$_active = 0
protected
JMenu::$_default = array()
protected
JMenu::$_items = array()
protected
JMenu::$instances = array()
staticprotected

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