Triggers system - Revision history

Eldy: /* Execute your own code on a Dolibarr business event */

2025-08-31T11:57:46Z

Execute your own code on a Dolibarr business event

← Older revision		Revision as of 11:57, 31 August 2025
Line 42:		Line 42:
	By creating such a file with a name like the example, your new trigger file will be executed each time a Dolibarr business event occurs but only if the module Facture is enabled.		By creating such a file with a name like the example, your new trigger file will be executed each time a Dolibarr business event occurs but only if the module Facture is enabled.

	'''Note''': If you develop a ~~full~~ module, you can also place the trigger file in your own module's sub-directory. Eg: if your module resides in htdocs/mymodule/, then you can place your triggers inside htdocs/mymodule/core/triggers/. But for this, you must declare the trigger into your module descriptor file (eg: '''/mymodule/core/modules/modMyModule.class.php'''). For this, add into this file triggers->1 into module_parts array:
			'''Note''': If you develop a complete module, you can also place the trigger file in your own module's sub-directory. Eg: if your module resides in htdocs/mymodule/, then you can place your triggers inside htdocs/mymodule/core/triggers/. But for this, you must declare the trigger into your module descriptor file (eg: '''/mymodule/core/modules/modMyModule.class.php'''). For this, add into this file triggers->1 into module_parts array:
	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
	// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)		// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)

Eldy: /* Execute your own code on a Dolibarr business event */

2024-11-13T20:07:43Z

Execute your own code on a Dolibarr business event

← Older revision		Revision as of 20:07, 13 November 2024
Line 54:		Line 54:


	2) Edit the file ''interface_99_modFacture_Myworkflow.class.php'' to ~~rename~~ the class ''InterfaceMyModuleTriggers'' by ''InterfaceMyworkflow:''		2) Edit the file ''interface_99_modFacture_Myworkflow.class.php'' to modify its content by changing the class ''InterfaceMyModuleTriggers'' by ''InterfaceMyworkflow:''

	Then go on page Home -> Admin Tools -> About Dolibarr ->Triggers.		Then go on page Home -> Admin Tools -> About Dolibarr ->Triggers.

Eldy: /* Execute your own code on a Dolibarr business event */

2024-11-13T19:59:48Z

Execute your own code on a Dolibarr business event

← Older revision		Revision as of 19:59, 13 November 2024
Line 32:		Line 32:
	This new file must be saved inside same directory.		This new file must be saved inside same directory.

	Note: Value you can use for ~~mod MyModule~~ are values found in directory		Note: Value you can use for modMyModule are values found in directory
	''htdocs/~~includes~~/modules''.		''htdocs/core/modules''.

	'''WARNING''': All those parameters are necessary for the trigger to be detected and executed! Eg: if you forget the priority number, your trigger won't be detected!		'''WARNING''': All those parameters are necessary for the trigger to be detected and executed! Eg: if you forget the priority number, your trigger won't be detected!

	For example, you can name your new trigger file:		For example, you can name your new trigger file:
	''htdocs/~~includes~~/triggers/interface_99_modFacture_Myworkflow.class.php''		''htdocs/core/triggers/interface_99_modFacture_Myworkflow.class.php''

	By creating such a file with a name like the example, your new trigger file will be executed each time a Dolibarr business event occurs but only if the module Facture is enabled.		By creating such a file with a name like the example, your new trigger file will be executed each time a Dolibarr business event occurs but only if the module Facture is enabled.

	'''Note''': If you develop a full module, you can also place the trigger file in your own module's ~~subdirectly~~. Eg: if your module resides in htdocs/mymodule/, then you can place your triggers inside htdocs/mymodule/core/triggers/. But for this, you must declare the trigger into your module descriptor file (eg: '''/mymodule/core/modules/modMyModule.class.php'''). For this, add into this file triggers->1 into module_parts array:		'''Note''': If you develop a full module, you can also place the trigger file in your own module's sub-directory. Eg: if your module resides in htdocs/mymodule/, then you can place your triggers inside htdocs/mymodule/core/triggers/. But for this, you must declare the trigger into your module descriptor file (eg: '''/mymodule/core/modules/modMyModule.class.php'''). For this, add into this file triggers->1 into module_parts array:
	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
	// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)		// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)
Line 54:		Line 54:


	2) Edit the file ''~~interface_99_modMyModule_Myworkflow~~.class.php'' to rename class ''InterfaceMyModuleTriggers'' by ''InterfaceMyworkflow''		2) Edit the file ''interface_99_modFacture_Myworkflow.class.php'' to rename the class ''InterfaceMyModuleTriggers'' by ''InterfaceMyworkflow:''

	Then go on page Home -> Admin Tools -> About Dolibarr ->Triggers.		Then go on page Home -> Admin Tools -> About Dolibarr ->Triggers.

Eldy: /* Execute your own code on a Dolibarr business event */

2024-08-14T15:22:40Z

Execute your own code on a Dolibarr business event

← Older revision		Revision as of 15:22, 14 August 2024
Line 17:		Line 17:
	* change of the primary status of objects		* change of the primary status of objects
	There is another feature for developers to inject custom code in the application called the [[Hooks system]]. Note, for historic reason, when you send an email, this generates also a trigger call even if this case is not among the 2 allowed.		There is another feature for developers to inject custom code in the application called the [[Hooks system]]. Note, for historic reason, when you send an email, this generates also a trigger call even if this case is not among the 2 allowed.


	So, to add your own code that will be triggered by a Dolibarr trigger, this is the process:		So, to add your own code that will be triggered by a Dolibarr trigger, this is the process:

Eldy: /* Execute your own code on a Dolibarr business event */

2024-08-14T15:20:39Z

Execute your own code on a Dolibarr business event

← Older revision		Revision as of 15:20, 14 August 2024
Line 13:		Line 13:
	You can also use triggers to modify the behavior of Dolibarr itself: for example, to create a contract automatically when an invoice is validated, a fill a log file when a record is deleted, ...		You can also use triggers to modify the behavior of Dolibarr itself: for example, to create a contract automatically when an invoice is validated, a fill a log file when a record is deleted, ...

	Note that triggers is a feature for developers that is limited to business CRUD events (Create \| Read \| Update \| Delete). There is another feature for developers to inject custom code in the application called the [[Hooks system]].		Note that triggers is a feature for developers that is limited to:
			* business CRUD events (Create \| Read \| Update \| Delete).
			* change of the primary status of objects
			There is another feature for developers to inject custom code in the application called the [[Hooks system]]. Note, for historic reason, when you send an email, this generates also a trigger call even if this case is not among the 2 allowed.

	So, to add your own code that will be triggered by a Dolibarr trigger, this is the process:		So, to add your own code that will be triggered by a Dolibarr trigger, this is the process:

Eldy: Eldy moved page Triggers to Triggers system

2024-08-14T15:15:05Z

Eldy moved page Triggers to Triggers system

← Older revision	Revision as of 15:15, 14 August 2024
(No difference)

TanguyP: Update class name as per Dolibarr 18.0.2

2023-11-23T10:45:55Z

Update class name as per Dolibarr 18.0.2

← Older revision		Revision as of 10:45, 23 November 2023
Line 39:		Line 39:

	'''Note''': If you develop a full module, you can also place the trigger file in your own module's subdirectly. Eg: if your module resides in htdocs/mymodule/, then you can place your triggers inside htdocs/mymodule/core/triggers/. But for this, you must declare the trigger into your module descriptor file (eg: '''/mymodule/core/modules/modMyModule.class.php'''). For this, add into this file triggers->1 into module_parts array:		'''Note''': If you develop a full module, you can also place the trigger file in your own module's subdirectly. Eg: if your module resides in htdocs/mymodule/, then you can place your triggers inside htdocs/mymodule/core/triggers/. But for this, you must declare the trigger into your module descriptor file (eg: '''/mymodule/core/modules/modMyModule.class.php'''). For this, add into this file triggers->1 into module_parts array:
	<~~syntaxHighlight~~ lang="~~php~~">		<syntaxhighlight lang="PHP">
	// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)		// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)
	$this->module_parts = array('triggers' => 1);		$this->module_parts = array('triggers' => 1);
Line 46:		Line 46:
	// 'substitutions' => 0,		// 'substitutions' => 0,
	// 'menus' => 0);		// 'menus' => 0);
	</~~syntaxHighlight~~>		</syntaxhighlight>
	Then disable and reenable your module. This will add a record into [[Table llx_const]] to tell Dolibarr that a trigger file must be searched in the module directory '''htdocs/mymodule/core/triggers/'''		Then disable and reenable your module. This will add a record into [[Table llx_const]] to tell Dolibarr that a trigger file must be searched in the module directory '''htdocs/mymodule/core/triggers/'''


	2) Edit the file ''interface_99_modMyModule_Myworkflow.class.php'' to rename class ''~~InterfaceDemo~~'' by ''InterfaceMyworkflow''		2) Edit the file ''interface_99_modMyModule_Myworkflow.class.php'' to rename class ''InterfaceMyModuleTriggers'' by ''InterfaceMyworkflow''

	Then go on page Home -> Admin Tools -> About Dolibarr ->Triggers.		Then go on page Home -> Admin Tools -> About Dolibarr ->Triggers.
Line 59:		Line 59:
	This function is called at each Dolibarr business event. Put your code according to events on which you want to run. Each event is identified by a code (see following chapter to get full list of codes). So you can react or no after an event by doing just a test on variable '''$action''':		This function is called at each Dolibarr business event. Put your code according to events on which you want to run. Each event is identified by a code (see following chapter to get full list of codes). So you can react or no after an event by doing just a test on variable '''$action''':

	<~~syntaxHighlight~~ lang="~~php~~">		<syntaxhighlight lang="PHP">
	function run_trigger($action,$object,$user,$langs,$conf)		function run_trigger($action,$object,$user,$langs,$conf)
	{		{
Line 77:		Line 77:
	...		...
	}		}
	</~~syntaxHighlight~~>		</syntaxhighlight>

	You can do what you want into this coding part, if you check that function run_trigger returns a return code according to following rule:		You can do what you want into this coding part, if you check that function run_trigger returns a return code according to following rule:
Line 110:		Line 110:
	To manage events other than those above, you must modify the Dolibarr code to add the following sequence in the business methods of the classes of the objects handled:		To manage events other than those above, you must modify the Dolibarr code to add the following sequence in the business methods of the classes of the objects handled:

	<~~syntaxHighlight~~ lang="~~php~~">		<syntaxhighlight lang="PHP">
	// Call trigger		// Call trigger
	$result = $this->call_trigger('CODE_TRIGGER', $user);		$result = $this->call_trigger('CODE_TRIGGER', $user);
	if ($result <0) $error++;		if ($result <0) $error++;
	// End call triggers		// End call triggers
	</~~syntaxHighlight~~>		</syntaxhighlight>

	To add context information (for example to dissociate 2 different cases called with the same Trigger code), it is possible to place this information in the properties ->context of the object on which the trigger is called. Example:		To add context information (for example to dissociate 2 different cases called with the same Trigger code), it is possible to place this information in the properties ->context of the object on which the trigger is called. Example:

	<~~syntaxHighlight~~ lang="~~php~~">		<syntaxhighlight lang="PHP">
	// Call trigger		// Call trigger
	$this->context = array('paramX'=>$valueX, 'anyparamofyourchoice'=>$anyvalue);		$this->context = array('paramX'=>$valueX, 'anyparamofyourchoice'=>$anyvalue);
Line 125:		Line 125:
	if ($result < 0) $error++;		if ($result < 0) $error++;
	// End call triggers		// End call triggers
	</~~syntaxHighlight~~>		</syntaxhighlight>

	It will then be possible to add in the run_trigger method of any trigger file, an if which allows you to manage this code. The run_trigger method would then be of the form:		It will then be possible to add in the run_trigger method of any trigger file, an if which allows you to manage this code. The run_trigger method would then be of the form:

	<~~syntaxHighlight~~ lang="~~php~~">		<syntaxhighlight lang="PHP">
	function run_trigger($action,$object,$user,$lang,$conf)		function run_trigger($action,$object,$user,$lang,$conf)
	{		{
Line 151:		Line 151:
	...		...
	}		}
	</~~syntaxHighlight~~>		</syntaxhighlight>

	'''Please note the following before adding additional calls to triggers:'''		'''Please note the following before adding additional calls to triggers:'''

Priojk at 12:59, 24 October 2023

2023-10-24T12:59:20Z

← Older revision		Revision as of 12:59, 24 October 2023
Line 156:		Line 156:

	The rule is to have only 1 trigger call per business CRUD event, even when several actions are done in the same transaction.		The rule is to have only 1 trigger call per business CRUD event, even when several actions are done in the same transaction.
	As an example: When a new ticket is created with an already assigned user, only the TICKET_CREATE trigger is called, not additionally the TICKET_ASSIGNED trigger. It is job of the trigger to intercept also this case to scan if an ~~assignement~~ is done directly during creation and to execute its custom code.		As an example: When a new ticket is created with an already assigned user, only the TICKET_CREATE trigger is called, not additionally the TICKET_ASSIGNED trigger. It is the job of the trigger to intercept also this case to scan if an assignment is done directly during creation and to execute its custom code.

Priojk at 12:58, 24 October 2023

2023-10-24T12:58:23Z

← Older revision		Revision as of 12:58, 24 October 2023
Line 153:		Line 153:
	</syntaxHighlight>		</syntaxHighlight>

	~~__Please~~ note the following before adding additional calls to triggers:__		'''Please note the following before adding additional calls to triggers:'''

	The rule is to have only 1 trigger call per business CRUD event, even when several actions are done in the same transaction.		The rule is to have only 1 trigger call per business CRUD event, even when several actions are done in the same transaction.
	As an example: When a new ticket is created with an already assigned user, only the TICKET_CREATE trigger is called, not additionally the TICKET_ASSIGNED trigger. It is job of the trigger to intercept also this case to scan if an assignement is done directly during creation and to execute its custom code.		As an example: When a new ticket is created with an already assigned user, only the TICKET_CREATE trigger is called, not additionally the TICKET_ASSIGNED trigger. It is job of the trigger to intercept also this case to scan if an assignement is done directly during creation and to execute its custom code.

Priojk: Added additional information re adding triggers.

2023-10-24T12:57:16Z

Added additional information re adding triggers.

← Older revision		Revision as of 12:57, 24 October 2023
Line 152:		Line 152:
	}		}
	</syntaxHighlight>		</syntaxHighlight>

			__Please note the following before adding additional calls to triggers:__
			The rule is to have only 1 trigger call per business CRUD event, even when several actions are done in the same transaction.
			As an example: When a new ticket is created with an already assigned user, only the TICKET_CREATE trigger is called, not additionally the TICKET_ASSIGNED trigger. It is job of the trigger to intercept also this case to scan if an assignement is done directly during creation and to execute its custom code.


	=Conclusion=		=Conclusion=