Interfaces Dolibarr toward foreign systems: Difference between revisions

Jump to navigation Jump to search

Interfaces Dolibarr toward foreign systems (view source)

Revision as of 18:52, 31 March 2010

318 bytes removed ,  16 years ago
m
→‎Execute your own code on a Dolibarr event
VisualWikitext
Line 5: Line 5:
{{ToTranslate}}
{{ToTranslate}}


Pour permettre de déclencher du code personnalisé en réaction à un évènement Dolibarr (création/modification/suppression d'une société/facture/produit/utilisateur ou autre), Dolibarr propose un mécanisme de triggers métiers. Ce mécanisme vous permet de personnaliser un workflow afin que les évènements de gestion Dolibarr soient répercutés dans une autre application par exemple.
To execute personalized code after a Dolibarr event (create/modify/remove a third party/invoice/product or other), Dolibarr offers a mecanism of business triggers. This mecanism allows you to personalize a workflow to have Dolibarr business events being synchronized into another application for example.
Rien n'empêche également de l'utiliser pour modifier le comportement de Dolibarr même: par exemple, pour que la validation d'une facture provoque la création d'un contrat automatiquement.
You can also use triggers to modify the behaviour of Dolibarr itself: for example, to create automatically a contract when an invoice is validated.


Donc, pour ajouter son propre code qui sera déclenché par trigger, la procédure est la suivante:
So, to add your own code that will be triggered by a Dolibarr trigger, this is the way to process:




1) Copier le fichier '''htdocs/includes/triggers/interface_all_Demo.class.php''' sous le nom:
1) Copy file '''htdocs/includes/triggers/interface_all_Demo.class.php''' under the new name:
* '''interface_all_''Xxx''.class.php'''
* '''interface_all_''Xxx''.class.php'''
ou bien
or
* '''interface_mod''MonModule_Xxx''.class.php'''
* '''interface_mod''MyModule_Xxx''.class.php'''
où ''Xxx'' est une chaine de votre choix commençant par une majuscule et ''MonModule'' est le nom du module si votre trigger ne doit être activé que si le module MonModule est actif. Si on désire que le trigger soit toujours actif, on mettra ''all'' à la place de modMonModule.
where ''Xxx'' is a string of your choice startint with uppercase character and ''MyModule'' is the name of a module if you want that trigger is activated only if module MyModyle is activated. If you want the trigger to be always active, use ''all'' instead of  modMyModule.
Il faut laisser ce nouveau fichier dans le même répertoire.
This new file must be saved inside same directory.
Rem: Les valeurs à utiliser pour modMonModule sont visibles dans le répertoire
Note: Value you can use for modMyModule are values found in directory
''htdocs/includes/modules''.
''htdocs/includes/modules''.


Par exemple, on pourra nommer notre nouveau trigger:  
For example, you can name your new trigger file:  
''htdocs/includes/triggers/interface_modFacture_Monworkflow.class.php''
''htdocs/includes/triggers/interface_modFacture_Myworkflow.class.php''


En créant un fichier nommé comme dans cet exemple, notre nouveau trigger sera déclenché à chaque évènement métier Dolibarr et à condition que le module Facture soit actif.
By creating such a file with name as in the example, your new trigger file will be executed each time a Dolibarr business event occurs but only if the module Facture is enabled.




2) Editer ce fichier ''interface_modMonModule_Monworkflow.class.php'' afin de renommer la classe ''InterfaceDemo'' par ''InterfaceMonworkflow''
2) Edit the file ''interface_modMyModule_Myworkflow.class.php'' to rename class ''InterfaceDemo'' by ''InterfaceMyworkflow''




Ensuite, accéder à la page Accueil-> Infos Systèmes -> Dolibarr -> Triggers.
Then go on page Home-> System Infos -> Dolibarr -> Triggers.
Votre fichier trigger doit apparaitre dans la liste sans erreur indiquant que les opérations précédentes ont été réalisées avec succès.
Your new trigger file must appears in the list without any error message. This means preceding actions have been done successfully.




3) Revenez maintenant à l'édition du fichier trigger afin d'ajouter votre code dans la fonction ''run_trigger''.
3) Return now to edition of file to add your own code inside function  ''run_trigger''.
Cette fonction est appelée à chaque évènement Dolibarr. Placer votre code en fonction du ou des évènements sur lesquels vous voulez réagir, chaque évènement étant identifié par un code (voir chapitres suivant pour la liste des codes), on peut réagir ou non à un évènement donnée par un test sur la 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">
<source lang="php">
   function run_trigger($action,$object,$user,$lang,$conf)
   function run_trigger($action,$object,$user,$lang,$conf)
   {
   {
         // Mettre ici le code à exécuter en réaction de l'action
         // Put here code to execute after an action
         // Le type de l'évènement Dolibarr est stocké dans $action
         // The type of Dolibarr business event is stored into $action
         // Les données de l'action sont stockées dans $object
         // Data of action are stored into object $object
         // La configuration, utilisateur et langage sont dans $conf,$user et $lang
         // Setup, user and language are saved into $conf, $user and $lang
         if ($action == 'COMPANY_CREATE')
         if ($action == 'COMPANY_CREATE')
         {
         {
Line 56: Line 56:
</source>
</source>


Vous pouvez faire ce que vous voulez dans cette portion de code du moment que la fonction run_trigger renvoi un code retour sur le principe suivant:
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:


<0 si ko, 0 si aucune action faite, >0 si ok
<0 if KO, 0 if nothing is done, >0 if OK


Vous pouvez de plus dans cette fonction utiliser les objets suivant:
You can also use in this function the preinitialized following variables:
* '''$object''' est l'objet sur lequel porte l'action (voir chapitre suivant)
* '''$object''' is the object on which action is done (see next chapter)
* '''$user''' est l'objet de l'utilisateur Dolibarr qui réalise l'action
* '''$user''' is the object containg all information of Dolibarr user that realizes the business event.
* '''$langs''' est l'objet qui contient la langue de l'utilisateur Dolibarr
* '''$langs''' is the object that contains the user language and translations strings
* '''$conf''' est l'objet qui contient toute la configuration de Dolibarr.
* '''$conf''' is the object that contains all the Dolibarr configuration.


4) Une fois le code réalisé, il n'y a plus qu'à tester, en provoquant l'évènement déclencheur dans Dolibarr. Attention, l'appel au '''run_trigger''' et encapsuler dans un transaction. Si votre trigger renvoie un code ko, la fonction appelante peut annuler la transaction (ceci dépend de la fonction appelante).
4) Une fois le code réalisé, il n'y a plus qu'à tester, en provoquant l'évènement déclencheur dans Dolibarr. Attention, l'appel au '''run_trigger''' et encapsuler dans un transaction. Si votre trigger renvoie un code ko, la fonction appelante peut annuler la transaction (ceci dépend de la fonction appelante).
Retrieved from "https://wiki.dolibarr.org/index.php/Special:MobileDiff/18923"

Navigation menu