Système de Hooks: Difference between revisions

Jump to navigation Jump to search

Système de Hooks (view source)

Revision as of 13:10, 12 December 2011

3,835 bytes removed ,  14 years ago
no edit summary
VisualWikitext
(o)
No edit summary
Line 60: Line 60:


Où
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).
* '''$parameters'''est un tableau (array) de meta-data regroupant les données du hook (son contexte accessible par $parameters->context)
* '''$object''' is the object that you may work on. Eg: the product if you are in the productcard context.
* '''$object''' est l'objet sur lequel vous désuirez travailler (par exemple : product pour le contexte productcard)
* '''$action''' is the action if one is conveyed (generally "create", "edit" or "view").
* '''$action''' désigne l'action à exécuter (par exemple "create", "edit" or "view").


 
= Liste des Hooks disponibles =
 
--------------
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.
* 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('''"
 
 
 
= Implementation =
 
To use a hook (overload a function), you first need to already have defined a module (see the wiki for that), and then you need to do 2 things:
 
1- to add your module to the hooks of the context you want to hook on.
This means that when this context (module) will happen, your module will be called.
To do that, just edit your /htdocs/includes/modYourModuleName.class.php and edit the $this->const variable with something like this:
 
<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>
Note: format of a const declaration:
<source lang="php">
$key=>array($const_name,$type,$value,$description,$visible_on_admin_panel=0,$entity='current',$deleteonunactive=0),
$key2=>...
</source>
With $key being a positive integer.
 
Of course change YourModuleName with your own module's name.
Don't touch 'chaine' which defines the type of the constant.
Then you get the value at the third index, which is a string with contexts separated by a comma.
 
'''IMPORTANT''': Be careful: do not forget to DISABLE then RENABLE the module in the admin panel to accept the new const values, because these constants are only added to the database when enabling the module. And please note that the const is updated because the last parameter is set to 1 (which represent $deleteonunactive) which by default is set to 0 to preserve the constants even when the module is disabled.
 
 
2- You will overload a hook (a function) with your own.
 
Create a file '''/htdocs/''yourmodulename''/class/actions_''yourmodulename''.class.php''' and then put something like this:
 
<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>
 
where
* '''$parameters''' 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").
 
Your function should now be called when you access the module/context and you will see the parameters and object and action.
 
= List of available Hooks =
{{ToComplete}}
{{ToComplete}}
* '''formObjectOptions''': called everytime fields associated to the main object are printed or inputted (eg: creation form, datasheet, edit form, etc..).
* '''formObjectOptions''': appelé chaque fois qu'un champ associé à l'objet principal est affiché ou modifié (formulaires de création, modification, affichage...)  


How to find the available hooks ?  
Trouver les hooks disponibles ?  
Just search for "'''executeHooks('''" and you should easily find all the hooked methods calls.
Faites une recherche sur  "'''executeHooks('''" et vous trouverez facilement les fonctions déjà implémentées


= See also =
= Voir aussi =
* [[Triggers]]
* [[Triggers]]
* [[Interfaces Dolibarr toward foreign systems]]
* [[Interfaces Dolibarr toward foreign systems]]
* [[Interfaces from foreign systems toward Dolibarr]]
* [[Interfaces from foreign systems toward Dolibarr]]
Retrieved from "https://wiki.dolibarr.org/index.php/Special:MobileDiff/24243"

Navigation menu