Utils

In der statischen Klasse addon_utils befinden sich Hilfsfunktionen.

add_prefix

Syntax

string add_prefix(string $word)

Beschreibung

Fügt dem String $word das Add-On-Präfix hinzu. Dieses Präfix wird für den Zugriff auf Add-On-spezifische Felder und Tabellenspalten benötigt.

curl_init

Syntax

resource curl_init(string $url)

Beschreibung

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

disable_webhook

Syntax

void disable_webhook(string $webhook_name)

Beschreibung

Ab v4.8. Deaktiviert sämtliche - durch dieses Addon 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 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');

enable_webhook

Syntax

void enable_webhook(string $webhook_name)

Beschreibung

Ab v4.8. Aktiviert einen Webhook, welcher mit der Funktion disable_webhook() deaktiviert wurde.

Beispiel


addon_utils::enable_webhook('contact_before_save');

file_get_contents

Syntax

string file_get_contents(string $path)

Beschreibung Lädt den Inhalt einer Datei als String. 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');

file_put_contents

Syntax

int file_put_contents(string $path, string $content)

Beschreibung 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');

get_cache

Syntax

mixed get_cache(string $key)

Beschreibung

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

get_lang

Syntax

string get_lang($langvar)

Beschreibung

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 $langvar zurückgegeben.

get_memory_limit

Syntax

string get_memory_limit()

Beschreibung

Gibt das Speicherlimit des Servers zurück.

get_option

Syntax

mixed get_option($option)

Beschreibung

Gibt den Wert zurück, der in der Add-On-Administration als $option gespeichert wurde.

get_options

Syntax

array get_options()

Beschreibung

Gibt alle Werte zurück, der in der Add-On-Administration zu dem Add-On gespeichert wurden.

get_session

Syntax

mixed get_session(string $key)

Beschreibung

(Ab v4.10.33072) Liefert 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.

include_file

Syntax

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

Beschreibung Inkludiert eine Datei, ähnlich wie PHPs include. 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 inkludiert, wenn sie bereits inkludiert wurde.

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

run_job

Syntax

boolean run_job(Addon_Job $job, array $params)

Beschreibung

Startet den Addon-Job $job mit den Parameter $params.

set_cache

Syntax

boolean set_cache(string $key, mixed $value)

Beschreibung

Ab V4.7. Schreibt den Wert von $value unter dem Key $key in den Cache.

set_option

Syntax

boolean set_option(string $option, mixed $value)

Beschreibung

Speichert den Wert $value in der Option $option.

set_session

Syntax

bool set_session(string $key, mixed $value)

Beschreibung

(Ab v4.10.33072) 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.