class CToolbar


Located at : UKNOWVA_ROOT/components/com_community/libraries/toolbar.php

Deprecated since 2.2.x

Properties

$_toolbar

Methods

CToolbar()

No description

addGroup($key, $caption = '', $link = '')

Function to add new toolbar group.

removeGroup($key)

Function used to remove toolbar group and its associated menu items.

addItem($groupKey, $itemKey, $caption = '', $link = '', $order = 'append', $isScriptCall = false, $hasSeparator = false)

Function to add new toolbar menu items.

removeItem($groupKey, $itemKey)

Function used to remove toolbar menu item param - groupKey : string - the key of the group - itemKey : string - the unique key of the menu item

getMenuItemObjects($groupKey, $order)

Function used to return html anchor link param - string - toolbar group key - string - order of the items return - string - html anchor links

getMenuItems($groupKey, $order)

Deprecated since 1.8.x

getExtraToolbars()

Function to retrieve those toolbar that user custom add.

getToolbarItems($groupKey)

Function to retrieve custom toolbar menu items to caller param - groupKey : string - the key of the group return array of object

hasToolBarGroup($groupKey)

Function used to determined whether a core menu group was set.

addGroupActiveView($groupkey, $viewName)

Function to add views that associated with the toolbar group.

getGroupActiveView($viewName)

Function to get the toolbar group key based on what view being associated.

getToolBarGroupKey()

Function used to return all the toolbar group keys.

getActiveToolBarGroup($uri)

Function to get the current viewing page, the toolbar group key.

Details

at line 51
CToolbar()

at line 68
addGroup($key, $caption = '', $link = '')

Function to add new toolbar group.

param - key : string - the key of the group - caption : string - the label of the group name - link : string - the url that link to the page

Parameters

$key
$caption
$link

at line 89
removeGroup($key)

Function used to remove toolbar group and its associated menu items.

param - key : string - the key of the group

Parameters

$key

at line 113
addItem($groupKey, $itemKey, $caption = '', $link = '', $order = 'append', $isScriptCall = false, $hasSeparator = false)

Function to add new toolbar menu items.

param - groupKey : string - the key of the group - itemKey : string - the unique key of the menu item - caption : string - the label of the menu item name - link : string - the url that link to the page - order : string - display sequence : append | prepend - isScriptCall : boolean - to indicate whether this is a javascript function or is a anchor link. - hasSeparator : boolean - to indicate whether this item should use the class 'seperator' from JomSocial.

Parameters

$groupKey
$itemKey
$caption
$link
$order
$isScriptCall
$hasSeparator

at line 141
removeItem($groupKey, $itemKey)

Function used to remove toolbar menu item param - groupKey : string - the key of the group - itemKey : string - the unique key of the menu item

Parameters

$groupKey
$itemKey

at line 171
getMenuItemObjects($groupKey, $order)

Function used to return html anchor link param - string - toolbar group key - string - order of the items return - string - html anchor links

Parameters

$groupKey
$order

at line 231
getMenuItems($groupKey, $order)

Deprecated since 1.8.x

Parameters

$groupKey
$order

at line 256
getExtraToolbars()

Function to retrieve those toolbar that user custom add.

return - an array of object.

at line 289
getToolbarItems($groupKey)

Function to retrieve custom toolbar menu items to caller param - groupKey : string - the key of the group return array of object

Parameters

$groupKey

at line 308
hasToolBarGroup($groupKey)

Function used to determined whether a core menu group was set.

param - string - toolbar group key return - boolean

Parameters

$groupKey

at line 325
addGroupActiveView($groupkey, $viewName)

Function to add views that associated with the toolbar group.

param - string - group key param - string - view name

Parameters

$groupkey
$viewName

at line 349
getGroupActiveView($viewName)

Function to get the toolbar group key based on what view being associated.

param - string - view name return - string

Parameters

$viewName

at line 372
getToolBarGroupKey()

Function used to return all the toolbar group keys.

return - array

at line 383
getActiveToolBarGroup($uri)

Function to get the current viewing page, the toolbar group key.

param - string - uri of the current view page return - string

Parameters

$uri