Zend_Feed_Writer ist die Bruderkomponente zu Zend_Feed_Reader und verantwortlich für die Erzeugung von Feeds für die Ausgabe. Sie unterstützt die Atom 1.0 Spezifikation (RFC 4287) und RSS 2.0 wie vom RSS Advisory Board (RSS 2.0.11) spezifiziert. Es weicht nicht von diesen Standards ab. Trotzdem bietet es ein einfaches System der Erweiterung, welches es erlaubt jede Erweiterung und jedes Modul für jede der zwei Spezifikationen zu implementieren, wenn diese nicht von Haus aus angeboten werden.

In vieler Hinsicht ist Zend_Feed_Writer das Gegenteil von Zend_Feed_Reader. Während Zend_Feed_Reader darauf abzielt, eine einfach zu verwendende Architektur zur Verfügung zu stellen, die sich durch Getter-Methoden auszeichnet, stellt Zend_Feed_Writer ähnlich benannte Setter oder Mutatoren bereit. Das stellt sicher, dass die API keine weitere Lernkurve aufwirft, wenn sich jemand bereits mit Zend_Feed_Reader auskennt.

Als Ergebnis dieses Designs ist der Rest nämlich einleuchtend. Hinter den Kulissen wird jedes Datenset eines Zend_Feed_Writer-Daten-Containers während der Darstellungszeit in ein DOMDocument-Objekt übersetzt, indem die notwendigen Feed-Elemente verwendet werden. Für jeden unterstützten Feed-Typen gibt es beide, sowohl einen Atom 1.0 als auch einen RSS 2.0 Renderer. Die Verwendung der DOMDocument-Klasse statt einer Templatelösung hat viele Vorteile. Der offensichtlichste ist die Möglichkeit das DOMDocument zu exportieren, um es weiter zu bearbeiten und sich auf PHP DOM für die korrekte und richtige Darstellung zu verlassen.

Wie bei Zend_Feed_Reader ist Zend_Feed_Writer ein alleinstehender Ersatz für Zend_Feeds Builder-Architektur und nicht kompatibel mit diesen Klassen.

Die Architektur von Zend_Feed_Writer ist sehr einfach. Es hat zwei Kernsets von Klassen: Daten-Container und Renderer.

Der Container enthält die Klassen Zend_Feed_Writer_Feed und Zend_Feed_Writer_Entry. Die Einstiegsklassen können bei jeder Feed-Klasse angehängt werden. Der einzige Zweck dieses Containers ist es, Daten über den zu erstellenden Feed zu sammeln, indem ein einfaches Interface von Setter-Methoden verwendet wird. Diese Methoden führen einige Test zur Datenprüfung durch. Zum Beispiel prüft er übergebene URIs, Datum, usw. Diese Prüfungen sind nicht an einen der Feed-Standarddefinitionen gebunden. Das Container-Objekt enthält auch Methoden, welche die schnelle Darstellung und den Export des endgültigen Feeds erlauben und sie können auf Wunsch wiederverwendet werden.

Zusätzlich zu den hauptsächlichen Datencontainerklassen gibt es zwei Atom 2.0 spezifische Klassen. Zend_Feed_Writer_Source und Zend_Feed_Writer_Deleted. Die erstere implementiert Atom 2.0 Quell-Elemente, welche Feed-Metadaten der Quelle für spezielle Einträge im verwendeten Feed enthalten (z.B. wenn der aktuelle Feed nicht die originale Quelle des Eintrags enthält). Die letztere implementiert Atom Tombstones RFC und erlaubt es Feeds, Referenzen zu Einträgen zu haben, welche bereits gelöscht wurden.

Während es zwei hauptsächliche Datencontainer-Typen gibt, gibt es vier Renderer - zwei passende Container-Renderer pro unterstütztem Feedtyp. Jeder Renderer akzeptiert einen Container, und basierend auf seinem Container versucht er ein gültiges Feed-Markup zu erstellen. Wenn der Renderer nicht in der Lage ist, ein gültiges Feed-Markup zu erstellen, möglicherweise weil dem Container ein obligatorischer Datenpunkt fehlt, dann wird er dies melden, indem eine Exception geworfen wird. Während es möglich ist Exceptions zu ignorieren, würde dies die standardmäßige Schutzvorrichtung entfernen, welche sicherstellt, dass gültige Daten gesetzt wurden, um einen komplett gültigen Feed darzustellen.

