GAMBAS-BUCH 3.19.5

Die Komponente gb.web.feed – kurz WebFeed – entspricht der RSS-2.0-Spezifikation, die Sie auch unter https://cyber.harvard.edu/rss/rss.html nachlesen können.

Einsatzgebiete für RSS sind beispielsweise Nachrichtenseiten, Blogs oder Podcasts, deren Inhalte regelmäßig – oft mehrmals täglich – aktualisiert werden. Sie sollten neben der RSS-Dokument-Struktur und der Terminologie von RSS auch XML als Basis von strukturierten Daten kennen, um die Komponente WebFeed erfolgreich einsetzen zu können.

Eine RSS-Datei ist eine XML-Datei, die aus mehreren `Kanälen` besteht, die wiederum aus `Einträgen` bestehen. Jeder Eintrag ist eine Einheit, die eine „Neuigkeit“ oder was auch immer Inhalt des Feeds ist, zusammenfasst. Die Komponente gb.web.feed kann RSS-Dateien sowohl lesen als auch schreiben und unterstützt Bilder, Medienanhänge, Texteingabe-Elemente und Cloud-Tags.

• Das Lesen eines RSS-Feeds erfolgt so, dass Sie ein RSS-Objekt erzeugen, mit Inhalt füllen und es dann nach den Inhalten parsen, die Sie auslesen wollen. In einem weiteren Schritt werden die in einem geeigneten Format gespeicherten RSS-Feed-Daten dann angezeigt.
• RSS-Dateien schreiben Sie über eine objektorientierte Schnittstelle, indem Sie ein RSS-Objekt erzeugen, diesem Kanal-Objekte (Channels) zuweisen und in denen wiederum Eintrag-Objekte (Items) erzeugen und mit Daten befüllen. Das Ergebnis ist ein XML-Dokument.

Beispiel für einen Ausschnitt aus einem RSS-Feed:

<?xml version="1.0" encoding="UTF-8" ?>
<?xml-stylesheet href="/resources/xsl/rss2.jsp" type="text/xsl"?>
<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/">
<channel>
...
  <item>
    <title>Corona-Pandemie ...</title>
    <link>https://www.....html</link>
    <pubDate>Sun, 11 Oct 2020 10:14:50 +0200</pubDate>
    ...
    <description>Die gemeldeten Infektionszahlen bleiben hoch. ...</description>
  </item>
...
</channel>
</rss>

Diese Klasse repräsentiert ein RSS-Dokument. Seine Eigenschaften sind die seiner einzelnen Elemente. Sie verhält sich wie ein Lese-Schreib-Array von RssItem-Objekten.

• Sie können die Klasse Rss verwenden, um entweder den Inhalt eines RSS-Dokumentes auszulesen oder um ein RSS-Dokument zu erzeugen.
• Ein Objekt der Klasse Rss können Sie erzeugen – wie bei allen anderen Klassen der Komponente WebFeed auch.

Im folgenden Beispiel werden die RSS-Feed-Daten im XML-Format (→ Kapitel 18.12.5 RSS-Reader) einer Webseite ausgelesen. Hier der gekürzte RSS-XML-Quelltext-Ausschnitt für einen Eintrag:

<item>
  <title>DFB-Elf ...</title>
  <link>http://www.unsersport.de/fussball/nationalmannschaft/...html</link>
  <description>Die Nationalmannschaft gewinnt in Krusemark mit 12:0 gegen den SV Heidesand.</description>
</item> 

Sie können die einzelnen RSS-Einträge in der Reihenfolge durchlaufen, in der sie im RSS-Dokument vorkommen:

Dim hRss As Rss
Dim hRssItem As RssItem

For Each hRssItem In hRss
  ...
Next 

Der folgende Quelltext liefert ein RssItem an der Position `Index` RSS-Dokument zurück:

Dim hRss As Rss
Dim hRssItem As RssItem

hRssItem = hRss [ Index As Integer ]

So ersetzen Sie einen existierenden Eintrag im RSS-Dokument an der Position `Index`:

Dim hRss As Rss
Dim hRssItem As RssItem

hRss [ Index As Integer ] = hRssItem

• Auf die Frage, was die vielen Klassen der Komponente gb.web.feed leisten, gilt übergreifend:
• Jede Klasse bildet jeweils einen spezifischen Teil eines RSS-Dokuments als Objekt ab. Was das konkret besagt, steht in der oben erwähnten Spezifikation von RSS.
• Die WebFeed-Komponente implementiert ein so genanntes Dokument-Objekt-Modell. Das bedeutet einerseits, dass das Dokument geparst wird und die einzelnen Bestandteile als Gambas-Objekte manipuliert werden können.
• Oder Sie erzeugen einen Baum von Gambas-Objekten mit Hilfe der RSS-Klassen und schreiben daraus ein gültiges RSS-XML-Dokument. Fügen Sie dazu Ihre Elemente der Reihe nach hinzu. Der Einsatz der drei Eigenschaften Titel, Link und Beschreibung der Klasse Rss ist zwingend erforderlich, um ein RSS-Dokument zu erzeugen. Alle anderen Eigenschaften sind optional. Rufen Sie dann die Methode ToString() auf, um den XML-Dokument-String zu erhalten.

Die Klasse Rss verfügt über diese Eigenschaften:

Tabelle 24.12.0.1 : Eigenschaften der Klasse Rss

Die Klasse Rss verfügt über diese Methoden:

Tabelle 24.12.0.2 : Methoden der Klasse Rss

Eigenschaften der Klasse:

Tabelle 24.12.0.3 : Eigenschaften der Klasse RssCategory

Die Klasse verfügt über die folgenden drei Integer-Konstanten:

RssCloud.XmlRpc (0) RssCloud.Soap (1) RssCloud.HttpPost (2)

Das sind die Eigenschaften der Klasse:

Tabelle 24.12.0.4 : Eigenschaften der Klasse RssCloud

Sie können die Klasse erzeugen:

Dim hRssDate As RssDate
hRssDate = New RssDate ( [ Date As Date, Zone As String ] )

Diese Klasse besitzt nur zwei Eigenschaften:

Tabelle 24.12.0.5 : Eigenschaften der Klasse RssDate

Die Klasse verfügt über diese drei Eigenschaften:

Tabelle 24.12.0.6 : Eigenschaften der Klasse RssEnclosure

GUID steht für 'Globally Unique IDentifier' – als weltweit eindeutigem Bezeichner für einen bestimmten Feed-Item/Artikel. Die Klasse hat diese Eigenschaften:

Tabelle 24.12.0.7 : Eigenschaften der Klasse RssGuid

Die Klasse RssImage besitzt diese Eigenschaften:

Tabelle 24.12.0.8 : Eigenschaften der Klasse RssImage

Das sind die Eigenschaften der Klasse RssItem:

Tabelle 24.12.0.9 : Eigenschaften der Klasse RssItem

Das sind die zwei Eigenschaften der Klasse RssSource:

Die Klasse beschreibt ein Texteingabefeld, das optional mit dem Feed angezeigt werden kann und so eine Kommentarfunktion realisiert. Die Spezifikation sieht vor, dass RSS-Generatoren es dem Erzeuger eines RSS-Dokuments erlauben, Texteingabefelder und ein korrespondierendes CGI-Skript auf der Domain anzulegen. Ein Leser des RSS-Feeds kann somit – wenn sein RSS-Feed-Client es unterstützt – einen Text direkt aus der Darstellung des Feeds heraus an den Erzeuger senden.

Die Klasse verfügt über diese Eigenschaften:

Tabelle 24.12.0.11 : Eigenschaften der Klasse RssTextInput