Page tree
Skip to end of metadata
Go to start of metadata

In der statischen Klasse addon_utils befinden sich Hilfsfunktionen.

1. Statische Methoden

1.1. add_prefix

Syntax:

string add_prefix( string $word )

Beschreibung:

Diese Methode fügt der Zeichenkette $word das Add-on-Präfix hinzu. Dieses Präfix wird für den Zugriff auf Add-on-spezifische Felder und Tabellenspalten benötigt.

1.2. curl_init

Syntax:

resource curl_init( string $url )

Beschreibung

Diese Methode erzeugt einen cURL-Handler. Mit diesem können externe URLs aufgerufen werden. Siehe auch http://www.php.net/manual/de/function.curl-init.php

1.3. disable_webhook

Syntax:

void disable_webhook( string $webhook_name )

Beschreibung:

Ab v4.8. deaktiviert diese Methode sämtliche, durch dieses Add-on definierte, Webhooks des gegebenen Typen $webhook_name für die Lautzeit des aktuellen Prozesses. Die Deaktivierung wirkt sich auch auf die Ausführung von Webhooks durch andere Webhooks aus, wenn beispielsweise die Änderung eines Kontaktes, die Änderung eines Tickets anstößt.

Der Webhook lässt sich anschließend wieder mit der Funktion enable_webhook() reaktivieren, sodass dieser während des Prozesses wieder ausgeführt wird.

Wichtig: Da asynchrone Webhooks einen neuen Prozess starten, müssen deaktivierte Webhooks erneut innerhalb des Prozesses gesetzt werden.

Beispiel:

addon_utils::disable_webhook('contact_before_save');

1.4. enable_webhook

Syntax:

void enable_webhook( string $webhook_name )

Beschreibung:

Ab v4.8. Diese Methode aktiviert einen Webhook, der mit der Funktion disable_webhook() deaktiviert wurde.

Beispiel:

addon_utils::enable_webhook('contact_before_save');

1.5. file_get_contents

Syntax:

string file_get_contents( string $path )

Beschreibung: 

Diese Methode lädt den Inhalt einer Datei als Zeichenkette. Es kann nur auf Dateien innerhalb des Add-ons zugegriffen werden. Zugriff auf Dateien außerhalb des Add-ons ist nicht möglich.

Beispiel:

$content = addon_utils::file_get_contents('resources/test.txt');

1.6. file_put_contents

Syntax:

int file_put_contents( string $path, string $content )

Beschreibung: 

Diese Methode speichert $content als Inhalt der Datei $path. Es können nur Dateien innerhalb des Add-ons geschrieben werden. Zugriff auf Dateien außerhalb des Add-ons ist nicht möglich.

Beispiel:

$result = addon_utils::file_put_contents('resources/test.txt', 'MeinInhalt');

Syntax:

bool file_unlink(string $path)

Beschreibung: 

(Ab v5.0.75) löscht diese Methode die Datei $path. Es können nur Dateien innerhalb des Add-ons gelöscht werden. Zugriff auf Dateien außerhalb des Add-ons ist nicht möglich.

Beispiel:

$result = addon_utils::file_unlink('resources/test.txt');

1.8. get_cache

Syntax:

mixed get_cache( string $key )

Beschreibung:

Ab V4.7. gibt diese Methode den Wert zurück, der im Cache unter dem Schlüssel $key abgelegt wurde.

1.9. get_crm_url

Syntax:

string get_crm_url()

Beschreibung:

Ab v5.1.1 Gibt die vom Browser aufrufbare URL des CRM-Systems zurück.

1.10. get_lang

Syntax:

string get_lang( $langvar )

Beschreibung:

Diese Methode gibt die Übersetzung der Sprachvariable $langvar zurück. Wenn die Übersetzung im Add-on definiert ist, wird diese verwendet. Ist sie dort nicht definiert, wird die entsprechende CRM-Sprachvariable zurückgegeben. Existiert diese nicht, wird der Wert von $langvar zurückgegeben.

1.11. get_memory_limit

Syntax:

string get_memory_limit()

Beschreibung:

Diese Methode gibt das Speicherlimit des Servers zurück.

1.12. get_option

Syntax:

mixed get_option( $option )

Beschreibung:

Diese Methode gibt den Wert zurück, der in der Add-on-Administration als $option gespeichert wurde.

1.13. get_options

Syntax:

array get_options()

Beschreibung:

Diese Methode gibt alle Werte zurück, die in der Add-on-Administration zu dem Add-on gespeichert wurden.

1.14. get_session

Syntax:

mixed get_session( string $key )

Beschreibung:

(Ab v4.10.33072) liefert diese Methode einen Wert aus dem Session-Storage zurück. Im Fehlerfall oder wenn der Wert nicht vorhanden, ist wird NULL zurückgeliefert. Die Daten des Session-Storage bleiben bis zur Beendigung der Session gültig.

1.15. include_file

Syntax:

mixed include_file( string $path, bool $once = false )

Beschreibung:

Diese Methode bindet eine Datei, ähnlich wie PHP include ein. Die einzubindende Datei muss im Add-on enthalten sein. Zugriff auf Dateien außerhalb des Add-ons ist nicht möglich. Wird $once auf TRUE gesetzt, wird die Datei nicht noch einmal eingebunden.

Beispiel:

addon_utils::include_file('lib/functions.php');
//Now there is a function called my_function();
 
/* 
  * Content of companies.php:
  * <?php
  * return array('company1', 'company2');
  * ?>
  */
$test = addon_utils::include_file('lib/companies.php');
// Now $test contains the array defined in companies.php

1.16. log_error

Syntax:

void log_error(mixed $object, string $file = "errors")

Beschreibung:

Diese Methode schreibt einen Eintrag in eine Add-on-spezifische Log-Datei. Die Datei hat den Namen addon_{prefix}_{file}.log.

Beispiel:

//the addon name is testadd
addon_utils::log_error('an error string');//writes 'an error string' to addon_testadd_errors.log
addon_utils::log_error('a special string', 'special');//writes 'a special string' to addon_testadd_special.log

1.17. run_job

Syntax:

boolean run_job( Addon_Job $job, array $params )

Beschreibung:

Diese Methode startet den Add-on-Job $job mit den Parametern $params.

1.18. set_cache

Syntax:

boolean set_cache( string $key, mixed $value )

Beschreibung:

Ab V4.7. schreibt diese Methode den Wert von $value unter dem Schlüssel $key in den Cache.

1.19. set_option

Syntax:

boolean set_option( string $option, mixed $value )

Beschreibung:

Diese Methode speichert den Wert $value in der Einstellung $option.

1.20. set_session

Syntax:

boolean set_session( string $key, mixed $value )

Beschreibung:

(Ab v4.10.33072) diese Methode fügt einen Wert zum Session-Storage hinzu. Im Fehlerfall liefert die Funktion FALSE zurück. Die Daten des Session-Storage bleiben bis zur Beendigung der Session gültig.

  • No labels