Zend_Feed_Pubsubhubbub_Subscriber implementiert einen kompletten Pubsubhubbub Abonnenten der in der Lage ist jedes Thema über jeden Hub der von diesem Thema vermittelt wird zu abonnieren und Abos zu löschen. Er arbeitet in Verbindung mit Zend_Feed_Pubsubhubbub_Subscriber_Callback welcher Anfragen von einem Hub akzeptiert um alle Aboanfragen und das Löschen von Abos zu bestätigen (um Missbrauch durch andere zu verhindern).

Jedes Abo (oder Löschen eines Abos) benötigt die betreffende Information bevor es bearbeitet werden kann, z.B. die URI des Themas (Atom oder RSS Feed) das für Aktualisierungen abonniert werden soll, und die URI des Endpunkts für den Hub welcher die Anmeldung auf das Abo bearbeitet und die Aktualisierungen weiterleitet. Die Lebenszeit eines Abos kann durch den Hub ermittelt werden, aber die meisten Hubs sollten die automatische Auffrischung des Abos unterstützen indem der Abonnenten geprüft wird. Das wird von Zend_Feed_Pubsubhubbub_Subscriber_Callback unterstützt und benötigt keine weitere Arbeit. Es wird trotzdem empfohlen dass man die vom Hub kommende Lebenszeit des Abos (time to live, ttl) verwendet um die Erstellung neuer Abos zu planen (der Prozess ist identisch mit dem eines neuen Abos) um es beim Hub zu aktualisieren. Wärend das per se nicht notwendig ist, deckt es Fälle ab in denen ein Hub die automatische Aktualisierung des Abos nicht unterstützt und deckt damit Fehler des Hubs mit zusätzlicher Redundanz ab.

Mit der relevanten Information an der Hand kann eine Abonnierung wie anbei gezeigt versucht werden:

$storage = new Zend_Feed_Pubsubhubbub_Model_Subscription;

$subscriber = new Zend_Feed_Pubsubhubbub_Subscriber;
$subscriber->setStorage($storage);
$subscriber->addHubUrl('http://hubbub.example.com');
$subscriber->setTopicUrl('http://www.example.net/rss.xml');
$subscriber->setCallbackUrl('http://www.mydomain.com/hubbub/callback');
$subscriber->subscribeAll();

Um Abos zu speichern und Zugriff auf dessen Daten für eine generelle Verwendung zu Speichern benötigt die Komponente eine Datenbank (ein Schema wird später in diesem Abschnitt angeboten). Standardmäßig wird angenommen das der Name der Tabelle "subscription" ist und im Hintergrund Zend_Db_Table_Abstract anwendet, was bedeutet das der Standardadapter verwendet wird welcher in der Anwendung gesetzt ist. Man kann auch eine eigene spezielle Instanz von Zend_Db_Table_Abstract in das assoziierte Modell von Zend_Feed_Pubsubhubbub_Model_Subscription übergeben. Dieser eigene Adapter kann so einfach wie gewünscht sein indem der Name der Tabelle welche zu verwenden ist geändert wird, oder so komplex wie es notwendig ist.

Wärend das Modell als standardmäßige bereits verwendbare Lösung angeboten wird, kann man sein eigenes Modell verwenden indem irgendein anderes Backend oder Datenbanklayer (z.B. Doctrine) verwendet wird, solange die resultierende Klasse das Interface Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface implementiert.

Ein Beispielschema (MySQL) für eine Abotabelle auf welche vom angebotenen Modell aus zugegriffen werden kann, könnte wie folgt aussehen:

