Changes

[[fr:Système de Triggers]]

[[fr:Système de Triggers]]

[[es:Triggers-acciones]]

[[es:Triggers-acciones]]

<!-- END interlang links -->

<!-- END interlang links -->

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).  

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:

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:

<source 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);

//              'substitutions' => 0,

//              'substitutions' => 0,

//              'menus' => 0);

//              'menus' => 0);

</source>

</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_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.

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''':

<source lang="php">

<syntaxhighlight lang="php">

   function run_trigger($action,$object,$user,$langs,$conf)

   function run_trigger($action,$object,$user,$langs,$conf)

   {

   {

         ...

         ...

   }

   }

</source>

</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:

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:

<source lang="php">

<syntaxhighlight lang="php">

// Call trigger

// Call trigger

$result = $this->call_trigger('CODE_TRIGGER', $user);

$result = $this->call_trigger('XXXXX_YYYYY', $user);

if ($result <0) $error++;

if ($result <0) $error++;

// End call triggers

// End call triggers

</source>

</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:

<source lang="php">

<syntaxhighlight lang="php">

function run_trigger($action,$object,$user,$lang,$conf)

function run_trigger($action,$object,$user,$lang,$conf)

{

{

       ...

       ...

}

}

</source>

</syntaxhighlight>

 

 

 

=Conclusion=

=Conclusion=