31,003
edits
Système de Triggers: Difference between revisions
Jump to navigation
Jump to search
m
→Ajouter son code sur un événement métier
PolyglotBot (talk | contribs) m (Updating interlang links (links to translated versions of this page in other languages) triggered by origin English page "Triggers" update.) |
Tag: 2017 source edit |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
<!-- Do NOT edit this section | <!-- Do NOT edit this section | ||
Links below are automatically managed by PolyglotBot | Links below are automatically managed by PolyglotBot | ||
You can edit links on the English source page : | You can edit links on the English source page : Triggers_system --> | ||
[[en: | [[en:Triggers_system]] | ||
[[es:Triggers-acciones]] | [[es:Triggers-acciones]] | ||
[[zh:触发系统]] | [[zh:触发系统]] | ||
| Line 15: | Line 15: | ||
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. | 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. | ||
Notez que les Triggers sont une fonctionnalité pour les développeurs qui est limitée aux événements métiers CRUD (Créer | Notez que les Triggers sont une fonctionnalité pour les développeurs, qui est limitée: | ||
* aux événements métiers CRUD (Créer | Mettre à jour (Update) | Supprimer (Delete)). | |||
* ou au changement du statut principal d'un objet. | |||
Pour les autres cas, il existe une autre fonctionnalité permettant aux développeurs d'injecter du code personnalisé dans une application appelée le [[Système de Hooks]]. Note: Historiquement, l'envoi d'un email génère aussi un appel trigger bien que ne rentrant pas dans le cadre des 2 cas précédents autorisés. | |||
Donc, pour ajouter son propre code qui sera déclenché par trigger, la procédure est la suivante: | Donc, pour ajouter son propre code qui sera déclenché par trigger, la procédure est la suivante: | ||
| Line 21: | Line 25: | ||
1) Copier le fichier modèle '''htdocs/modulebuilder/template/core/triggers/interface_99_modMyModule_MyModuleTriggers.class.php''' sous le nom: | 1) Copier le fichier modèle '''htdocs/modulebuilder/template/core/triggers/interface_99_modMyModule_MyModuleTriggers.class.php''' sous le nom: | ||
*''' | *'''interface_99_''all_Xxx''.class.php''' | ||
ou bien | ou bien | ||
*''' | *'''interface_99_''modMonModule_Xxx''.class.php''' | ||
où ''Xxx'' est une | où ''Xxx'' est une chaîne de votre choix commençant par une majuscule, ''99'' est le numéro de priorité du trigger (''01'' étant le plus prioritaire), ''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. | ||
Il faut laisser ce nouveau fichier dans le même répertoire. | Il faut laisser ce nouveau fichier dans le même répertoire. | ||
Rem: Les valeurs utilisables pour modMonModule sont visibles dans le répertoire | Rem: Les valeurs utilisables pour modMonModule sont visibles dans le répertoire | ||
| Line 36: | Line 40: | ||
''htdocs/core/triggers/interface_99_modFacture_Monworkflow.class.php'' | ''htdocs/core/triggers/interface_99_modFacture_Monworkflow.class.php'' | ||
En créant un fichier nommé comme dans cet exemple, notre nouveau trigger sera déclenché à chaque | 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. | ||
'''Note''': | '''Note''': Il est aussi possible de placer les fichiers triggers dans un sous-dossier d'un module externe. Ex: si le module réside dans htdocs/custom/mymodule/, alors il est possible de placer les triggers dans htdocs/custom/mymodule/core/triggers/. | ||
Mais dans ce cas, le trigger ne sera trouvé que si vous le déclarer dans le fichier descripteur de votre module. Pour cela, ajouter triggers->1 dans le tableau module_parts (ex: '''/monmodule/core/modules/modMonModule.class.php'''): | Mais dans ce cas, le trigger ne sera trouvé que si vous le déclarer dans le fichier descripteur de votre module. Pour cela, ajouter triggers->1 dans le tableau module_parts (ex: '''/monmodule/core/modules/modMonModule.class.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 47: | Line 51: | ||
// 'substitutions' => 0, | // 'substitutions' => 0, | ||
// 'menus' => 0); | // 'menus' => 0); | ||
</ | </syntaxhighlight> | ||
Puis désactiver et réactiver le module. Ceci aura pour effet d'ajouter une ligne dans la [[Table llx_const]] pour indiquer à Dolibarr qu'il faut aussi rechercher les triggers dans le répertoire de votre module '''htdocs/monmodule/core/triggers'''. | Puis désactiver et réactiver le module. Ceci aura pour effet d'ajouter une ligne dans la [[Table llx_const]] pour indiquer à Dolibarr qu'il faut aussi rechercher les triggers dans le répertoire de votre module '''htdocs/monmodule/core/triggers'''. | ||
2) Editer ce fichier '' | 2) Editer ce fichier ''interface_99_modMyModule_MyModuleTriggers.class.php'' afin de renommer la classe ''InterfaceMyModuleTriggers'' par ''InterfaceMonworkflow'' | ||
Ensuite, accéder à la page Accueil-> Infos Systèmes -> Dolibarr -> Triggers. | Ensuite, accéder à la page Accueil-> Infos Systèmes -> Dolibarr -> Triggers. | ||
Votre fichier trigger doit | Votre fichier trigger doit apparaître dans la liste sans erreur indiquant que les opérations précédentes ont été réalisées avec succès. | ||
3) Revenez maintenant à l'édition du fichier trigger afin d'ajouter votre code dans la fonction ''runTrigger''. | 3) Revenez maintenant à l'édition du fichier trigger afin d'ajouter votre code dans la fonction ''runTrigger''. | ||
Cette fonction est appelée à chaque | 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é par un test sur la variable '''$action''': | ||
< | <syntaxhighlight lang="PHP"> | ||
public function runtrigger($action,$object,$user,$langs,$conf) | public function runtrigger($action,$object,$user,$langs,$conf) | ||
{ | { | ||
| Line 78: | Line 82: | ||
... | ... | ||
} | } | ||
</ | </syntaxhighlight> | ||
Vous pouvez faire ce que vous voulez dans cette portion de code du moment que la fonction runTrigger renvoie un code retour sur le principe suivant: | Vous pouvez faire ce que vous voulez dans cette portion de code du moment que la fonction runTrigger renvoie un code retour sur le principe suivant: | ||
| Line 92: | Line 96: | ||
4) Une fois le code réalisé, il n'y a plus qu'à tester, en provoquant | 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 '''runTrigger''' 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). | ||
Ajouter des traces dans un fichier dans la fonction '''runTrigger''' afin de vous assurer que le code s'exécute bien. Vous pouvez pour cela si vous le désirer, utiliser la fonction | Ajouter des traces dans un fichier dans la fonction '''runTrigger''' afin de vous assurer que le code s'exécute bien. Vous pouvez pour cela si vous le désirer, utiliser la fonction | ||
dol_syslog("mon texte de trace", LOG_DEBUG); | dol_syslog("mon texte de trace", LOG_DEBUG); | ||
| Line 99: | Line 103: | ||
Voici un vue rapide des événements qui provoquent une recherche et exécution de triggers. Un événement est caractérisés par la valeur du code '''$action''', avec le type de l'objet reçu dans '''$object'''. | Voici un vue rapide des événements qui provoquent une recherche et exécution de triggers. Un événement est caractérisés par la valeur du code '''$action''', avec le type de l'objet reçu dans '''$object'''. | ||
Remarque: Le [[Module Agenda]] et le [[Module Notification | Remarque: Le [[Module Agenda]] et le [[Module Notification FR|Module Notification]] utilise la table [[Table llx c action trigger]] comme liste de triggers connus. Cela évite de scanner le disque pour avoir cette information mais cette table ne contient qu'une liste très limité des triggers. | ||
En général, le code action de trigger commence par le nom du module suivi du caractère _. | En général, le code action de trigger commence par le nom du module suivi du caractère _. | ||
| Line 111: | Line 115: | ||
Pour gérer d'autres événements que ceux ci-dessus, il faut modifier le code Dolibarr pour y ajouter la séquence suivante dans les méthodes métiers des classes des objects manipulés: | Pour gérer d'autres événements que ceux ci-dessus, il faut modifier le code Dolibarr pour y ajouter la séquence suivante dans les méthodes métiers des classes des objects manipulés: | ||
< | <syntaxhighlight lang="PHP"> | ||
// Call trigger | |||
$result=$this->call_trigger('CODE_TRIGGER',$user); | |||
if ($result < 0) $error++; | |||
// End call triggers | |||
</syntaxhighlight> | |||
Pour ajouter des informations de context (par exemple pour dissocier 2 cas différents appelés avec le même code Trigger), il est possible de placer ces informations dans la propriétés ->context de l'object sur lequel porte l'appel du trigger. Exemple: | |||
<syntaxhighlight lang="PHP"> | |||
// Call trigger | // Call trigger | ||
$this->context = array('paramX'=>$valueX, 'anyparamofyourchoice'=>$anyvalue); | |||
$result=$this->call_trigger(' | $result=$this->call_trigger('CODE_TRIGGER',$user); | ||
if ($result < 0) $error++; | if ($result < 0) $error++; | ||
// End call triggers | // End call triggers | ||
</ | </syntaxhighlight> | ||
Il sera alors possible d'ajouter dans la méthode runTrigger de tout fichier trigger, un if qui permet de gérer ce code. La méthode runTrigger serait alors de la forme : | Il sera alors possible d'ajouter dans la méthode runTrigger de tout fichier trigger, un if qui permet de gérer ce code. La méthode runTrigger serait alors de la forme : | ||
< | <syntaxhighlight lang="PHP"> | ||
function run_trigger($action,$object,$user,$lang,$conf) | function run_trigger($action,$object,$user,$lang,$conf) | ||
{ | { | ||
| Line 143: | Line 158: | ||
... | ... | ||
} | } | ||
</ | </syntaxhighlight> | ||
=Conclusion= | =Conclusion= | ||