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
size Number Anzahl der Einträge in der Map 1
entries Collection <MapEntry> Liste aller Schlüssel/Werte-Paare als MapEntry Objekte 1
keys Collection <Object> Liste aller Schlüssel 1
values Collection <Object> Liste aller Werte 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
toPhpArray() String Erzeugt aus den Daten der Map ein PHP-Array als String, das mit sp:print ausgegeben werden kann. 2.9
toPhpArray(Number intentFactor) String Erzeugt aus den Daten der Map ein PHP-Array als String, das mit sp:print ausgegeben werden kann. 2.9
toPhpArray(Number intentFactor, Number intent) String Erzeugt aus den Daten der Map ein PHP-Array als String, das mit sp:print ausgegeben werden kann. 2.9
toPhpArray(Number intentFactor, Number intent, String intentChar) String Erzeugt aus den Daten der Map ein PHP-Array als String, das mit sp:print ausgegeben werden kann. 2.9
String toPhpArray(Number intentFactor, Number intent, String intentChar)
Erzeugt aus den Daten der Map ein PHP-Array als String, das mit sp:print ausgegeben werden kann.
Parameter
Number intentFactor
Anzahl der Einrückungen pro Ebene. Optional (Default-Wert: 0).
Number intent
Initiale Anzahl der Einrückungs-Zeichen. Optional (Default-Wert: 0).
String intentChar
Zeichen, das als Einrückungszeichen verwendet werden soll. Optional (Default-Wert: ' ').
Rückgabewert
String
PHPArray als String.