Um dies etwas genauer zu erklären, kann man ein Set von Datencontainern für einen Feed erstellen, wobei es einen Feed-Container gibt, in dem einige Entry-Container hinzugefügt wurden und ein Deleted (gelöschter) Container. Dies formt eine Datenhierarchie, die einen normalen Feed nachstellt. Wenn die Darstellung durchgeführt wird, dann übergibt diese Hierarchie ihre Teile den betreffenden Darstellern und die partiellen Feeds (alle DOMDocuments) werden dann zusammen geworfen, um einen kompletten Feed zu erstellen. Im Falle von Source oder Deleted (Tomestone) Containern werden diese nur für Atom 2.0 dargestellt und für RSS ignoriert.

Da das System in Datencontainer und Renderer aufgeteilt ist, sind Erweiterungen interessant. Eine typische Erweiterung, welche Namespaced Feeds und Entry Level Elemente bietet, muss selbst exakt die gleiche Architektur reflektieren, z.B. anbieten von Feed und Entry Level Daten Containern und passenden Renderern. Das ist glücklicherweise keine komplexe Integrationsarbeit, da alle Erweiterungsklassen einfach registriert und automatisch von den Kernklassen verwendet werden. Wir kommen später in diesem Kapitel im Detail zu den Erweiterungen.

Die Verwendung von Zend_Feed_Reader ist so einfach wie das Setzen von Daten und dem Ausführen des Renderers. Hier ist ein Beispiel um einen minimalen Atom 1.0 Feed zu erstellen. Dies demonstriert dass jeder Feed oder Eintrag einen eigenen Container verwendet.

/**
 * Den Eltern Feed erstellen
 */
$feed = new Zend_Feed_Writer_Feed;
$feed->setTitle('Paddy\'s Blog');
$feed->setLink('http://www.example.com');
$feed->setFeedLink('http://www.example.com/atom', 'atom');
$feed->addAuthor(array(
    'name'  => 'Paddy',
    'email' => 'paddy@example.com',
    'uri'   => 'http://www.example.com',
));
$feed->setDateModified(time());
$feed->addHub('http://pubsubhubbub.appspot.com/');

/**
 * Einen oder mehrere Einträge hinzufügen. Beachten das Einträge
 * manuell hinzugefügt werden müssen sobald Sie erstellt wurden
 */
$entry = $feed->createEntry();
$entry->setTitle('All Your Base Are Belong To Us');
$entry->setLink('http://www.example.com/all-your-base-are-belong-to-us');
$entry->addAuthor(array(
    'name'  => 'Paddy',
    'email' => 'paddy@example.com',
    'uri'   => 'http://www.example.com',
));
$entry->setDateModified(time());
$entry->setDateCreated(time());
$entry->setDescription(
    'Die Schwierigkeiten erklären Spiele ins englische zu portieren.'
);
$entry->setContent(
    'Ich schreibe diesen Artikel nicht. Das Beispiel ist lang genug ;).');
$feed->addEntry($entry);

/**
 * Den ergebenden Feed in Atom 1.0 darstellen und $out zuordnen. Man kann
 * "atom" mit "rss" ersetzen um einen RSS 2.0 feed zu erstellen
 */
$out = $feed->export('atom');

Die dargestellt Ausgabe sollte folgende sein:

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
    <title type="text">Paddy's Blog</title>
    <subtitle type="text">Writing about PC Games since 176 BC.</subtitle>
    <updated>2009-12-14T20:28:18+00:00</updated>
    <generator uri="http://framework.zend.com" version="1.10.0alpha">
        Zend_Feed_Writer
    </generator>
    <link rel="alternate" type="text/html" href="http://www.example.com"/>
    <link rel="self" type="application/atom+xml"
        href="http://www.example.com/atom"/>
    <id>http://www.example.com</id>
    <author>
        <name>Paddy</name>
        <email>paddy@example.com</email>
        <uri>http://www.example.com</uri>
    </author>
    <link rel="hub" href="http://pubsubhubbub.appspot.com/"/>
    <entry>
        <title type="html"><![CDATA[All Your Base Are Belong To
            Us]]></title>
        <summary type="html">
            <![CDATA[Exposing the difficultly of porting games to
                English.]]>
        </summary>
        <published>2009-12-14T20:28:18+00:00</published>
        <updated>2009-12-14T20:28:18+00:00</updated>
        <link rel="alternate" type="text/html"
            href="http://www.example.com/all-your-base-are-belong-to-us"/>
        <id>http://www.example.com/all-your-base-are-belong-to-us</id>
        <author>
            <name>Paddy</name>
            <email>paddy@example.com</email>
            <uri>http://www.example.com</uri>
        </author>
        <content type="html">
            <![CDATA[I am not writing the article.
                     The example is long enough as is ;).]]>
        </content>
    </entry>
