[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/include/events/ -> VTEventsManager.inc (summary)

(no description)

File Size: 190 lines (6 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

VTEventsManager:: (14 methods):
  __construct()
  registerHandler()
  initTriggerCache()
  clearTriggerCache()
  setHandlerInActive()
  setHandlerActive()
  unregisterHandler()
  getTrigger()
  triggerEvent()
  setModuleForHandler()
  listHandlersForModule()
  listActiveEventHandlers()
  listAllEventHandlers()
  listEventHandlers()


Class: VTEventsManager  - X-Ref

Create and trigger events in vtiger

__construct($adb)   X-Ref
No description

registerHandler($forEvent, $path, $className, $condition='', $depedentOn='[]')   X-Ref
Register an event handler

param: $forEvent The name of the event to handle
param: $path The path to the php file containing the handler
param: $className The name of the VTEventHandler class.
param: $condition A condition which must evaluate true for the event to be accepted.

initTriggerCache($for = false, $force = false)   X-Ref
Initialize Event Trigger Cache for the required event types.

param: Object $for Optional String or Array of event_names for initializing.
param: Boolean $force Optional Force the initialization of cache?

clearTriggerCache($forEvent = false)   X-Ref
Clear the Event Trigger Cache

param: Object $forEvent

setHandlerInActive($handlerClass)   X-Ref
Set an event handler as inactive

param: The handler class to set as inactive

setHandlerActive($handlerClass)   X-Ref
Set an event handler as active

param: The handler class to set as active

unregisterHandler($className)   X-Ref
Unregister a registered handler

param: $className The name of teh VTEventHandler class to unregister

getTrigger($triggerName)   X-Ref
Get an event triger instance

param: $triggerName The name of the event.
return: The trigger object for the event.

triggerEvent($triggerName, $data)   X-Ref
Trigger an event

param: $triggerName The name of the event.
return: The trigger object for the event.

setModuleForHandler($moduleName, $handlerClass)   X-Ref
Set the module the handler belongs to

param: moduleName - The name of the module
param: handlerClass - The name of the handler class

listHandlersForModule($moduleName)   X-Ref
List handler classes for a module

param: moduleName - The name of the module

listActiveEventHandlers()   X-Ref
List active events.

return: A list of registered events.

listAllEventHandlers()   X-Ref
No description

listEventHandlers($result)   X-Ref
No description



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