\JMenu

JMenu class

Synopsis

class JMenu {

• // members
• protected  $_items;
• protected  $_default;
• protected  $_active;
• protected  $instances;
• // methods
• public void __construct()
• public static JMenu getInstance()
• public mixed getItem()
• public boolean setDefault()
• public mixed getDefault()
• public mixed setActive()
• public  getActive()
• public array getItems()
• public JRegistry getParams()
• public array getMenu()
• public boolean authorise()
• public array load()
}


Hierarchy

Extended by

• JMenuAdministrator
• JMenuSite

Members

protected

• $_active — integer
  Identifier of the active menu item
• $_default — integer
  Identifier of the default menu item
• $_items — array
  Array to hold the menu items
• $instances — array

Methods

public

• __construct() — Class constructor
• authorise() — Method to check JMenu object authorization against an access control object and optionally an access extension object
• getActive() — Get menu item by id.
• getDefault() — Get the default item by language code.
• getInstance() — Returns a JMenu object
• getItem() — Get menu item by id
• getItems() — Gets menu items by attribute
• getMenu() — Getter for the menu array
• getParams() — Gets the parameter object for a certain menu item
• load() — Loads the menu items
• setActive() — Set the default item by id
• setDefault() — Set the default item by id and language code.