</feed>

Das ist ein vollkommen gültiges Beispiel für Atom 1.0. Es sollte erwähnt werden, dass das Weglassen von obligatorischen Teilen der Daten, wie dem Titel, zu einer Exception führt, wenn diese als Atom 1.0 dargestellt werden. Anders ist das bei RSS 2.0, wo ein Titel weggelassen werden kann, solange eine Beschreibung vorhanden ist. Dadurch werden Exceptions geworfen, die sich zwischen beiden Standards abhängig vom Renderer unterscheiden, der verwendet wird. Vom Design her wird Zend_Feed_Writer keinen ungültigen Feed für einen Standard übersetzen, außer der End-Benutzer entscheidet sich bewusst, alle Exceptions zu ignorieren. Diese eingebaute Sicherheit wurde hinzugefügt, um sicherzustellen, dass sich Benutzer ohne tiefe Kenntnisse der betreffenden Spezifikationen keine Sorgen machen müssen.

Bevor ein Feed dargestellt werden kann, müssen zuerst die dafür notwendigen Daten gesetzt werden. Hierbei wird eine einfache Setter-artige API verwendet, welche auch als initiale Methode für die Prüfung von Daten herhält, wenn diese gesetzt werden. Vom Design her entspricht die API stark der von Zend_Feed_Reader, um Unklarheiten und Unsicherheiten zu vermeiden.

Zend_Feed_Writer bietet diese API über seine Datencontainerklassen Zend_Feed_Writer_Feed und Zend_Feed_Writer_Entry an (nicht zu erwähnen die Atom 2.0 spezifischen Erweiterungsklassen). Diese Klassen speichern nahezu alle Feed-Daten in einer vom Typ unabhängigen Art, was bedeutet, dass man jeden Datencontainer mit jedem Renderer wiederverwenden kann, ohne dass zusätzliche Arbeit notwendig ist. Beide Klassen sind auch offen für Erweiterungen, was bedeutet, dass eine Erweiterung ihre eigenen Containerklassen definieren kann, welche bei den Basis-Containerklassen als Erweiterung registriert sind und geprüft werden, sobald irgendein Methodenaufruf die __call() Methode des Basiscontainers auslöst.

Hier ist eine Zusammenfassung der Kern-API für Feeds. Man sollte beachten, dass sie nicht nur die Standards für RSS und Atom umfasst, sondern auch eine Anzahl von Erweiterungen, welche in Zend_Feed_Writer enthalten sind. Die Benennung dieser Erweiterungsmethoden ist recht generisch - alle Erweiterungsmethoden arbeiten auf dem gleichen Level wie die Kern-API, da wir es erlauben, jedes Erweiterungsobjekt separat zu empfangen wenn das notwendig ist.

Die API für Daten auf Level des Feeds ist in Zend_Feed_Writer_Feed enthalten. Zusätzlich zu der anbei beschriebenen API, implementiert die Klasse auch die Interfaces Countable und Iterator.

Hier ist eine Zusammenfassung der Kern-API für Einträge und Elemente. Man sollte beachten, dass dies nicht nur die Standards für RSS und Atom umfasst, sondern auch eine Anzahl von Erweiterungen, welche in Zend_Feed_Writer enthalten sind. Die Benennung dieser Erweiterungsmethoden ist recht generisch - alle Erweiterungsmethoden arbeiten auf der gleichen Ebene wie die Kern-API, da wir es zulassen, jedes Erweiterungsobjekt separat zu empfangen, wenn das notwendig ist.

Die API auf Level des Eintrags ist in Zend_Feed_Writer_Entry enthalten.