Docs For Class MenusHelper

Description

Menus component helper.

since: 1.6

Located in /administrator/components/com_menus/helpers/menus.php (line 19)

Variable Summary

static mixed $_filter

Method Summary

static void addSubmenu (string $vName)

static JObject getActions ([integer $parentId = 0])

static void getAssociations ( $pk)

static mixed getLinkKey (mixed $request)

static void getMenuLinks ([string $menuType = null], [integer $parentId = 0], [integer $mode = 0], [array $published = array()], [ $languages = array()])

static array getMenuTypes ()

Variables

static mixed $_filter = array('option', 'view', 'layout') (line 24)

Defines the valid request variables for the reverse lookup.

access: protected

Methods

static addSubmenu (line 31)

Configure the Linkbar.

access: public

static void addSubmenu (string $vName)

string $vName: The name of the active view.

static getActions (line 53)

Gets a list of the actions that can be performed.

since: 1.6
access: public

static JObject getActions ([integer $parentId = 0])

integer $parentId: The menu ID.

static getAssociations (line 253)

access: public

static void getAssociations ( $pk)

$pk

static getLinkKey (line 84)

Gets a standard form of a link for lookups.

return: A link in standard option-view-layout form, or false if the supplied response is invalid.
access: public

static mixed getLinkKey (mixed $request)

mixed $request: A link string or array of request variables.

static getMenuLinks (line 146)

Get a list of menu links for one or all menus.

access: public

static void getMenuLinks ([string $menuType = null], [integer $parentId = 0], [integer $mode = 0], [array $published = array()], [ $languages = array()])

string $menuType: An option menu to filter the list on, otherwise all menu links are returned as a grouped array.
integer $parentId: An optional parent ID to pivot results around.
integer $mode: An optional mode. If parent ID is set and mode=2, the parent and children are excluded from the list.
array $published: An optional array of states
$languages

static getMenuTypes (line 127)

Get the menu list for create a menu module

return: The menu array list
since: 1.6
access: public

static array getMenuTypes ()