Map (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
 
(13 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
==Beschreibung==
 
==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 <code>[[sp:map]]</code>-Tag erzeugt geändert und gelöscht werden. Um auf ein Element der Map zuzugreifen, wird der Schlüssel wie ein [[Attribute|Attribut]] verwendet. Eine Schlüsselname ist somit bestimmten Regeln unterworfen. Z.B. darf ein Schlüsselname nicht mit einer Zahl beginnen.
+
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 <code>[[sp:map]]</code>-Tag erzeugt, geändert und gelöscht werden. Um auf ein Element der Map zuzugreifen, wird der Schlüssel wie ein [[Attribute|Attribut]] verwendet, somit ist ein Schlüsselname bestimmten Regeln unterworfen. Z.B. sollte ein Schlüsselname nicht mit einer Zahl beginnen.
  
 
  myMap.myKey
 
  myMap.myKey
  
−
Die Map <code>myMap</code> hat einen Schlüssel <code>myKey</code>. Da <code>myKey</code> hier als [[Attribute|Attribut]] verwendet wird, muß darauf geachtet werden, dass die Schlüsselnamen den Konventionen eines Attributes entsprechen.
+
Die Map <code>myMap</code> hat einen Schlüssel <code>myKey</code>. Da <code>myKey</code> hier als [[Attribute|Attribut]] verwendet wird, muss darauf geachtet werden, dass die Schlüsselnamen den Konventionen eines Attributes entsprechen.
  
 
==Attribute==
 
==Attribute==
 
{| class="prettytable"
 
{| class="prettytable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
−
! Attribut || Type || Beschreibung || ab IES Version
+
! Attribut || Type || Beschreibung || ab IES Version || veraltet ab IES Version
 
|-
 
|-
 
| size
 
| size
Zeile 18: Zeile 18:
 
| Anzahl der Einträge in der Map
 
| Anzahl der Einträge in der Map
 
| 1
 
| 1
 +
| 2.17
 
|-
 
|-
 
| entries
 
| entries
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[MapEntry]]>
 
| Liste aller Schlüssel/Werte-Paare als [[MapEntry]] Objekte
 
| Liste aller Schlüssel/Werte-Paare als [[MapEntry]] Objekte
 
| 1
 
| 1
 +
| 2.17
 
|-
 
|-
 
| keys
 
| keys
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[Object]]>
 
| Liste aller Schlüssel
 
| Liste aller Schlüssel
 
| 1
 
| 1
 +
| 2.17
 
|-
 
|-
 
| values
 
| values
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[Object]]>
 
| Liste aller Werte
 
| Liste aller Werte
 
| 1
 
| 1
 +
| 2.17
 +
|}
 +
 +
==Methoden==
 +
{| class="prettytable sortable"
 +
|- class="hintergrundfarbe1"
 +
! Methode || Rückgabewert || Beschreibung || ab IES Version
 +
|-
 +
| <code>toJson()</code>
 +
| [[String]]
 +
| Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann.
 +
| 2.9
 +
|-
 +
| <code>toJson([[Number]] indentFactor)</code>
 +
| [[String]]
 +
| Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann.
 +
| 2.9
 +
|-
 +
| <code>toJson([[Number]] indentFactor, [[Number]] indent)</code>
 +
| [[String]]
 +
| Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann.
 +
| 2.9
 +
|-
 +
| <code>toJson([[Number]] indentFactor, [[Number]] indent, [[String]] indentChar)</code>
 +
| [[String]]
 +
| Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann.
 +
| 2.9
 +
|-
 +
| <code>toPhpArray()</code>
 +
| [[String]]
 +
| Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann.
 +
| 2.9
 +
|-
 +
| <code>toPhpArray([[Number]] indentFactor)</code>
 +
| [[String]]
 +
| Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann.
 +
| 2.9
 +
|-
 +
| <code>toPhpArray([[Number]] indentFactor, [[Number]] indent)</code>
 +
| [[String]]
 +
| Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann.
 +
| 2.9
 +
|-
 +
| <code>toPhpArray([[Number]] indentFactor, [[Number]] indent, [[String]] indentChar)</code>
 +
| [[String]]
 +
| Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann.
 +
| 2.9
 +
|-
 +
| <code>get([[String]] name)</code>
 +
| Objekt
 +
| Liefert Wert der unter <code>name</code> abgelegt ist.
 +
| 2.17
 +
|-
 +
| <code>length()</code>
 +
| [[Number]]
 +
| Liefert die Anzahl der Namen/Werte Paare in der Map
 +
| 2.17
 +
|-
 +
| <code>getNames()</code>
 +
| [[Collection]]&nbsp;<[[String]]>
 +
| Liefert die Liste aller Namen der Map
 +
| 2.17
 +
|-
 +
| <code>entrySet()</code>
 +
| [[Collection]]&nbsp;<[[MapEntry]]>
 +
| Liefert die Liste aller Namen/Werte Paare der Map
 +
| 2.17
 +
|-
 +
| <code>getValues()</code>
 +
| [[Collection]]
 +
| Liefert die Liste aller Werte der Map
 +
| 2.17
 
|}
 
|}
 +
;<code>[[String]] toJson([[Number]] indentFactor, [[Number]] indent, [[String]] indentChar)</code>
 +
:Erzeugt aus den Daten der Map einen String in JSON, der mit sp:print ausgegeben werden kann.
 +
:;Parameter
 +
::;<code>[[Number]] indentFactor</code>
 +
:::Anzahl der Einrückungen pro Ebene. Optional (Default-Wert: 0).
 +
::;<code>[[Number]] indent</code>
 +
:::Initiale Anzahl der Einrückungs-Zeichen. Optional (Default-Wert: 0).
 +
::;<code>[[String]] indentChar</code>
 +
:::Zeichen, das als Einrückungszeichen verwendet werden soll. Optional (Default-Wert: ' ').
 +
:;Rückgabewert
 +
::;String
 +
:::JSON als String.
 +
;<code>[[String]] toPhpArray([[Number]] indentFactor, [[Number]] indent, [[String]] indentChar)</code>
 +
:Erzeugt aus den Daten der Map einen String in PHP-Array-Notation, der mit sp:print ausgegeben werden kann.
 +
:;Parameter
 +
::;<code>[[Number]] indentFactor</code>
 +
:::Anzahl der Einrückungen pro Ebene. Optional (Default-Wert: 0).
 +
::;<code>[[Number]] indent</code>
 +
:::Initiale Anzahl der Einrückungs-Zeichen. Optional (Default-Wert: 0).
 +
::;<code>[[String]] indentChar</code>
 +
:::Zeichen, das als Einrückungszeichen verwendet werden soll. Optional (Default-Wert: ' ').
 +
:;Rückgabewert
 +
::;String
 +
:::PHPArray als String.
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
−
[[Category:Qualität_des_Inhalts_prüfen]]
 
−
[[Category:Qualität_der_Sprache_prüfen]]
 
 
[[Category:Qualität_des_Codes_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 27. Juli 2016, 13:28 Uhr

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.
Abgerufen von „https://wiki.sitepark.com/index.php?title=Map_(Objekt)&oldid=8105“