IPS_GetVisualizationTile

 string IPS_GetVisualizationTile (int $InstanzID) 

Parameterliste

Rückgabewert

Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis den HTML-Inhalt der individuellen Darstellung der Instanz. Hat die Instanz keine individuelle Darstellung, kann der String leer sein.

Beschreibung

Die Funktion gibt den HTML-Inhalt der individuellen Darstellung der Instanz mit der ID InstanzID zurück, wie ihn die Kachel-Visualisierung für die Kachel der Instanz anzeigt.

Module stellen diesen Inhalt über das HTML-SDK bereit, indem sie die Modulfunktion GetVisualizationTile überschreiben. IPS_GetVisualizationTile ruft diese Funktion für die angegebene Instanz auf. Bei PHP-Modulen wird dem Rückgabewert ein <script>-Block vorangestellt, der die JavaScript-Funktionen des HTML-SDK sowie die Übersetzungen aus der locale.json des Moduls enthält. Dieser Block ist auch vorhanden, wenn das Modul GetVisualizationTile nicht überschreibt. Bei den in IP-Symcon eingebauten Modulen liefert die Funktion einen leeren String.

Folgende Fehler sind möglich:

• Existiert die Instanz nicht, schlägt die Funktion mit "Instance #... does not exist" fehl.
• Liegt InstanzID außerhalb des gültigen Bereichs, schlägt sie mit "Parameter for InstanceID is not inside of the specified bounds (0..…)" fehl.
• Konnte die Instanz nicht geladen werden, z.B. weil das zugehörige Modul nicht verfügbar ist, schlägt sie mit "InstanceInterface is not available" fehl.

Beispiel

// Liest die individuelle Darstellung der Instanz 12345 aus und speichert sie als HTML-Datei
$html = IPS_GetVisualizationTile(12345);
if ($html === '') {
    echo "Die Instanz hat keine individuelle Darstellung";
} else {
    file_put_contents(IPS_GetKernelDir() . 'tile.html', $html);
    echo strlen($html) . " Bytes gespeichert";
}