dolibarr 21.0.0-beta
InterfaceEventOrganization Class Reference

Class of triggered functions for agenda module. More...

Inheritance diagram for InterfaceEventOrganization:
Collaboration diagram for InterfaceEventOrganization:

Public Member Functions

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

Detailed Description

Class of triggered functions for agenda module.

Definition at line 32 of file interface_50_modEventOrganization_EventOrganization.class.php.

Constructor & Destructor Documentation

◆ __construct()

InterfaceEventOrganization::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

References description, and name.

Member Function Documentation

◆ runTrigger()

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

Function called when a Dolibarr business event is done.

All functions "runTrigger" are triggered if file is inside directory htdocs/core/triggers or htdocs/module/code/triggers (and declared)

Following properties may be set before calling trigger. The may be completed by this trigger to be used for writing the event into database: $object->actiontypecode (translation action code: AC_OTH, ...) $object->actionmsg (note, long text) $object->actionmsg2 (label, short text) $object->sendtoid (id of contact or array of ids of contacts) $object->socid (id of thirdparty) $object->fk_project $object->fk_element (ID of object to link action event to) $object->elementtype (->element of object to link action to) $object->module (if defined, elementtype in llx_actioncomm will be elementtype

Parameters
string$actionEvent action code ('CONTRACT_MODIFY', 'RECRUITMENTCANDIDATURE_MODIFIY', ...)
Object$objectObject
User$userObject user
Translate$langsObject langs
conf$confObject conf
Returns
int Return integer <0 if KO, 0 if no triggered ran, >0 if OK

Reimplemented from DolibarrTriggers.

Definition at line 72 of file interface_50_modEventOrganization_EventOrganization.class.php.

References $conf, $object, dol_syslog(), and getDolGlobalString().


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