Übersicht zu den Parametertypen für Aktionen in edoc automate
Sie können in Aktionen Parameter mit unterschiedlichen Typen definieren. Die unterschiedlichen Parametertypen im Dialog Edit Action definieren einerseits die auswählbaren Optionen beim Entwickeln der App und natürlich auch die Ausführung der Aktion zur Laufzeit.
Auf den Wert eines Parameter können Sie zur Laufzeit mit den Methoden AbstractComponent::param($name) oder AbstractComponent::paramList($name) bei Listen zugreifen.
Folgende Parametertypen gibt es standardmäßig in edoc automate:
Parametertyp | Funktion im Editor | Funktion zur Laufzeit |
---|---|---|
TEXT | Dient zum Einfügen von statischem Text. Sie können optional auch eine Aktion einfügen, deren SingleValue-Rückgabewert verwendet wird. | Liefert einen statischen Text oder die SingleValue-Rückgabe einer Aktion zurück. |
SELECT | Dient zum Auswählen von vordefinierten Werten. Sie müssen einen Wert auswählen. | Liefert einen Wert aus der definierten Liste von Werten zurück. |
COMPONENT | Dient zum Auswählen einer Komponente in der aktuellen View. | Liefert die ID der ausgewählten Komponente in der View zurück. Mit der Methode AbstractAction::findComponent() können Sie auf die Instanz der Komponente zugreifen. |
COMPONENTLIST | Dient zum Erstellen einer Liste mit mehreren Komponenten der aktuellen View. Die Liste kann auch nur eine Komponente enthalten. | Liefert eine Liste mit IDs von Komponenten in der View zurück. Mit der Methode AbstractAction::findComponent() können Sie auf die Instanz einer einzelnen Komponente zugreifen. |
KEYVALUELIST | Dient zum Erstellen einer Liste mit beliebig vielen Werten mit Namen und dem zugehörigen Wert. Sie können als Wert auch eine Aktion auswählen. | Liefert eine Liste von Werten als assoziatives Array zurück. Sie sollten Parameter dieses Typs mit der Methode AbstractComponent::paramList($name) abfragen, damit die definierten Aktionen direkt ausgeführt werden. |
VALUELIST | Dient zum Erstellen einer Liste mit beliebig vielen Werten ohne weitere Kennzeichnung der einzelnen Werte. | Liefert eine Liste von Werten als indiziertes Array (indexed). Sie sollten Parameter dieses Typs mit der Methode AbstractComponent::paramList($name) abfrag, damit die definierten Aktionen direkt ausgeführt werden. |
ACTIONLIST | Dient zum Erstellen einer Liste mit beliebig vielen Aktionen ohne weitere Kennzeichnung der einzelnen Aktionen. | Liefert eine Liste als indiziertes Array (indexed) zurück. Das Array enthält nur die Konfiguration der Aktionen, mit der Sie eine Instanz mit der statischen Methode AbstractAction::create() erzeugen können. |
KEYACTIONLIST | Dient zum Erstellen einer Liste mit beliebig vielen Aktionen mit der Kennzeichnung durch einen Schlüssel, um einzelne Aktionen in der Liste zu identifizieren. | Liefert eine Liste als assoziatives Array zurück. Das Array enthält nur die Konfiguration der Aktionen, mit der Sie eine Instanz mit der statischen Methode AbstractAction::create() erzeugen können. |
ACTION | Dient zum Auswählen einer einzelnen Aktion. | Liefert die Konfiguration einer einzelnen Aktion zurück. Mit der statischen Methode AbstractAction::create() können Sie eine Instanz der Aktion erzeugen. |
EDITOR | Ist ein Text-Editor, in dem die Syntax hervorgehoben wird. | Liefert den im Editor definierten Text zurück. Mit der Option mode können Sie eine Sprache für die Syntaxhervorhebung angeben. Mit der Option autocompletion können Sie die automatische Vervollständigung zur eingestellten Sprache aktivieren (true) oder deaktivieren (false). |
DATASOURCE | Ist eine Liste mit allen in der App vorhandenen Datenquellen. | Liefert den Namen der ausgewählten Datenquelle zurück. |
WORKFLOW | Ist eine Liste mit allen in der App vorhandenen Workflows. | Liefert den Namen des ausgewählten Workflows. |
VIEWROUTE | Dient zum Auswählen einer Route zu einer View. Sie geben den Parameter für die Route an. | Liefert die Referenz zu einer Route eines Views zurück. |