[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/vtlib/Vtiger/ -> Module.php (summary)

(no description)

File Size: 212 lines (7 kb)
Included or required: 34 times
Referenced: 0 times
Includes or requires: 2 files
 includes/runtime/Cache.php
 vtlib/Vtiger/ModuleBasic.php

Defines 1 class

Vtiger_Module:: (14 methods):
  getId()
  __getRelatedListUniqueId()
  __getNextRelatedListSequence()
  setRelatedList()
  unsetRelatedList()
  addLink()
  deleteLink()
  getLinks()
  getLinksForExport()
  initWebservice()
  deinitWebservice()
  getInstance()
  getClassInstance()
  fireEvent()


Class: Vtiger_Module  - X-Ref

Provides API to work with vtiger CRM Modules

getId()   X-Ref
Function to get the Module/Tab id

return: <Number>

__getRelatedListUniqueId()   X-Ref
Get unique id for related list


__getNextRelatedListSequence()   X-Ref
Get related list sequence to use


setRelatedList($moduleInstance, $label='', $actions=false, $function_name='get_related_list')   X-Ref
Set related list information between other module

param: Vtiger_Module Instance of target module with which relation should be setup
param: String Label to display in related list (default is target module name)
param: Array List of action button to show ('ADD', 'SELECT')
param: String Callback function name of this module to use as handler

unsetRelatedList($moduleInstance, $label='', $function_name='get_related_list')   X-Ref
Unset related list information that exists with other module

param: Vtiger_Module Instance of target module with which relation should be setup
param: String Label to display in related list (default is target module name)
param: String Callback function name of this module to use as handler

addLink($type, $label, $url, $iconpath='', $sequence=0, $handlerInfo=null)   X-Ref
Add custom link for a module page

param: String Type can be like 'DETAILVIEW', 'LISTVIEW' etc..
param: String Label to use for display
param: String HREF value to use for generated link
param: String Path to the image file (relative or absolute)
param: Integer Sequence of appearance

deleteLink($type, $label, $url=false)   X-Ref
Delete custom link of a module

param: String Type can be like 'DETAILVIEW', 'LISTVIEW' etc..
param: String Display label to lookup
param: String URL value to lookup

getLinks()   X-Ref
Get all the custom links related to this module.


getLinksForExport()   X-Ref
Get all the custom links related to this module for exporting.


initWebservice()   X-Ref
Initialize webservice setup for this module instance.


deinitWebservice()   X-Ref
De-Initialize webservice setup for this module instance.


getInstance($value)   X-Ref
Get instance by id or name

param: mixed id or name of the module

getClassInstance($modulename)   X-Ref
Get instance of the module class.

param: String Module name

fireEvent($modulename, $event_type)   X-Ref
Fire the event for the module (if vtlib_handler is defined)




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