Système de Hooks - Revision history

Kusco: Correction de la syntaxe déclarative.

2025-08-25T08:42:26Z

Correction de la syntaxe déclarative.

← Older revision		Revision as of 08:42, 25 August 2025
Line 81:		Line 81:
	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
	$this->module_parts = array(		$this->module_parts = array(
	'hooks' => array('hookcontext1','hookcontext2') ~~// Set here all hooks context you want to support~~		'hooks' => array(
			'data' => array(
			'hookcontext1',
			'hookcontext2',
			),
			'entity' => '0',
			),
	);		);
	</syntaxhighlight>		</syntaxhighlight>

PolyglotBot: Updating interlang links (links to translated versions of this page in other languages) triggered by origin English page "Hooks_system" update.

2025-07-22T15:12:00Z

Updating interlang links (links to translated versions of this page in other languages) triggered by origin English page "Hooks_system" update.

← Older revision		Revision as of 15:12, 22 July 2025
Line 5:		Line 5:
	[[en:Hooks_system]]		[[en:Hooks_system]]
	[[es:El_sistema_Hooks]]		[[es:El_sistema_Hooks]]
	[[de:System_von_Hooks]]		[[de:System_von_Hooks]] ]]
	[[zh:钩子系统]]		[[zh:钩子系统]]
	<!-- END interlang links -->		<!-- END interlang links -->

Eldy: /* Implémenter un Hook */

2025-06-06T16:17:32Z

Implémenter un Hook

