Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
addon:referenz:utils [2017/01/31 14:32]
maik ↷ Links angepasst weil Seiten im Wiki verschoben wurden
addon:referenz:utils [2019/08/27 12:25] (aktuell)
clemens [set_session]
Zeile 1: Zeile 1:
 +====== Utils ======
 In der statischen Klasse //​addon_utils//​ befinden sich Hilfsfunktionen. In der statischen Klasse //​addon_utils//​ befinden sich Hilfsfunktionen.
  
  
-====== Statische Methoden ======+===== Statische Methoden ======
  
  
  
-===== add_prefix =====+==== add_prefix =====
  
  
Zeile 17: Zeile 18:
  
  
 +==== curl_init =====
  
-===== file_get_contents =====+ 
 +**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 - [[installation:​software:​konfiguration#​webhooks|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|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** 
 + 
 +<sxh php> 
 + 
 +addon_utils::​disable_webhook('​contact_before_save'​);​ 
 + 
 +</​sxh>​ 
 + 
 +==== enable_webhook ===== 
 + 
 + 
 +**Syntax** 
 +  void enable_webhook(string $webhook_name) 
 + 
 +**Beschreibung** 
 + 
 +**Ab v4.8**. Aktiviert einen [[installation:​software:​konfiguration#​webhooks|Webhook]],​ welcher mit der Funktion [[#​disable_webhook|disable_webhook()]] deaktiviert wurde. 
 + 
 +**Beispiel** 
 + 
 +<sxh php> 
 + 
 +addon_utils::​enable_webhook('​contact_before_save'​);​ 
 + 
 +</​sxh>​ 
 + 
 + 
 + 
 + 
 +==== file_get_contents =====
  
  
Zeile 34: Zeile 89:
 </​sxh>​ </​sxh>​
  
 +==== file_put_contents =====
  
-===== get_lang =====+ 
 +**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** 
 +<sxh php> 
 + 
 +$result ​addon_utils::​file_put_contents('​resources/​test.txt',​ '​MeinInhalt'​);​ 
 + 
 +</​sxh>​ 
 + 
 + 
 + 
 +==== 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** **Syntax**
Zeile 46: Zeile 128:
  
  
-===== get_memory_limit =====+==== get_memory_limit =====
  
 **Syntax** **Syntax**
Zeile 57: Zeile 139:
  
  
-===== get_option =====+==== get_option =====
  
 **Syntax** **Syntax**
Zeile 68: Zeile 150:
  
  
-===== get_options =====+==== get_options =====
  
 **Syntax** **Syntax**
Zeile 76: Zeile 158:
  
 Gibt alle Werte zurück, der in der Add-On-Administration zu dem Add-On gespeichert wurden. 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 =====+==== include_file =====
  
  
 **Syntax** **Syntax**
-  mixed include_file(string $path)+  mixed include_file(string $path, bool $once = false)
  
 **Beschreibung** **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.+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** **Beispiel**
Zeile 106: Zeile 197:
  
  
-===== run_job =====+==== run_job =====
  
 **Syntax** **Syntax**
Zeile 117: Zeile 208:
  
  
-===== set_option =====+==== 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** **Syntax**
Zeile 126: Zeile 227:
 Speichert den Wert $value in der Option $option. 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.