JMenu

From Joomla! Documentation
(Difference between revisions)
Jump to: navigation, search
m (Added availability section.)
(Bulk upload by Doxiki2)
Line 1: Line 1:
'''JMenu''' is a class which encapsulates a Joomla menu.
+
This class is available in the following Joomla versions:-
 
+
<splist showpath=notparent />
===Availability===
+
<noinclude>[[Category:Framework]][[Category:JMenu]]</noinclude>
{{JVer|1.5}} {{JVer|1.6}}
+
 
+
===Defined in===
+
/libraries/joomla/application/menu.php
+
 
+
===Extends===
+
* [[JObject]]
+
 
+
===Get and Set Methods===
+
Properties which do not have specific get or set methods listed here can be retrieved or set using the inherited [[JObject/get|JObject->get]] method.
+
{| class="wikitable"
+
|-
+
!Get method
+
!Set method
+
!Description
+
!Property
+
|-
+
|[[JMenu/getActive|getActive]]
+
|[[JMenu/setActive|setActive]]
+
|Current active menu item.
+
|
+
|-
+
|[[JMenu/getDefault|getDefault]]
+
|[[JMenu/setDefault|setDefault]]
+
|Current default menu item.
+
|
+
|-
+
|[[JMenu/getInstance|getInstance]]
+
|
+
|Returns a reference to a [[JMenu]] object, only creating it if it doesn't already exist.
+
|
+
|-
+
|[[JMenu/getItem|getItem]]
+
|
+
|Returns a menu item given an id.
+
|
+
|-
+
|[[JMenu/getItems|getItems]]
+
|
+
|Returns menu items which have a given value of an attribute.
+
|
+
|-
+
|[[JMenu/getMenu|getMenu]]
+
|
+
|Returns an array of [[JMenu]] objects.
+
|
+
|-
+
|[[JMenu/getParams|getParams]]
+
|
+
|Returns the parameters for a given menu item in a [[JParameter]] object.
+
|
+
|}
+
 
+
===Other Methods===
+
{| class="wikitable"
+
|-
+
!Method name
+
!Description
+
|-
+
|[[JMenu/authorize|authorize]]
+
|Checks the JMenu object authorization against an access control object and optionally an access extension object.
+
|-
+
|[[JMenu/load|load]]
+
|Loads the menu items.
+
|}
+
===Importing===
+
<source lang="php">jimport( 'joomla.application.menu' );</source>
+
 
+
===See also===
+
* [http://api.joomla.org/Joomla-Framework/Application/JMenu.html JMenu on api.joomla.org]
+
 
+
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JMenu]]</noinclude>
+

Revision as of 16:29, 17 April 2011

This class is available in the following Joomla versions:-

Personal tools
Namespaces

Variants
Actions
Navigation
Joomla! Sites
Toolbox