Hooks system: Difference between revisions

For a page, put this in the beginning of the page (after the include of the main):

// 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 activates the hooks management for this script. '<nowiki/>'''context'''' is a context string. This is simply a indicator that hooking functions can use, to detect in which context they are called. Note that the context 'all' is always valid.

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 dedicated to your page).

global $hookmanager;

2- Place hooks where you want to allow external code:

$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, usually the current module's data (eg: the 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.

Edit your '''/htdocs/''yourmodulename''/core/modules/mod''YourModuleName''.class.php''' and add the context name to the variable '''$this->module_parts'''.

eg:

$this->module_parts = array(

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

);

Don't forget to change YourModuleName to your own module's name!

Note: one way to determine the name of contexts you are when you reach a part of code is to add this code in the PHP code:

print('Module context: '.join(',', $object->contextarray));

Note that the '''all''' context means you want your hook beeing executed whatever is the context. The '''main''' means you want your hook to be executed for any web page, and '''cli''' means in every Command Line script (even if you can't see this context keys in $object->contextarray).

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 the program executes the module/context and you will see the parameters and object and action.