IPS_GetConfigurationsFromChildren

 array IPS_GetConfigurationsFromChildren (int $InstanzID) 

Parameterliste

Rückgabewert

Objekt bzw. assoziatives Array mit den Eigenschaften, welche die untergeordneten Instanzen für die Instanz vorgeben. Der Schlüssel ist jeweils der Name der Eigenschaft, der Wert der geforderte Wert. Gibt keine untergeordnete Instanz etwas vor, ist das Ergebnis leer.

Beschreibung

Diese Funktion ist nur für den internen Gebrauch vorgesehen und kann sich jederzeit ohne Ankündigung ändern oder entfallen.

Die Funktion ermittelt für alle untergeordneten Instanzen der Instanz mit der ID InstanzID, also alle Instanzen, welche mit ihr als übergeordnete Instanz verbunden sind, die Konfiguration über IPS_GetConfigurationForParent und fasst diese zu einem Objekt zusammen. Die Verwaltungskonsole nutzt das Ergebnis, um die so vorgegebenen Eigenschaften im Konfigurationsformular der Instanz zu sperren.

Die Funktion ist für den Abruf über die JSON-RPC Schnittstelle vorgesehen, z.B. für die Anzeige in der Konsole. In PHP-Skripten steht sie nicht zur Verfügung – dort kann für jede untergeordnete Instanz IPS_GetConfigurationForParent aufgerufen werden.

Geben mehrere untergeordnete Instanzen dieselbe Eigenschaft mit unterschiedlichen Werten vor, schlägt die Funktion mit "Child nodes provide different configurations" fehl. Liefert eine untergeordnete Instanz kein gültiges JSON bzw. kein JSON-Objekt, schlägt die Funktion mit "Invalid JSON for InstanceID ..." bzw. "JSON is missing object for InstanceID ..." fehl. Existiert die Instanz nicht, schlägt die Funktion mit "Flow for Instance #... does not exist" fehl.

Beispiel

// Konfiguration ermitteln, welche die untergeordneten Instanzen für die Instanz 23456 (z.B. einen Client Socket) vorgeben
$rpc = new JSONRPC("http://user:password@127.0.0.1:3777/api/");
print_r($rpc->IPS_GetConfigurationsFromChildren(23456));

/* liefert z.B.:
Array
(
    [Port] => 21000
)
*/