Système de Hooks: Difference between revisions

Jump to navigation Jump to search
m
Meilleure traduction du mot hook, capitaine
Tag: 2017 source edit
m (Meilleure traduction du mot hook, capitaine)
Line 12: Line 12:


=Introduction=
=Introduction=
Les Hooks (hameçon en anglais) sont une fonctionnalité destinée aux développeurs, leur permettant d'ajouter du code personnalisé aux pages standards de Dolibarr sans avoir à modifier le ''core'' de Dolibarr. Contrairement au [[Système de Triggers]] (autre manière d'interagir avec le code de Dolibarr) qui sont liés aux événements de Dolibarr, les Hooks peuvent s'exécuter n'importe où et à n'importe quel moment dès lors qu'ils ont été prévus dans le ''core'' de Dolibarr. Ce sont des points d'insertion dans le programme.
Les Hooks (crochet en anglais, dans le sens de détour) sont une fonctionnalité destinée aux développeurs, leur permettant d'ajouter du code personnalisé aux pages standards de Dolibarr sans avoir à modifier le ''core'' de Dolibarr. Contrairement au [[Système de Triggers]] (autre manière d'interagir avec le code de Dolibarr) qui sont liés aux événements de Dolibarr, les Hooks peuvent s'exécuter n'importe où et à n'importe quel moment dès lors qu'ils ont été prévus dans le ''core'' de Dolibarr. Ce sont des points d'insertion dans le programme.


*Les Hooks sont actifs ou pas selon un contexte (souvent un contexte par module : par exemple "productcard" pour les produits, "invoicecard" pour les factures...). Pour trouver les Hooks existants faites une recherche pour "'''initHooks('''"
*Les Hooks sont actifs ou pas selon un contexte (souvent un contexte par module : par exemple "productcard" pour les produits, "invoicecard" pour les factures...). Pour trouver les Hooks existants faites une recherche pour "'''initHooks('''"
Line 18: Line 18:


=Ajouter un hook pour permettre l'insertion de code=
=Ajouter un hook pour permettre l'insertion de code=
Pour implémenter un hook dans votre propre module (afin que votre module puisse être "hameçonné" par d'autres), vous devrez procéder en 2 étapes.
Pour implémenter un hook dans votre propre module (afin que votre module puisse être "crocheté", "détourné" par d'autres), vous devrez procéder en 2 étapes.


Ces étapes doivent êtres reproduites pour chaque script php de votre module où vous voulez implémenter des hooks.
Ces étapes doivent êtres reproduites pour chaque script php de votre module où vous voulez implémenter des hooks.
Line 71: Line 71:
Note: Vous devrez refaire cette étape plusieurs fois si vous voulez ajouter plusieurs hooks à différent endroits de votre script.
Note: Vous devrez refaire cette étape plusieurs fois si vous voulez ajouter plusieurs hooks à différent endroits de votre script.


Maintenant votre module devrait pouvoir être "hameçonné". Vous pouvez à présent suivre la procédure ci-dessous ( '''Implémenter un hook''' ) pour construire une fonction qui se raccrochera au hook  (permet aussi de tester que cela fonctionne).
Maintenant votre module devrait pouvoir exécuté des hooks d'autres origines. Vous pouvez à présent suivre la procédure ci-dessous ( '''Implémenter un hook''' ) pour construire une fonction qui se raccrochera au hook  (permet aussi de tester que cela fonctionne).


=Implémenter un Hook=
=Implémenter un Hook=
7

edits

Navigation menu