dolibarr 18.0.6
InterfaceMyModuleTriggers Class Reference

Class of triggers for MyModule module. More...

Inheritance diagram for InterfaceMyModuleTriggers:
Collaboration diagram for InterfaceMyModuleTriggers:

Public Member Functions

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

Detailed Description

Class of triggers for MyModule module.

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

Constructor & Destructor Documentation

◆ __construct()

InterfaceMyModuleTriggers::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

References description, and name.

Member Function Documentation

◆ getDesc()

InterfaceMyModuleTriggers::getDesc ( )

Trigger description.

Returns
string Description of trigger file

Reimplemented from DolibarrTriggers.

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

◆ getName()

InterfaceMyModuleTriggers::getName ( )

Trigger name.

Returns
string Name of trigger file

Reimplemented from DolibarrTriggers.

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

◆ runTrigger()

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

Reimplemented from DolibarrTriggers.

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

References dol_syslog(), and name.


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