Referenz

Alle Klassen, die im Add-On verwendet werden, müssen im Namespace "addon" liegen. Die Klasse crmapi befindet sich im globalen Namespace. Sie erreichen diese über "\crmapi".

Für die Entwicklung eigener Add-Ons und die Benutzung der API können Sie unsere Klassenbibliotheken benutzen. In dem Archiv befindet sich die addon_lib.php mit allen Klassen und Methoden des Add-On-Frameworks sowie die api_lib.php mit allen Klassen und Methoden der API.

request

Syntax:

protected $request = array()

Beschreibung

Über dieses Array kann auf alle Request-Parameter zugegriffen werden, die beim Aufruf der Add-On-Klasse gesetzt wurden.

init

Syntax:

void init()

Beschreibung

Die init()-Methode kann genutzt werden, um initiale Werte des Objektes zu setzen. Sie muss aber nicht implementiert werden.


add_prefix

Syntax

string add_prefix($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.


get_option

Syntax

mixed get_option($option)

Beschreibung

Gibt den Wert zurück, der in der Add-On-Administration als $option gespeichert 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.


set_option

Syntax

boolean set_option($option, $value)

Beschreibung

Setzt einen Wert, der in der Add-On-Administration als $option definiert ist.


Soll ihr Add-On mehrsprachig sein, müssen Sprachdateien definiert werden. Diese werden im Add-On-XML festgelegt.

Die Sprachdatei selbst ist eine PHP-Datei, die das Array $lang enthält.

Beispiel:

<?php
    $lang['add_booking'] = 'Neue Buchung';
?>

Der Key, der im Add-On verwendet wird, ist add_booking.