ListInformation (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
 
(11 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
==Beschreibung==
 
==Beschreibung==
Ein ListInformation-Objekt besteht aus einzelnen [[ListItemInformation]]-Objekten. ListInformtion-Objekte sind Teil eines Artikels einer [[Resource]] oder eines [[Media|Mediums]]. Erzeugt werden dies Objekte mit Hilfe von <code>[[sp:iterator]]</code> und <code>[[spt:iterator]]</code>.
+
Ein ListInformation-Objekt besteht aus einzelnen [[ListItemInformation]]-Objekten. ListInformtion-Objekte sind Teil eines Artikels, einer [[Resource]] oder eines [[Media|Mediums]]. Erzeugt werden diese Objekte mit Hilfe von <code>[[sp:iterator]]</code> und <code>[[spt:iterator]]</code>.
  
Auf einzelne ListeItemInformation-Objekten der ListInformation kann mit Hilfe eines Index zugegriffen werden. Dazu steht folgende Syntax zur Verfügung:
+
Auf einzelne ListeItemInformation-Objekten der ListInformation kann mit Hilfe eines Index zugegriffen werden. ListInformation können wie [[Collection]]-Objekte verwendet werden.
 
 
myList[3]
 
 
 
Bei der Angabe des Index 3 wird das 4. ListItemInformation-Objekten der ListInformation zurückgeliefert, da die ListInformation mit dem Index 0 beginnt. Bei der Angabe eines negativen Index können die letzten ListeItemInformation-Objekten der ListInformation erfragt werden, ohne das die Länge der ListeItemInformation-Objekten bekannt sein muß.
 
 
 
myList[-1]
 
 
 
Bei der Angabe des Index -1 wird das letzte ListeItemInformation-Objekte der ListInformation zurückgeliefert. Bei einem Index von -2 würde das zweitletzte ListeItemInformation-Objekte zurückgeliefert werden usw.
 
 
 
Um alle ListeItemInformation-Objekte einer ListInformation nacheinander in einer Schleife zu durchlaufen kann der Tag <code>[[sp:loop]]</code> verwendet werden.
 
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 28: Zeile 18:
 
|-
 
|-
 
| field
 
| field
| [[Variable]]
+
| [[String]]
 
| Variablenname des Objektes
 
| Variablenname des Objektes
 
| 1
 
| 1
 +
|-
 +
| lastField
 +
| [[String]]
 +
| Variablenname des Objektes ohne Struktur-Date
 +
| 2.13
 
|-
 
|-
 
| root
 
| root
 
| [[Article]], [[Resource]], [[Media]]
 
| [[Article]], [[Resource]], [[Media]]
 
| Article, Resource oder Media dieses Objektes
 
| Article, Resource oder Media dieses Objektes
 +
| 1
 +
|-
 +
| parent
 +
| [[ID]]
 +
| ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein
 
| 1
 
| 1
 
|-
 
|-
Zeile 48: Zeile 48:
 
|-
 
|-
 
| filledItems
 
| filledItems
| [[Collection]]
+
| [[Collection]]&nbsp;<[[ListItemInformation]]>
 
| Enthält alle ListItemInformation-Objekten der ListInformation, die nicht leer sind
 
| Enthält alle ListItemInformation-Objekten der ListInformation, die nicht leer sind
 
| 1
 
| 1
 
|-
 
|-
 
| flat
 
| flat
| [[Collection]]
+
| [[Collection]]&nbsp;<[[Information]]>
| Liefert eine Liste alle Unter-Informationen ohne Struktierungs-Objekte wie ListInformations, [[ListItemInformation|ListItemInformations]]  oder [[SubInformation|SubInformations]]
+
| Liefert eine Liste aller Unter-Informationen ohne Struktierungs-Objekte wie ListInformations, [[ListItemInformation|ListItemInformations]]  oder [[SubInformation|SubInformations]]
 
| 1
 
| 1
 
|}
 
|}
Zeile 63: Zeile 63:
 
! Methode || Rückgabewert || Beschreibung || ab IES Version
 
! Methode || Rückgabewert || Beschreibung || ab IES Version
 
|-
 
|-
| <code>contains([[ListItemInformation]] item)</code>
+
| <code>contains([[ListItemInformation]]&nbsp;item)</code>
 
| [[Boolean]]
 
| [[Boolean]]
| Liefert <code>true</code>, wenn das ListItemInformation-Objekte in der ListInformation enthalten ist
+
| Liefert <code>true</code>, wenn das ListItemInformation-Objekt in der ListInformation enthalten ist
 +
| 1
 +
|-
 +
| <code>filledItems([[String]]&nbsp;name)</code>
 +
| [[Collection]]&nbsp;<[[ListItemInformation]]>
 +
| Liefert eine [[Collection]] von [[ListItemInformation]]-Objekten, die ein Feld <code>name</code> besitzen und bei denen das Feld nicht leer ist.
 
| 1
 
| 1
 
|}
 
|}
  
 
;<code>[[Boolean]] contains([[ListItemInformation]] item)</code>
 
