15
edits
Système de Hooks: Difference between revisions
Jump to navigation
Jump to search
syntaxe
m (orthographe, syntaxe...) |
(syntaxe) |
||
| Line 141: | Line 141: | ||
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. | 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''': | '''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"). | ||
*'''$hookmanager''' n'est propagé que pour permettre à votre hook d'appeler d'autres hooks. | *'''$hookmanager''' n'est propagé que pour permettre à votre hook d'appeler d'autres hooks.<br /> | ||
'''Retours''': | '''Retours de fonction''' : | ||
*Le code retour d'un hook doit être 0 ou 1 en cas de succès, négatif en cas d'erreur. 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 le code est négatif, il est possible de fournir un message d'erreur à l'utilisateur en positionnant $this->errors[]='Message erreur' | *Le code retour d'un hook doit être 0 ou 1 en cas de succès, négatif en cas d'erreur. 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 le code est négatif, il est possible de fournir un message d'erreur à l'utilisateur en positionnant $this->errors[]='Message erreur' | ||