钩子系统: Difference between revisions

{{TemplateMainPageZh}}

要在自己的模块中实现一个钩子（以便其他模块可以“钩住”），你有两个步骤要遵循。

1 -初始化HookManager对象（把它放在脚本的开始，在包含之后）：

// Initialize technical object to manage hooks of thirdparties. Note that conf->hooks_modules contains array array

include_once(DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php');

$hookmanager=new HookManager($db);

$hookmanager->initHooks(array('context'));

$hookmanager->initHooks() takes 1 parameter (an array of contexts) and activate the hooks management for this script:

Note: you can set several contexts in the same init (for example if you want to have a common context into several pages and want also a specific context deidcated to your page).

2- 放置钩子于你想要引入外部代码之处:

$parameters=array();

$reshook=$hookmanager->executeHooks('hookname',$parameters,$object,$action); // See description below

   ... // standard code that can be disabled/replaced by hook if return code > 0.

}

'''$hookmanager->executeHooks()''' takes 4 parameters and add a hook (an entry point in your script for external functions):

- '''$parameters''' is a custom array to send more custom data to the hook (the hooking function can then process it). Place here anything you want, it can be a file, an array of strings, anything...

eg:

$parameters=array('file'=>'my/path/to/a/file', 'customnames'=>array('henry','david','john'));

- '''$object''' is the object you want to pass onto the hooking function, mainly the current module's data (eg: invoice object if it is invoice module, etc..). This can be anything you want, but remember this will be the main component hooking functions will be using.

Now your module should be hookable, and you can follow the procedure below in '''Implement a hook''' to implement a hooking function that will take advantage of your new hooks.

To use a hook (add or replace a part of code), you first need to already have defined a module descriptor (see [[Module_development#Create_your_module_descriptor]]), and then you need to do 2 things:

This means that when a context you hook will happen, your module hook code will be called.

To do that, just edit your '''/htdocs/''yourmodulename''/core/modules/mod''YourModuleName''.class.php''' and edit the '''$this->module_parts''' variable with something like this:

$this->module_parts = array(

'hooks' => array('hookcontext1','hookcontext2')  // Set here all hooks context you want to support

);

Of course change YourModuleName with your own module's name.

Create a file '''/htdocs/''yourmodulename''/class/actions_''yourmodulename''.class.php''' and then put something like this:

class ActionsYourModuleName

{  

}

}  

Your function should now be called when you access the module/context and you will see the parameters and object and action.

'''Where''':

'''Returns''':

How to find a complete list of all available hooks in Dolibarr's nomenclatura ?  

Just search for "'''executeHooks('''" through the whole sourcecode (generally called "find in files") and you should easily find all the hooked methods calls.

Note: please note that this list may change in the future as hooks and contexts are added into Dolibarr, so if you really need to find a specific hooks, please search directly in the sourcecode.

To find the complete list of available modules' context in Dolibarr's nomenclatura, the procedure is similar to finding hooks.

Search for "'''initHooks('''" through the whole sourcecode (generally called "find in files") and you should find all the possible contexts.

Note: please note that this list may change in the future as hooks and contexts are added into Dolibarr, so if you really need to find a specific hooks, please search directly in the sourcecode.