Map (Objekt)

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen

Name

Map - Liste von Schlüssel/Werte-Paaren

Beschreibung

Eine Map ist ein Objekt das Schlüssel/Werte-Paare aufnimmt. Jeder Schlüssel kann nur einmal in der Map enthalten sein. Maps können mit dem sp:map-Tag erzeugt, geändert und gelöscht werden. Um auf ein Element der Map zuzugreifen, wird der Schlüssel wie ein Attribut verwendet, somit ist ein Schlüsselname bestimmten Regeln unterworfen. Z.B. sollte ein Schlüsselname nicht mit einer Zahl beginnen.

myMap.myKey

Die Map myMap hat einen Schlüssel myKey. Da myKey hier als Attribut verwendet wird, muss darauf geachtet werden, dass die Schlüsselnamen den Konventionen eines Attributes entsprechen.

Attribute

Attribut Type Beschreibung ab IES Version veraltet ab IES Version
size Number Anzahl der Einträge in der Map 1 2.17
entries Collection <MapEntry> Liste aller Schlüssel/Werte-Paare als MapEntry Objekte 1 2.17
keys Collection <Object> Liste aller Schlüssel 1 2.17
values Collection <Object> Liste aller Werte 1 2.17

Methoden

Methode Rückgabewert Beschreibung ab IES Version
toJson() String Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann. 2.9
toJson(Number indentFactor) String Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann. 2.9
toJson(Number indentFactor, Number indent) String Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann. 2.9
toJson(Number indentFactor, Number indent, String indentChar) String Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann. 2.9
toPhpArray() String Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann. 2.9
toPhpArray(Number indentFactor) String Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann. 2.9
toPhpArray(Number indentFactor, Number indent) String Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann. 2.9
toPhpArray(Number indentFactor, Number indent, String indentChar) String Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann. 2.9
get(String name) Objekt Liefert Wert der unter name abgelegt ist. 2.17
length() Number Liefert die Anzahl der Namen/Werte Paare in der Map 2.17
getNames() Collection <String> Liefert die Liste aller Namen der Map 2.17
entrySet() Collection <MapEntry> Liefert die Liste aller Namen/Werte Paare der Map 2.17
getValues() Collection Liefert die Liste aller Werte der Map 2.17
String toJson(Number indentFactor, Number indent, String indentChar)
Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann.
Parameter
Number indentFactor
Anzahl der Einrückungen pro Ebene. Optional (Default-Wert: 0).
Number indent
Initiale Anzahl der Einrückungs-Zeichen. Optional (Default-Wert: 0).
String indentChar
Zeichen, das als Einrückungszeichen verwendet werden soll. Optional (Default-Wert: ' ').
Rückgabewert
String
JSON als String.
String toPhpArray(Number indentFactor, Number indent, String indentChar)
Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann.
Parameter
Number indentFactor
Anzahl der Einrückungen pro Ebene. Optional (Default-Wert: 0).
Number indent
Initiale Anzahl der Einrückungs-Zeichen. Optional (Default-Wert: 0).
String indentChar
Zeichen, das als Einrückungszeichen verwendet werden soll. Optional (Default-Wert: ' ').
Rückgabewert
String
PHPArray als String.