CREATE TABLE IF NOT EXISTS `subscription` (
  `id` varchar(32) COLLATE utf8_unicode_ci NOT NULL DEFAULT '',
  `topic_url` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
  `hub_url` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
  `created_time` datetime DEFAULT NULL,
  `lease_seconds` bigint(20) DEFAULT NULL,
  `verify_token` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
  `secret` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
  `expiration_time` datetime DEFAULT NULL,
  `subscription_state` varchar(12) COLLATE utf8_unicode_ci DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

Im Hintergrund sendet der Abonnent eine Anfrage an den Endpunkt des Hubs welche die folgenden Parameter enthält (basierend auf dem vorhergehenden Beispiel):

Man kann verschiedene dieser Parameter verändern um eine andere Vorliebe anzuzeigen. Zum Beispiel kann man eine anderen Wert der Gültigkeit in Sekunden setzen indem man Zend_Pubsubhubbub_Subscriber::setLeaseSeconds() verwendet, oder eine Vorliebe für eine asynchrone Prüfung zeigen indem setPreferredVerificationMode(Zend_Feed_Pubsubhubbub::VERIFICATION_MODE_ASYNC) verwendet wird. Trotzdem bleiben die Hubs in der Lage Ihre eigenen Vorlieben zu erzwingen, und aus diesem Grund wurde die Komponente so designt dass Sie mit fast jedem Set an Optionen arbeitet und eine minimale Konfiguration des End-Benutzers erfordert. Konventionen sind toll wenn Sie funktionieren!

Das Löschen eines Abos folgt exakt dem gleichen Pattern wie im vorherigen Beispiel, mit der Ausnahme das stattdessen unsubscribeAll() aufgerufen wird. Die enthaltenen Parameter sind identisch mit einer Aboanfrage mit der Ausnahme das "hub.mode" auf "unsubscribe" gesetzt wird.

Standardmäßig versucht eine neue Instanz von Zend_Pubsubhubbub_Subscriber ein Datenbank Backend Speichermedium zu verwenden mit Standardwerten um den standardmäßigen Zend_Db Adapter mit dem Tabellennamen "subscription" zu verwenden. Es wird empfohlen eine eigene Speicherlösung zu setzen welche diese Standardwerte nicht verwendet, entweder duch übergabe eines neuen Modells welches das benötigte Interface unterstützt, oder durch Übergabe einer neuen Instanz von Zend_Db_Table_Abstract an dem Constructor des standardmäßigen Modells um den verwendeten Tabellennamen zu verändern.

Wann auch immer eine Aboanfrage oder eine Anfrage auf Löschen eines Abos gemacht wird muss der Hub die Anfrage prüfen indem er eine neue Prüfanfrage an die Callback URL weiterleitet welche in den Abo or Abo löschen Parametern gesetzt ist. Um diese Hub Anfragen zu behandeln, welche alle zukünftigen Kommunikationen enthalten können wie z.B. Themenaktualisierungen (Feed), sollte die Callback URL die Ausführung einer Instanz von Zend_Pubsubhubbub_Subscriber_Callback auslösen um die Anfrage zu behandeln.

Die Callback Klasse sollte konfiguriert werden dass Sie das selbe Speichermedium wie die Subscriber Klasse verwendet. Ihre Verwendung ist sehr einfach da die meiste Arbeit intern erledigt wird.

$storage = new Zend_Feed_Pubsubhubbub_Model_Subscription;
$callback = new Zend_Feed_Pubsubhubbub_Subscriber_Callback;
$callback->setStorage($storage);
$callback->handle();
$callback->sendResponse();

/**
 * Prüfe ob der resultierende Callback das Ergebnis eines Feed Updates ist.
 * Andernfalls war es entweder eine (De-)Abo-Prüfanfrage oder ungültig.
 * Typischerweise müssen wir nicht mehr tun als die Behandlung der
 * Aktualisierungen vom Feed hinzuzufügen - der Rest wird intern von der
 * Klasse behandelt.
 */
if ($callback->hasFeedUpdate()) {
    $feedString = $callback->getFeedUpdate();
    /**
     * Die Aktualisierung des Feeds asynchron bearbeiten um ein Timeout
     * des Hubs zu vermeiden.
     */
}

Wie vorher erwähnt empfängt die Klasse Zend_Feed_Pubsubhubbub_Subscriber_Callback den kombinierten Schlüssel welche mit jedem Abo assoziiert ist vom Hub über eine oder zwei Methoden. Die technisch bevorzugte Methode ist das Hinzufügen dieses Schlüssels zur Callback URL welcher für den Hub in allen zukünftigen Anfragen tätig ist indem ein Stringparameter in der Abfrage mit dem Schlüssel "xhub.subscription" verwendet wird. Trotzdem, aus historischen Gründen, weil es in Pubsubhubbub 0.1 nicht unterstützt wurde (es wurde kürzlich nur in 0.2 hinzugefügt) ist es stärkstens empfohlen das kompatibelste zu verwenden und den Schlüssel der Callback URL hinzuzugefügen indem er den URL Pfaden angehängt wird.

Deshalb würde die URL http://www.example.com/callback?xhub.subscription=key zu http://www.example.com/callback/key werden.

Da die Abfragestring Methode der Standard in der Vermeidung eines größeren Levels der zukünftigen Unterstützung der kompletten 0.2 Spezifikation ist, benötigt es etwas zusätzliche Arbeit um Sie zu implementieren.

Der erste Schritt besteht darin der Klasse Zend_Feed_Pubsubhubbub_Subscriber_Callback dem Pfad bewusst zu machen welcher den Aboschlüssel enthält. Er wird hierfür manuell injiziert, da man für diesen Zweck auch eine Route manuell definieren muss. Das wird erzielt indem einfach die Methode Zend_Feed_Pubsubhubbub_Subscriber_Callback::setSubscriptionKey() mit dem Parameter aufgerufen wird welcher der Schlüsselwert ist der vom Router kommt. Das folgende Beispiel zeigt dies durch Verwendung eines Zend Framework Controllers.

class CallbackController extends Zend_Controller_Action
{

    public function indexAction()
    {
        $storage = new Zend_Feed_Pubsubhubbub_Model_Subscription;
        $callback = new Zend_Feed_Pubsubhubbub_Subscriber_Callback;
        $callback->setStorage($storage);
        /**
         * Injiziert den Aboschlüssel welcher er vom URL Pfad geparst wird
         * indem ein Parameter vom Router verwendet wird
         */
        $subscriptionKey = $this->_getParam('subkey');
        $callback->setSubscriptionKey($subscriptionKey);
        $callback->handle();
        $callback->sendResponse();

        /**
         * Prüfen ob der Callback als Ergebnis den Empfang eines Feed Updates
         * enthält. Anderfalls war es entweder eine De-Aboprüfungsanfrage oder
         * eine ungültige Anfrage. Typischerweise muss nichts anderes getan
         * werden als das Handling der Feedaktualisierungen hinzuzufügen - der
         * Rest wird intern von der Klasse behandelt.
         */
        if ($callback->hasFeedUpdate()) {
            $feedString = $callback->getFeedUpdate();
            /**
             * Die Aktualisierung des Feeds asynchron behandeln um Hub
             * Timeouts zu vermeiden.
             */
        }
    }

}

Aktuell kann das Hinzufügen der Route zu einem Parameter welcher den Schlüssel der an den Pfad angehängt wird mappen würde durchgeführt werden indem eine Routenkonfiguration wie im kommenden INI formatierten Beispiel für die Verwendung mit dem Bootstrapping von Zend_Application verwendet wird.

; Callback Route fürs Hinzufügen einer PuSH Aboschlüssel Abfrage zu aktivieren
resources.router.routes.callback.route = "callback/:subkey"
resources.router.routes.callback.defaults.module = "default"
resources.router.routes.callback.defaults.controller = "callback"
resources.router.routes.callback.defaults.action = "index"