;<code>[[Boolean]] contains([[ListItemInformation]] item)</code>
:Liefert <code>true</code>, wenn das ListeItemInformation-Objekte in der ListInformation enthalten ist. Alle ListeItemInformation-Objekte der Liste werden mit <code>o</code> verglichen. Stimmt ein ListeItemInformation-Objekt der ListInformation mit item überein wird true zurückgeliefert, sonst <code>false</code>. Zu beachten ist, das die ListeItemInformation-Objekte nicht direkt miteinander verglichen werden nur dessen ID.
+
:Liefert <code>true</code>, wenn das ListItemInformation-Objekt in der ListInformation enthalten ist. Alle ListItemInformation-Objekte der Liste werden mit <code>o</code> verglichen. Stimmt ein ListItemInformation-Objekt der ListInformation mit item überein, wird true zurückgeliefert, sonst <code>false</code>. Zu beachten ist, dass die ListItemInformation-Objekte nicht direkt miteinander verglichen werden, sondern nur dessen ID.
 
:;Parameter
 
:;Parameter
::;<code>ListeItemInformation item</code>
+
::;<code>ListItemInformation item</code>
:::ListeItemInformation-Objekt, das mit den ListeItemInformation-Objekt der ListInformation verglichen werden soll. Zu beachten ist, dass nur die ID's der ListeItemInformation-Objekte miteinander verglichen werden.
+
:::ListItemInformation-Objekt, das mit den ListItemInformation-Objekt der ListInformation verglichen werden soll. Zu beachten ist, dass nur die IDs der ListItemInformation-Objekte miteinander verglichen werden.
 
:;Rückgabewert
 
:;Rückgabewert
 
::;Boolean
 
::;Boolean
 
:::<code>true</code>, wenn das ListeItemInformation-Objekt enhalten ist, sonst <code>false</code>.
 
:::<code>true</code>, wenn das ListeItemInformation-Objekt enhalten ist, sonst <code>false</code>.
  
 +
;<code>[[Collection]]&nbsp;<[[ListItemInformation]]> filledItems([[String]]&nbsp;name)</code>
 +
:Liefert eine [[Collection]] von [[ListItemInformation]]-Objekte, die ein Feld <code>name</code> besitzen und bei denen das Feld nicht leer ist.
 +
:;Parameter
 +
::;<code>String name</code>
 +
:::Feldname des Feldes das geprüft werden soll.
 +
:;Rückgabewert
 +
::;Collection
 +
:::Liste der ListItemInformation, dessen Feld <code>name</code> gefüllt ist.
  
 
<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 22. Juli 2015, 08:25 Uhr

Name

ListInformation - in einer Liste zusammengefasste ListItemInformation-Objekte

Beschreibung

Ein ListInformation-Objekt besteht aus einzelnen ListItemInformation-Objekten. ListInformtion-Objekte sind Teil eines Artikels, einer Resource oder eines Mediums. Erzeugt werden diese Objekte mit Hilfe von sp:iterator und spt:iterator.

Auf einzelne ListeItemInformation-Objekten der ListInformation kann mit Hilfe eines Index zugegriffen werden. ListInformation können wie Collection-Objekte verwendet werden.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Objektes 1
field String Variablenname des Objektes 1
lastField String Variablenname des Objektes ohne Struktur-Date 2.13
root Article, Resource, Media Article, Resource oder Media dieses Objektes 1
parent ID ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein 1
size Number Anzahl der ListItemInformation-Objekte in der ListInformation 1
hasContent Boolean true, wenn mindestens ein ListItemInformation-Objekten nicht leer ist 1
filledItems Collection <ListItemInformation> Enthält alle ListItemInformation-Objekten der ListInformation, die nicht leer sind 1
flat Collection <Information> Liefert eine Liste aller Unter-Informationen ohne Struktierungs-Objekte wie ListInformations, ListItemInformations oder SubInformations 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
contains(ListItemInformation item) Boolean Liefert true, wenn das ListItemInformation-Objekt in der ListInformation enthalten ist 1
filledItems(String name) Collection <ListItemInformation> Liefert eine Collection von ListItemInformation-Objekten, die ein Feld name besitzen und bei denen das Feld nicht leer ist. 1
Boolean contains(ListItemInformation item)
Liefert true, wenn das ListItemInformation-Objekt in der ListInformation enthalten ist. Alle ListItemInformation-Objekte der Liste werden mit o verglichen. Stimmt ein ListItemInformation-Objekt der ListInformation mit item überein, wird true zurückgeliefert, sonst false. Zu beachten ist, dass die ListItemInformation-Objekte nicht direkt miteinander verglichen werden, sondern nur dessen ID.
Parameter
ListItemInformation item
ListItemInformation-Objekt, das mit den ListItemInformation-Objekt der ListInformation verglichen werden soll. Zu beachten ist, dass nur die IDs der ListItemInformation-Objekte miteinander verglichen werden.
Rückgabewert
Boolean
true, wenn das ListeItemInformation-Objekt enhalten ist, sonst false.
Collection <ListItemInformation> filledItems(String name)
Liefert eine Collection von ListItemInformation-Objekte, die ein Feld name besitzen und bei denen das Feld nicht leer ist.
Parameter
String name
Feldname des Feldes das geprüft werden soll.
Rückgabewert
Collection
Liste der ListItemInformation, dessen Feld name gefüllt ist.