dolibarr 21.0.0-alpha
DolibarrTriggers Class Reference

Class that all triggers must inherit. More...

Inheritance diagram for DolibarrTriggers:
Collaboration diagram for DolibarrTriggers:

Public Member Functions

 __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
 
 runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
 Function called when a Dolibarr business event is done.
 

Detailed Description

Class that all triggers must inherit.

Definition at line 23 of file dolibarrtriggers.class.php.

Constructor & Destructor Documentation

◆ __construct()

DolibarrTriggers::__construct ( DoliDB $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented in InterfaceLogevents.

Definition at line 110 of file dolibarrtriggers.class.php.

References description, and name.

Member Function Documentation

◆ getDesc()

DolibarrTriggers::getDesc ( )

Returns the description of trigger file.

Returns
string

Definition at line 137 of file dolibarrtriggers.class.php.

◆ getName()

DolibarrTriggers::getName ( )

Returns the name of the trigger file.

Returns
string

Definition at line 127 of file dolibarrtriggers.class.php.

◆ getVersion()

DolibarrTriggers::getVersion ( )

Returns the version of the trigger file.

Returns
string Version of trigger file

Definition at line 147 of file dolibarrtriggers.class.php.

◆ runTrigger()

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

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 if KO: <0 || if no trigger ran: 0 || if OK: >0

Reimplemented in InterfaceActionsAuto, InterfaceActionsBlockedLog, InterfaceContactRoles, InterfaceEventOrganization, InterfaceLdapsynchro, InterfaceLogevents, InterfaceMailmanSpipsynchro, InterfaceMyModuleTriggers, InterfaceNotification, InterfaceStripe, InterfaceTicketEmail, InterfaceWebhookTriggers, and InterfaceZapierTriggers.

◆ setErrorsFromObject()

DolibarrTriggers::setErrorsFromObject ( CommonObject $object)

setErrorsFromObject

Parameters
CommonObject$objectObject
Returns
void

Definition at line 169 of file dolibarrtriggers.class.php.

References $object.


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