Référence de la classe MenusHelper

Fonctions membres publiques statiques
static	addSubmenu ($vName)
static	getActions ($parentId=0)
static	getLinkKey ($request)
static	getMenuTypes ($clientId=0)
static	getMenuLinks ($menuType=null, $parentId=0, $mode=0, $published=array(), $languages=array(), $clientId=0)
static	getAssociations ($pk)
static	getMenuItems ($menutype, $enabledOnly=false, $exclude=array())
static	installPreset ($preset, $menutype)

Attributs protégés statiques
static	$_filter = array('option', 'view', 'layout')

Description détaillée

Menus component helper.

Depuis

1.6

Documentation des fonctions membres

addSubmenu()

static addSubmenu (   $vName )

static

Configure the Linkbar.

Paramètres

string

$vName

The name of the active view.

Renvoie

void

Depuis

1.6

Références JHtmlSidebar\addEntry().

Référencé par MenusViewItems\display(), et MenusViewMenus\display().

getActions()

static getActions (   $parentId = 0 )

static

Gets a list of the actions that can be performed.

Paramètres

integer

$parentId

The menu ID.

Renvoie

JObject

Depuis

1.6

Obsolète:

3.2 Use JHelperContent::getActions() instead

getAssociations()

static getAssociations (   $pk )

static

Get the associations

Paramètres

integer

$pk

Menu item id

Renvoie

array

Depuis

3.0

Référencé par MenusHtmlMenus\association(), MenusModelItem\getItem(), ModLanguagesHelper\getList(), PlgSystemLanguageFilter\onAfterDispatch(), et PlgSystemLanguageFilter\onUserLogin().

getLinkKey()

static getLinkKey (   $request )

static

Gets a standard form of a link for lookups.

Paramètres

mixed

$request

A link string or array of request variables.

Renvoie

mixed A link in standard option-view-layout form, or false if the supplied response is invalid.

Depuis

1.6

Références $name, et $value.

Référencé par MenusModelMenutypes\addReverseLookupUrl(), et MenusModelItem\getItem().

getMenuItems()

static getMenuItems (   $menutype,   $enabledOnly = false,   $exclude = array()  )

static

Load the menu items from database for the given menutype

Paramètres

string	$menutype	The selected menu type
boolean	$enabledOnly	Whether to load only enabled/published menu items.
	int[]	$exclude The menu items to exclude from the list

Renvoie

array

Depuis

3.8.0

Obsolète:

4.0 This method will return a node object to iterate over in 4.0.

Références $db, et $query.

Référencé par MenusViewMenu\display(), JAdminCssMenu\load(), et JAdminCssMenu\preprocess().

getMenuLinks()

static getMenuLinks (   $menuType = null,   $parentId = 0,   $mode = 0,   $published = array(),   $languages = array(),   $clientId = 0  )

static

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

Paramètres

string	$menuType	An option menu to filter the list on, otherwise all menu with given client id 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
array	$languages	Optional array of specify which languages we want to filter
int	$clientId	Optional client id - viz 0 = site, 1 = administrator, can be NULL for all (used only if menutype not givein)

Renvoie

array

Depuis

1.6

Références $clientId, $db, $link, $menuType, $menuTypes, $mode, $published, $query, $type, elseif, et JError\raiseWarning().

Référencé par MenuitemField\getGroups(), et JFormFieldMenuitemByType\getGroups().

getMenuTypes()

static getMenuTypes (   $clientId = 0 )

static

Get the menu list for create a menu module

Paramètres

int

$clientId

Optional client id - viz 0 = site, 1 = administrator, can be NULL for all

Renvoie

array The menu array list

Depuis

1.6

Références $clientId, $db, et $query.

installPreset()

static installPreset (   $preset,   $menutype  )

static

Method to install a preset menu into database and link them to the given menutype

Paramètres

string	$preset	The preset name
string	$menutype	The target menutype

Renvoie

void

Exceptions

Exception

Depuis

3.8.0

Références $items.

Référencé par MenusControllerMenu\save().

Documentation des champs

$_filter

$_filter = array('option', 'view', 'layout')

staticprotected

Defines the valid request variables for the reverse lookup.

Depuis

1.6

---

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

• administrator/components/com_menus/helpers/menus.php