钩子系统: Difference between revisions

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:

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):

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.

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.