[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/modules/Settings/Vtiger/models/ -> MenuItem.php (summary)

(no description)

File Size: 309 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Settings_Vtiger_MenuItem_Model:: (16 methods):
  getId()
  getMenu()
  setMenu()
  setMenuFromInstance()
  getUrl()
  getModuleName()
  getPinUnpinActionUrl()
  isPinned()
  updatePinStatus()
  markPinned()
  unMarkPinned()
  getInstanceFromArray()
  getInstance()
  getInstanceById()
  getAll()
  getPinnedItems()


Class: Settings_Vtiger_MenuItem_Model  - X-Ref

getId()   X-Ref
Function to get the Id of the menu item

return: <Number> - Menu Item Id

getMenu()   X-Ref
Function to get the Menu to which the Item belongs

return: Settings_Vtiger_Menu_Model instance

setMenu($menuId)   X-Ref
Function to set the Menu to which the Item belongs, given Menu Id

param: <Number> $menuId
return: Settings_Vtiger_MenuItem_Model

setMenuFromInstance($menu)   X-Ref
Function to set the Menu to which the Item belongs, given Menu Model instance

param: <Settings_Vtiger_Menu_Model> $menu - Settings Menu Model instance
return: Settings_Vtiger_MenuItem_Model

getUrl()   X-Ref
Function to get the url to get to the Settings Menu Item

return: <String> - Menu Item landing url

getModuleName()   X-Ref
Function to get the module name, to which the Settings Menu Item belongs to

return: <String> - Module to which the Menu Item belongs

getPinUnpinActionUrl()   X-Ref
Function to get the pin and unpin action url


isPinned()   X-Ref
Function to verify whether menuitem is pinned or not

return: <Boolean> true to pinned, false to not pinned.

updatePinStatus($pinned=false)   X-Ref
Function which will update the pin status

param: <Boolean> $pinned - true to enable , false to disable

markPinned()   X-Ref
Function which will enable the field as pinned


unMarkPinned()   X-Ref
Function which will disable the field pinned status


getInstanceFromArray($valueMap)   X-Ref
Function to get the instance of the Menu Item model given the valuemap array

param: <Array> $valueMap
return: Settings_Vtiger_MenuItem_Model instance

getInstance($name, $menuModel=false)   X-Ref
Function to get the instance of the Menu Item model, given name and Menu instance

param: <String> $name
param: <Settings_Vtiger_Menu_Model> $menuModel
return: Settings_Vtiger_MenuItem_Model instance

getInstanceById($id, $menuModel=false)   X-Ref
Function to get the instance of the Menu Item model, given item id and Menu instance

param: <String> $name
param: <Settings_Vtiger_Menu_Model> $menuModel
return: Settings_Vtiger_MenuItem_Model instance

getAll($menuModel=false, $onlyActive=true)   X-Ref
Static function to get the list of all the items of the given Menu, all items if Menu is not specified

param: <Settings_Vtiger_Menu_Model> $menuModel
return: <Array> - List of Settings_Vtiger_MenuItem_Model instances

getPinnedItems($fieldList = array()   X-Ref
Function to get the pinned items

param: array of fieldids.
return: <Array> - List of Settings_Vtiger_MenuItem_Model instances



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1