185
edits
Changes
o
Line 4:
Line 4:
+
+
Les Hooks permettent aux développeurs d'ajouter du code personnalisé aux pages standard de Dolibarr sans avoir à modifier les fichiers du coeur de Dolibarr. Contrairement aux [[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. Ce sont des points d'entrée dans le programme.
Les Hooks permettent aux développeurs d'ajouter du code personnalisé aux pages standard de Dolibarr sans avoir à modifier les fichiers du coeur de Dolibarr. Contrairement aux [[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. Ce sont des points d'entrée dans le programme.
* Les Hooks agissent selon le contexte (càd le module : par exemple "productcard" pour les produits, "invoicecard" pour les factures...). Pour trouver les Hooks existants faites une recherche pour "'''callHooks('''"
* Les Hooks agissent selon le contexte (càd le module : par exemple "productcard" pour les produits, "invoicecard" pour les factures...). Pour trouver les Hooks existants faites une recherche pour "'''callHooks('''"
+* Les Hooks sont des foncitons qui peuvent être surchargées. Vous décidez si votre code s'ajoute à celui de dolibarr ou s'il le remplace. Pour rechercehr le code qu'il est possible de surcharger faites une recherche pour "'''executeHooks('''"
+
+= Implementation =
+
+Pour utiliser un Hook (donc surcharger une fonction), vous devez d'abord avoir défini un module (voir le wiki sur la création d'un module). Ensuite vous devez suivre les étapes suivantes :
+
+1. Pour ajouter votre module au contexte où me hook doit d'éxécuter
+Ce qui veut dire que lorsqu'on se trouve dans le contexte donné (module dolibarr), votre module sera appelé.
+Pour cela, éditer le descripteur de votre module (/htdocs/includes/modYourModuleName.class.php) et renseignez la variable $this->const comme par exemple (modifiez le code en gras selon votre module)
+
+<source lang="php">
+$this->const = array(
+0=>array(''''MAIN_MODULE_YOURMODULENAME_HOOKS'''', 'chaine', ''''productcard:invoicecard:propalcard'''',
+''''Hooks list for managing printing functions of the CustomFields module'''', 0, 'current', 1)
+);
+</source>
+
+Rappel Note: format d'une déclaration de constante :
+<source lang="php">
+$key=>array($const_name,$type,$value,$description,$visible_on_admin_panel=0,$entity='current',$deleteonunactive=0),
+$key2=>...
+</source>
+où $key being est un entier positif.
+
+'''IMPORTANT''': n'oubliez pas de désactiver puis de réactiver votre module pour que la modification soit prise en compte. Attention le dernier paramètre doit être 1 et no 0 (valeur par défaut) pour écraser une éventuelle valeur précédente.
+
+2. Pour remplacer une fonction existante par la votre (surcharge)
+
+Créez '''/htdocs/''yourmodulename''/class/actions_''yourmodulename''.class.php''' dans votre module avec un code comme celui-ci
+
+<source lang="php">
+class ActionsYourModuleName // extends CommonObject
+{
+ /** Overloading the doActions function : replacing the parent's function with the one below
+ * @param parameters meta datas of the hook (context, etc...)
+ * @param object the object you want to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
+ * @param action current action (if set). Generally create or edit or null
+ * @return void
+ */
+ function doActions($parameters, $object, $action)
+ {
+ print_r($parameters);
+ echo "action: ".$action;
+ print_r($object);
+ if ($parameters->context == 'somecontext')
+ {
+ // do something only for the context 'somecontext'
+ }
+ }
+}
+</source>
+
+Où
+* '''$parameters'''est un tableau (array) de meta-data regroupant les da is an array of meta-data about the datas contained by the hook (eg: the context, always accessible by $parameters->context).
+* '''$object''' is the object that you may work on. Eg: the product if you are in the productcard context.
+* '''$action''' is the action if one is conveyed (generally "create", "edit" or "view").
+
+
+
+--------------
Hooks is a developer feature to allow developer to add personalized code intod Dolibarr core code with no need to patch Dolibarr.
Hooks is a developer feature to allow developer to add personalized code intod Dolibarr core code with no need to patch Dolibarr.
On the contrary to the [[triggers]] (another feature to interact with Dolibarr code) which are by definition linked to a business action, hooks can happen anywhere at anytime, they are an entry point into the program.
On the contrary to the [[triggers]] (another feature to interact with Dolibarr code) which are by definition linked to a business action, hooks can happen anywhere at anytime, they are an entry point into the program.
* Hooks work by context (ie the module, eg: "productcard" for products, "invoicecard" for invoices, etc..). It's easy to find them, just search for "'''callHooks('''"
* Hooks work by context (ie the module, eg: "productcard" for products, "invoicecard" for invoices, etc..). It's easy to find them, just search for "'''callHooks('''"
* Hooks are functions that can be overloaded by your own. You decide if your code is added to standard Dolibarr code or if it replace Dolibarr code. You can find overloadable functions by searching for "'''executeHooks('''"
* Hooks are functions that can be overloaded by your own. You decide if your code is added to standard Dolibarr code or if it replace Dolibarr code. You can find overloadable functions by searching for "'''executeHooks('''"
+
+