Dies ist eine alte Version des Dokuments!


In der statischen Klasse addon_utils befinden sich Hilfsfunktionen.

Statische Methoden

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.

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

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.

Syntax

string get_memory_limit()

Beschreibung

Gibt das Speicherlimit des Servers zurück.

Syntax

mixed get_option($option)

Beschreibung

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

Syntax

array get_options()

Beschreibung

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

Syntax

mixed include_file(string $path)

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.

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

Syntax

boolean run_job(Addon_Job $job, array $params)

Beschreibung

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

Syntax

boolean set_option(string $option, mixed $value)

Beschreibung

Speichert den Wert $value in der Option $option.