dolibarr 20.0.2
InterfaceNotification Class Reference

Class of triggers for notification module. More...

Inheritance diagram for InterfaceNotification:
Collaboration diagram for InterfaceNotification:

Public Member Functions

 __construct ($db)
 Constructor.
 
 runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
 Function called when a Dolibarr business event is done.
 
 getListOfManagedEvents ()
 Return list of events managed by notification module.
 
- 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 triggers for notification module.

Definition at line 34 of file interface_50_modNotification_Notification.class.php.

Constructor & Destructor Documentation

◆ __construct()

InterfaceNotification::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 43 of file interface_50_modNotification_Notification.class.php.

References description, and name.

Member Function Documentation

◆ getListOfManagedEvents()

InterfaceNotification::getListOfManagedEvents ( )

Return list of events managed by notification module.

Returns
array Array of events managed by notification module

Definition at line 107 of file interface_50_modNotification_Notification.class.php.

References $object, dol_print_error(), and dol_syslog().

◆ runTrigger()

InterfaceNotification::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)

Parameters
string$actionEvent action code
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 67 of file interface_50_modNotification_Notification.class.php.

References $object, dol_syslog(), and name.


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