← Older revision		Revision as of 16:17, 6 June 2025
Line 74:		Line 74:

	=Implémenter un Hook=		=Implémenter un Hook=
	Pour utiliser un Hook (donc ~~ajouter~~ ou surcharger une partie de code), vous devez d'abord avoir défini un descripteur de module (voir [[Développement_module#Créer_un_descripteur_de_Module_(obligatoire)]] pour cela). Ensuite vous devez suivre les étapes suivantes :		Pour utiliser un Hook (donc insérer ou surcharger une partie de code), vous devez d'abord avoir défini un descripteur de module (voir [[Développement_module#Créer_un_descripteur_de_Module_(obligatoire)]] pour cela). Ensuite vous devez suivre les étapes suivantes :

	1. Ajouter votre module au contexte où le hook doit s'exécuter.		1. Ajouter votre module au contexte où le hook doit s'exécuter.

Eldy: /* Ajouter un hook pour permettre l'insertion de code */

2025-06-06T16:14:00Z

Ajouter un hook pour permettre l'insertion de code

← Older revision		Revision as of 16:14, 6 June 2025
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 "crocheté", "détourné" par d'autres), vous devrez procéder en 2 étapes.		Pour implémenter un hook dans Dolibarr ou 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 dans lequel vous voulez implémenter des hooks.


Line 44:		Line 44:
	</syntaxhighlight>		</syntaxhighlight>

	2- Placer ensuite l'appel des hooks là où l'~~ajout~~ de code est ~~désiré~~ :		2- Placer ensuite l'appel des hooks là où la possibilité d'insertion de code est désirée :

	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">

Arano: Meilleure traduction du mot hook, capitaine

2024-04-28T14:15:14Z

Meilleure traduction du mot hook, capitaine

← Older revision		Revision as of 14:15, 28 April 2024
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=

Eldy: /* Implémenter un Hook */

2024-01-26T00:40:39Z

Implémenter un Hook

← Older revision		Revision as of 00:40, 26 January 2024
Line 87:		Line 87:
	Note: il est possible de trouver tous les contextes dans lequel vous êtes au sein d'une portion de code PHP en faisant		Note: il est possible de trouver tous les contextes dans lequel vous êtes au sein d'une portion de code PHP en faisant
	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
	print('Module context: '.join(',', $object->~~context~~));		print('Module context: '.join(',', $object->contextarray));
	</syntaxhighlight>		</syntaxhighlight>
	(rajoutez ce bout de code dans le fichier PHP où réside l'appel des hooks, et supprimez le, une fois la valeur des contextes relevée).		(rajoutez ce bout de code dans le fichier PHP où réside l'appel des hooks, et supprimez le, une fois la valeur des contextes relevée).

Eldy at 00:40, 26 January 2024

2024-01-26T00:40:00Z

← Older revision		Revision as of 00:40, 26 January 2024
Line 5:		Line 5:
	[[en:Hooks_system]]		[[en:Hooks_system]]
	[[es:El_sistema_Hooks]]		[[es:El_sistema_Hooks]]
	[[de:System_von_Hooks]] ]]		[[de:System_von_Hooks]]
	[[zh:钩子系统]]		[[zh:钩子系统]]
	<!-- END interlang links -->		<!-- END interlang links -->
Line 85:		Line 85:
	</syntaxhighlight>		</syntaxhighlight>

	Note: il est possible de trouver ~~le contexte~~ d'~~un module~~ en ~~rajoutant~~		Note: il est possible de trouver tous les contextes dans lequel vous êtes au sein d'une portion de code PHP en faisant
	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
	print('Module context: '.$object->context);		print('Module context: '.join(',', $object->context));
	</syntaxhighlight>		</syntaxhighlight>
	(rajoutez ce bout de code dans le fichier ~~php~~ où réside l'appel des hooks, et supprimez le, une fois la valeur du contexte ~~relevée~~).		(rajoutez ce bout de code dans le fichier PHP où réside l'appel des hooks, et supprimez le, une fois la valeur des contextes relevée).

			Notez que le contexte '''all''' signifie que vous souhaitez que votre hook soit exécuté quel que soit le contexte. Le '''main''' signifie que vous voulez que votre hook soit exécuté pour n'importe quelle page Web, et '''cli''' signifie dans chaque script de ligne de commande (même si vous ne pouvez pas voir ces clés de contexte dans $object->contextarray).

	[[File:warning.png]] Attention: N'oubliez pas de désactiver puis de réactiver votre module dans l'interface d'administration des modules (ou directement dans le "constructeur de module") afin que la modification soit prise en compte, car l'enregistrement qui relie les éléments du couple "module-hook" est géré en base de donnée; celle-ci n'étant mise à jour qu'au moment de la (ré)activation du module.		[[File:warning.png]] Attention: N'oubliez pas de désactiver puis de réactiver votre module dans l'interface d'administration des modules (ou directement dans le "constructeur de module") afin que la modification soit prise en compte, car l'enregistrement qui relie les éléments du couple "module-hook" est géré en base de donnée; celle-ci n'étant mise à jour qu'au moment de la (ré)activation du module.

PolyglotBot: Updating interlang links (links to translated versions of this page in other languages) triggered by origin English page "Hooks_system" update.

2024-01-26T00:27:23Z

Updating interlang links (links to translated versions of this page in other languages) triggered by origin English page "Hooks_system" update.

← Older revision		Revision as of 00:27, 26 January 2024
Line 5:		Line 5:
	[[en:Hooks_system]]		[[en:Hooks_system]]
	[[es:El_sistema_Hooks]]		[[es:El_sistema_Hooks]]
	[[de:System_von_Hooks]]		[[de:System_von_Hooks]] ]]
	[[zh:钩子系统]]		[[zh:钩子系统]]
	<!-- END interlang links -->		<!-- END interlang links -->

Eldy: /* Introduction */

2023-12-12T00:16:19Z

Introduction

← Older revision		Revision as of 00:16, 12 December 2023
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 ou 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 (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 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('''"

Eldy: /* Liste des Contexts disponibles dans Dolibarr */

2023-11-10T14:17:41Z

Liste des Contexts disponibles dans Dolibarr

← Older revision		Revision as of 14:17, 10 November 2023
Line 165:		Line 165:


	=Liste des ~~Contexts~~ disponibles dans Dolibarr=		=Liste des Contextes disponibles dans Dolibarr=
	Pour trouver les contextes disponibles dans Dolibarr, la procédure est similaire aux hooks.		Pour trouver les contextes disponibles dans Dolibarr, la procédure est similaire aux hooks.
	Faites une recherche sur "'''initHooks('''" dans le code source et vous trouverez facilement tous les contextes déjà implémentées.		Faites une recherche sur "'''initHooks('''" dans le code source et vous trouverez facilement tous les contextes déjà implémentées.