System von Hooks: Difference between revisions

==Einführung==

Hooks sind eine Funktion für Entwickler, die es ihnen ermöglicht, benutzerdefinierten Code zu Standard-Dolibarr-Seiten hinzuzufügen, ohne Dolibarr-Kerndateien ändern zu müssen. Im Gegensatz zum System of Triggers (eine andere Möglichkeit, mit Dolibarr-Code zu interagieren), die mit Dolibarr-Ereignissen verknüpft sind, können Hooks überall und jederzeit ausgeführt werden, solange sie im Dolibarr-Kern geplant wurden. Dies sind Einfügepunkte im Programm.

suchen Sie nach '''" initHooks( "'''

suchen Sie nach '''" executeHooks( "'''.

1- Initialisieren Sie das HookManager-Objekt (platzieren Sie dieses Codestück am Anfang Ihres PHP-Skripts, direkt nach oder vor den Includes):

// Technisches Objekt initialisieren, um Hooks von Drittanbietern zu verwalten. Beachten Sie, dass '''conf->hooks_modules''' das Array array  

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

$hookmanager->initHooks() akzeptiert 1 Parameter (ein Array von Kontexten) und aktiviert die Hook-Unterstützung für dieses Skript:

Hinweis: Sie können mehrere Kontexte gleichzeitig festlegen (z. B. wenn Sie einen gemeinsamen Kontext für mehrere Seiten benötigen, aber auch einen spezifischen Kontext für eine bestimmte Seite wünschen).

2- Platzieren Sie dann den Aufruf der Hooks dort, wo Code hinzugefügt werden soll:

$parameters=array();

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

</source>

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

</source>

1. Fügen Sie Ihr Modul dem Kontext hinzu, in dem der Hook ausgeführt werden soll. Das heißt, wenn man sich in dem gegebenen Kontext befindet, wird Ihr Code aufgerufen. Bearbeiten Sie dazu den Deskriptor Ihres Moduls ('''/htdocs/yourmodulename/core/modules/modYourModuleName.class.php''') und füllen Sie die Variable '''$this->module_parts''' wie im Beispiel :  

$this->module_parts = array(

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

Anmerkung: Sie können den Kontext eines Moduls auch finden, indem Sie Folgendes hinzufügen  

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

</source>

Erstellen Sie '''/htdocs/ yourmodulename /class/actions_ yourmodulename .class.php''' in Ihrem Modul mit Code, der die vom Hook aufgerufene Methode enthält (der Name dieser Methode kann beim Aufruf von executeHooks gesehen werden). Hier ist ein Beispiel:

class  ActionsYourModuleName   

 

Die Methode wird dann automatisch aufgerufen, wenn der Code aufgerufen wird, der die executeHooks enthält, die Ihren Code mit den Elementen $parameters, $object und $action versorgen.

;Mit:

*'''$parameters''' ist ein Array von Metadaten, die die Hook-Daten sammeln (ihr Kontext ist über $parameters['context'] zugänglich, aber andere Informationen können je nach Fall verfügbar sein)

*'''$object''' ist das Objekt, an dem Sie arbeiten möchten (z. B. Produkt für den Produktkartenkontext)

;Rückgaben:

*Der Returncode eines Hooks muss im Erfolgsfall 0 oder 1 sein, im Fehlerfall negativ. Im Allgemeinen wird es 0 sein. Es kann 1 sein, was in einigen Fällen bedeutet, dass das, was Ihr Hook tut, vollständig überschreibt, was Dolibarr tun musste, direkt nachdem der Hook aufgerufen wurde. Wenn der Code negativ ist, ist es möglich, dem Benutzer eine Fehlermeldung bereitzustellen, indem $this->errors[]='Error message' gesetzt wird.

*Wenn die Methode die Eigenschaft $this->results mit einem Array setzt, dann wird das Array $hookmanager->resArray automatisch mit dem Inhalt dieses Arrays angereichert, der später wiederverwendet werden kann.