dolibarr  7.0.0-beta
Public Member Functions | List of all members
InterfaceMyModuleTriggers Class Reference

Class of triggers for MyModule module. More...

+ Inheritance diagram for InterfaceMyModuleTriggers:
+ Collaboration diagram for InterfaceMyModuleTriggers:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getName ()
 Trigger name. More...
 
 getDesc ()
 Trigger description. More...
 
 runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
 Function called when a Dolibarrr business event is done. More...
 
- Public Member Functions inherited from DolibarrTriggers
 __construct (DoliDB $db)
 Constructor. More...
 
 getName ()
 Returns the name of the trigger file. More...
 
 getDesc ()
 Returns the description of trigger file. More...
 
 getVersion ()
 Returns the version of the trigger file. More...
 
 runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
 Function called when a Dolibarrr business event is done. More...
 

Detailed Description

Class of triggers for MyModule module.

Definition at line 41 of file interface_99_modMyModule_MyModuleTriggers.class.php.

Constructor & Destructor Documentation

InterfaceMyModuleTriggers::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 53 of file interface_99_modMyModule_MyModuleTriggers.class.php.

References description, and name.

Member Function Documentation

InterfaceMyModuleTriggers::getDesc ( )

Trigger description.

Returns
string Description of trigger file

Definition at line 80 of file interface_99_modMyModule_MyModuleTriggers.class.php.

InterfaceMyModuleTriggers::getName ( )

Trigger name.

Returns
string Name of trigger file

Definition at line 70 of file interface_99_modMyModule_MyModuleTriggers.class.php.

InterfaceMyModuleTriggers::runTrigger (   $action,
  $object,
User  $user,
Translate  $langs,
Conf  $conf 
)

Function called when a Dolibarrr business event is done.

All functions "runTrigger" are triggered if file is inside directory core/triggers

Parameters
string$actionEvent action code
CommonObject$objectObject
User$userObject user
Translate$langsObject langs
Conf$confObject conf
Returns
int <0 if KO, 0 if no triggered ran, >0 if OK

Definition at line 98 of file interface_99_modMyModule_MyModuleTriggers.class.php.

References dol_syslog(), and name.


The documentation for this class was generated from the following file: