Dokumentation
IPS_GetModules
array IPS_GetModules (array $ModulIDs)
Parameterliste
| ModulIDs | Array mit den ModulIDs (string). Bei einem leeren Array werden alle Module geliefert |
Rückgabewert
Ein Array mit einem Eintrag je Modul in der Reihenfolge von ModulIDs. Ist ModulIDs leer, ist die Reihenfolge der Einträge nicht garantiert. Jeder Eintrag hat denselben Aufbau wie bei IPS_GetModule.
Beschreibung
Diese Funktion ist nur für den internen Gebrauch vorgesehen und kann sich jederzeit ohne Ankündigung ändern oder entfallen.
Die Funktion liefert die Informationen der Module mit den IDs ModulIDs in einem Aufruf. Ist ModulIDs leer, werden alle Module geliefert.
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 ("This function is not available for PHP") – dort kann das Ergebnis über IPS_GetModuleList und IPS_GetModule ermittelt werden.
Ist ein Eintrag von ModulIDs kein String, schlägt die Funktion mit "Parameter type of ModuleIDs does not match" fehl. Existiert eines der Module nicht, schlägt die Funktion mit "Cannot find module with GUID ..." fehl, bei einer ungültigen GUID mit "ModuleID ... is not a valid GUID".
Beispiel
// Informationen zu einem Modul über die JSON-RPC Schnittstelle abfragen
$rpc = new JSONRPC("http://user:password@127.0.0.1:3777/api/");
print_r($rpc->IPS_GetModules(["{C3380B6E-2351-4A19-9668-A17960F97E51}"]));
/* liefert z.B.:
Array
(
[0] => Array
(
[Aliases] => Array
(
)
[ChildRequirements] => Array
(
)
[Implemented] => Array
(
[0] => {018EF6B5-AB94-40C6-AA53-46943E824ACF}
)
[LibraryID] => {0945206A-47AA-4FDD-9093-99051E410E82}
[Limit] => 0
[ModuleID] => {C3380B6E-2351-4A19-9668-A17960F97E51}
[ModuleName] => ThermoJet
[ModuleType] => 3
[ParentRequirements] => Array
(
[0] => {79827379-F36E-4ADA-8A95-5F8D1DC92FA9}
)
[Prefix] => TJ
[Translation] => Array
(
[de] => Array
(
[ThermoJet] => ThermoJet
)
)
[URL] =>
[Vendor] => ProJet
)
)
*/