Actions

API17

Difference between revisions of "JMenu"

From Joomla! Documentation

(Layout updates)
m (User contributed notes: bad link repair)
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JMenu==
 +
===Description===
 +
{{Description:JMenu}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JMenu|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JMenu|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JMenu}}
 
===Defined in===
 
libraries/joomla/application/menu.php
 
* see source code in [[jplatform:application/menu.php|BitBucket]]
 
===Subpackage===
 
[[Subpackage Application/11.1|Application]]
 
===Extends===
 
[[JObject/11.1|JObject]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JMenu::__construct/11.1|__construct]]
 
|[[JMenu::__construct/11.1|__construct]]
 
|Class constructor.  
 
|Class constructor.  
 
|-
 
|-
 +
|public
 
|[[JMenu::authorise/11.1|authorise]]
 
|[[JMenu::authorise/11.1|authorise]]
 
|Method to check  object authorization against an access control object and optionally an access extension object.  
 
|Method to check  object authorization against an access control object and optionally an access extension object.  
 
|-
 
|-
 +
|public
 
|[[JMenu::getActive/11.1|getActive]]
 
|[[JMenu::getActive/11.1|getActive]]
 
|Get menu item by id.  
 
|Get menu item by id.  
 
|-
 
|-
 +
|public
 
|[[JMenu::getDefault/11.1|getDefault]]
 
|[[JMenu::getDefault/11.1|getDefault]]
 
|Get menu item by id.  
 
|Get menu item by id.  
 
|-
 
|-
 +
|public
 
|[[JMenu::getItem/11.1|getItem]]
 
|[[JMenu::getItem/11.1|getItem]]
 
|Get menu item by id.  
 
|Get menu item by id.  
 
|-
 
|-
 +
|public
 
|[[JMenu::getItems/11.1|getItems]]
 
|[[JMenu::getItems/11.1|getItems]]
 
|Gets menu items by attribute.  
 
|Gets menu items by attribute.  
 
|-
 
|-
 +
|public
 
|[[JMenu::getMenu/11.1|getMenu]]
 
|[[JMenu::getMenu/11.1|getMenu]]
 
|Getter for the menu array.  
 
|Getter for the menu array.  
 
|-
 
|-
 +
|public
 
|[[JMenu::getParams/11.1|getParams]]
 
|[[JMenu::getParams/11.1|getParams]]
 
|Gets the parameter object for a certain menu item.  
 
|Gets the parameter object for a certain menu item.  
 
|-
 
|-
 +
|public
 
|[[JMenu::load/11.1|load]]
 
|[[JMenu::load/11.1|load]]
 
|Loads the menu items.  
 
|Loads the menu items.  
 
|-
 
|-
 +
|public
 
|[[JMenu::setActive/11.1|setActive]]
 
|[[JMenu::setActive/11.1|setActive]]
 
|Set the default item by id.  
 
|Set the default item by id.  
 
|-
 
|-
 +
|public
 
|[[JMenu::setDefault/11.1|setDefault]]
 
|[[JMenu::setDefault/11.1|setDefault]]
 
|Set the default item by id and language code.  
 
|Set the default item by id and language code.  
 
|-
 
|-
 +
|public static
 
|[[JMenu::getInstance/11.1|getInstance]]
 
|[[JMenu::getInstance/11.1|getInstance]]
 
|Returns a  object.  
 
|Returns a  object.  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/application/menu.php
 +
* '''Extends''' [[JObject/11.1|JObject]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.application.menu' );</source>
 
<source lang="php">jimport( 'joomla.application.menu' );</source>
 
===See also===
 
===See also===
* JMenu source code in [[jplatform:application/menu.php|BitBucket]]
+
* {{JVer|11.1}} '''JMenu source code''' on [[jplatform:application/menu.php|BitBucket]]
* [[JMenu|Other versions of this class]]
+
* {{JVer|11.1}} Subpackage [[Subpackage Application/11.1|Application]]
 +
* [[JMenu|Other versions of JMenu]]
 
{{SeeAlso:JMenu}}
 
{{SeeAlso:JMenu}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JMenu|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JMenu|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 72: Line 82:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JMenu]]</noinclude>
+
<noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JMenu]]</noinclude>

Revision as of 13:57, 29 August 2012

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JMenu

Description

Description:JMenu [Edit Descripton]

Methods

Visibility Method name Description
public __construct Class constructor.
public authorise Method to check object authorization against an access control object and optionally an access extension object.
public getActive Get menu item by id.
public getDefault Get menu item by id.
public getItem Get menu item by id.
public getItems Gets menu items by attribute.
public getMenu Getter for the menu array.
public getParams Gets the parameter object for a certain menu item.
public load Loads the menu items.
public setActive Set the default item by id.
public setDefault Set the default item by id and language code.
public static getInstance Returns a object.
  • Defined in libraries/joomla/application/menu.php
  • Extends JObject

Importing

jimport( 'joomla.application.menu' );

See also

SeeAlso:JMenu [Edit See Also]

User contributed notes

<CodeExamplesForm />