31,003
edits
Système de Hooks: Difference between revisions
→Implémenter un Hook
| Line 93: | Line 93: | ||
* @return void | * @return void | ||
*/ | */ | ||
function doActions($parameters, $object, $action) | function doActions($parameters, &$object, &$action) | ||
{ | { | ||
print_r($parameters); | print_r($parameters); | ||
| Line 112: | Line 112: | ||
</source> | </source> | ||
La méthode sera alors automatiquement appelée au moment de l'appel du code qui contient le executeHooks fournissant à votre code les éléments $parameters, $object et $action. | |||
'''Avec''': | |||
* '''$parameters''' est un tableau (array) de meta-data regroupant les données du hook (son contexte accessible par $parameters['context'] mais d'autres information peuvent etre disponible selon le cas) | * '''$parameters''' est un tableau (array) de meta-data regroupant les données du hook (son contexte accessible par $parameters['context'] mais d'autres information peuvent etre disponible selon le cas) | ||
* '''$object''' est l'objet sur lequel vous désirez travailler (par exemple : product pour le contexte productcard) | * '''$object''' est l'objet sur lequel vous désirez travailler (par exemple : product pour le contexte productcard) | ||
* '''$action''' désigne l'action à exécuter (par exemple "create", "edit" or "view"). | * '''$action''' désigne l'action à exécuter (par exemple "create", "edit" or "view"). | ||
'''Retours | '''Retours''': | ||
* Le code retour d'un hook doit 0 ou 1. | * Le code retour d'un hook doit 0 ou 1. | ||
En général, il sera 0. Il peut être 1, ce qui dans certains cas signifie que ce que fait votre hook remplace complètement ce que devait faire Dolibarr juste après l'appel du hook. | En général, il sera 0. Il peut être 1, ce qui dans certains cas signifie que ce que fait votre hook remplace complètement ce que devait faire Dolibarr juste après l'appel du hook. | ||
* Si la méthode positionne la propriété $this->results avec un tableau, alors le tableau $hookmanager->resArray sera automatiquement enrichi avec le contenu de ce tableau, lequel pourra être réutilisé plus tard. | * Si la méthode positionne la propriété $this->results avec un tableau, alors le tableau $hookmanager->resArray sera automatiquement enrichi avec le contenu de ce tableau, lequel pourra être réutilisé plus tard. | ||
* Si la méthode positionne la propriété $this->resprints avec une chaîne, alors cette chaîne sera affiché par le gestionnaire de hook (executeHook), tout de suite à la sortie de votre méthode. | * Si la méthode positionne la propriété $this->resprints avec une chaîne, alors cette chaîne sera affiché par le gestionnaire de hook (executeHook), tout de suite à la sortie de votre méthode. | ||
* Votre hook peut de plus modifier les valeurs de $object et $action. | |||
= Liste des Hooks disponibles dans Dolibarr = | = Liste des Hooks disponibles dans Dolibarr = | ||