Zend_Feed_ReaderEinführungZend_Feed_Reader ist eine Komponente die verwendet wird um
RSS und Atom Feeds jeder Version zu konsumieren, inklusive
RDF/RSS 1.0, RSS 2.0 und
Atom 0.3/1.0. Die API für das Empfangen von Feed Daten ist relativ
einfach da Zend_Feed_Reader in der Lage ist jeden Feed eines
jeden Typs mit Hilfe der API nach den angefragten Informationen zu
durchsuchen. Wenn die typischen Elemente die diese Informationen enthalten nicht
vorhanden sind, werden diese adaptiert und statt dessen auf eine Vielzahl von
alternativen Elementen zurück gegriffen. Diese Fähigkeit, von Alternativen auszuwählen,
verhindert das Benutzer Ihren eigenen astrakten Layer über die Komponente legen müssen
damit Sie nützlich ist, oder beliebig tiefes Wissen des zugrundeliegenden Standard,
aktueller alternativen und namespaces Erweiterungen haben müssen.
Intern arbeitet Zend_Feed_Reader fast komplett auf Basis der
Erstellung von XPath Abfragen gegen das Dokument Objekt Modell des Feed
XML's. Das DOM wird nicht durch eine gekettete
Eigenschaften API wie bei Zend_Feed bekannt
gegeben und durch die darunterliegenden DOMDocument,
DOMElement und DOMXPath Objekte für eine
externe Manipulation bekannt gegeben. Dieser Singular Weg des Parsens ist Konsistent
und die Komponente bietet ein Plugin System um dem Feed hinzuzufügen und eine Eintrags
Level API durch das Schreiben von Erweiterungen auf einer ähnlichen
Basis.
Geschwindigkeit wird auf drei Wegen bereitgestellt. Erstens unterstützt
Zend_Feed_Reader das Cachen durch Verwendung von
Zend_Cache um eine Kopie des Originalen Feed
XML zu halten. Das erlaubt es Netzwerk Anfragen für eine Feed
URI zu überspringen wenn der Cache gültig ist. Zweitens wird die
Feed und Eintrag- Level API durch einen internen Cache gesichert
(nicht persistent) damit wiederholte API Aufrufe für den gleichen
Feed eine zusätzliche Verwendung von DOM/XPath verhindert.
Drittens erlaubt das Importieren von Feeds von einer URI den
Vorteil von konditionellen HTTP GET Anfragen was es Servern
erlaubt eine leere 304 Anfrage auszulösen wenn der angefragte Fed seit der Zeit zu der
er das letzte Mal angefragt wurde, nicht verändert wurde. Im letzten Fall hält eine
Instanz von Zend_Cache den zuletzt empfangenen Feed zusammen mit
dem ETag und dem Last-Modified Header Werten die in der HTTP
Antwort gesendet wurde.
Relativ zu Zend_Feed wurde
Zend_Feed_Reader als frei stehender Ersatz für
Zend_Feed formuliert der aber nicht mit
Zend_Feed rückwärts kompatibel ist. Aber es ist eine Alternative
die einer anderen Ideologie folgt die darin fokusiert ist einfach verwendbar zu sein,
flexibel, konsistent und durch das Plugin System erweiterbar.
Zend_Feed_Reader ist auch nicht dazu fähig Feeds zu erstellen,
das wird aber zu einem späteren Zeitpunkt hinzugefügt.
Feeds importieren
Das importieren eines Feeds mit Zend_Feed_Reader ist zu
Zend_Feed nicht sehr unterschiedlich. Feeds können von einem
String, einer Datei, URI oder einer Instanz des Typs
Zend_Feed_Abstract importiert werden. Das importieren von einer
URI kann zusätzlich eine konditionelle HTTP
GET Anfrage benützen. Wenn das importieren fehlschlägt, wird eine Exception geworfen.
Das Endergebnis wird ein Objekt des Typs
Zend_Feed_Reader_FeedInterface sein, die Core Implementation
von Zend_Feed_Reader_Feed_Rss und
Zend_Feed_Reader_Feed_Atom (Zend_Feed
hat alle kurzen Namen genommen!). Beide Objekte unterstützen mehrere (alle
existierenden) Versionen dieser breiten Feed Typen.
Im folgenden Beispiel importieren wir einen
RDF/RSS 1.0 Feed und extrahieren einige
grundsätzliche Information die dann in einer Datenbank oder wo anders gespeichert
werden können.
$feed->getTitle(),
'link' => $feed->getLink(),
'dateModified' => $feed->getDateModified(),
'description' => $feed->getDescription(),
'language' => $feed->getLanguage(),
'entries' => array(),
);
foreach ($feed as $entry) {
$edata = array(
'title' => $entry->getTitle(),
'description' => $entry->getDescription(),
'dateModified' => $entry->getDateModified(),
'author' => $entry->getAuthor(),
'link' => $entry->getLink(),
'content' => $entry->getContent()
);
$data['entries'][] = $edata;
}
]]>
Das obige Beispiel demonstriert die API von
Zend_Feed_Reader und es demonstriert auch einige seiner
internen Operationen. In Wirklichkeit hat der ausgewählte RDF Feed
keine nativen Daten oder Author Elemente, trotzdem verwendet er das Dublin Core 1.1
Modul welches Namespaced Ersteller und Datums Elemente anbietet.
Zend_Feed_Reader fällt auf diese und ähnliche Operationen zurück
wenn keine relativ nativen Elemente existieren. Wenn es absolut keine alternative
finden kann wird es NULL zurückgeben, was anzeigt das die
Informationen nicht im Feed gefunden werden können. Man sollte beachten das Klassen die
Zend_Feed_Reader_FeedInterface implementieren auch
die SPL Interfaces Iterator und
Countable implementieren.
Feeds können auch von Strings, Dateien und sogar Objekten des Typs
Zend_Feed_Abstract importiert werden.
Empfangen darunterliegender Quellen von Feeds und EinträgenZend_Feed_Reader does it's best not to stick
you in a narrow confine. If you need to work on a feed outside of
Zend_Feed_Reader, you can extract the base
DOMDocument or
DOMElement objects from any class, or even an
XML string containing these. Also provided are methods to extract
the current DOMXPath object (with all core
and Extension namespaces registered) and the correct prefix used in
all XPath queries for the current Feed or Entry. The basic methods
to use (on any object) are saveXml(),
getDomDocument(),
getElement(),
getXpath() and
getXpathPrefix(). These will let you break
free of Zend_Feed_Reader and do whatever else
you want.
saveXml() returns an XML string
containing only the element representing the current object.
getDomDocument() returns the
DOMDocument object representing the
entire feed (even if called from an Entry object).
getElement() returns the
DOMElement of the current object
(i.e. the Feed or current Entry).
getXpath() returns the
DOMXPath object for the current feed
(even if called from an Entry object) with the namespaces of
the current feed type and all loaded Extensions
pre-registered.
getXpathPrefix() returns the query
prefix for the current object (i.e. the Feed or current
Entry) which includes the correct XPath query path for that
specific Feed or Entry.
Here's an example where a feed might include an RSS Extension not
supported by Zend_Feed_Reader out of the box.
Notably, you could write and register an Extension (covered later)
to do this, but that's not always warranted for a quick check. You
must register any new namespaces on the
DOMXPath object before use unless they are
registered by Zend_Feed_Reader or an
Extension beforehand.
getXpathPrefix();
$xpath = $feed->getXpath();
$xpath->registerNamespace('admin', 'http://webns.net/mvcb/');
$reportErrorsTo = $xpath->evaluate('string('
. $xpathPrefix
. '/admin:errorReportsTo)');
]]>
If you register an already registered namespace with a different
prefix name to that used internally by
Zend_Feed_Reader, it will break the
internal operation of this component.
Cache Support and Intelligent RequestsAdding Cache Support to Zend_Feed_ReaderZend_Feed_Reader supports using an
instance of Zend_Cache to cache feeds (as
XML) to avoid unnecessary network requests. Adding a cache is as
simple here as it is for other Zend Framework components, create
and configure your cache and then tell
Zend_Feed_Reader to use it! The cache key
used is "Zend_Feed_Reader_" followed by the
MD5 hash of the feed's URI.
7200,
'automatic_serialization' => true
);
$backendOptions = array('cache_dir' => './tmp/');
$cache = Zend_Cache::factory(
'Core', 'File', $frontendOptions, $backendOptions
);
Zend_Feed_Reader::setCache($cache);
]]>
While it's a little off track, you should also consider
adding a cache to
Zend_Loader_PluginLoader which is
used by Zend_Feed_Reader to load
Extensions.
HTTP Conditional GET Support
The big question often asked when importing a feed frequently, is
if it has even changed. With a cache enabled, you can add HTTP
Conditional GET support to your arsenal to answer that question.
Using this method, you can request feeds from URIs and include
their last known ETag and Last-Modified response header values
with the request (using the If-None-Match and If-Modified-Since
headers). If the feed on the server remains unchanged, you
should receive a 304 response which tells
Zend_Feed_Reader to use the cached
version. If a full feed is sent in a response with a status code
of 200, this means the feed has changed and
Zend_Feed_Reader will parse the new
version and save it to the cache. It will also cache the new
ETag and Last-Modified header values for future use.
These "conditional" requests are not guaranteed to be supported
by the server you request a URI of, but can be attempted
regardless. Most common feed sources like blogs should however
have this supported. To enable conditional requests, you will
need to provide a cache to Zend_Feed_Reader.
86400,
'automatic_serialization' => true
);
$backendOptions = array('cache_dir' => './tmp/');
$cache = Zend_Cache::factory(
'Core', 'File', $frontendOptions, $backendOptions
);
Zend_Feed_Reader::setCache($cache);
Zend_Feed_Reader::useHttpConditionalGet();
$feed = Zend_Feed_Reader::import('http://www.planet-php.net/rdf/');
]]>
In the example above, with HTTP Conditional GET requests enabled,
the response header values for ETag and Last-Modified will be cached
along with the feed. For the next 24hrs (the cache lifetime), feeds will
only be updated on the cache if a non-304 response is received
containing a valid RSS or Atom XML document.
If you intend on managing request headers from outside
Zend_Feed_Reader, you can set the
relevant If-None-Matches and If-Modified-Since request headers
via the URI import method.
Locating Feed URIs from Websites
These days, many websites are aware that the location of their XML
feeds is not always obvious. A small RDF, RSS or
Atom graphic helps when the user is reading the page, but what about when a machine
visits trying to identify where your feeds are located? To assist in
this, websites may point to their feeds using <link> tags in
the <head> section of their HTML. To take advantage of this,
you can use Zend_Feed_Reader to locate these
feeds using the static findFeedLinks()
method.
This method calls any URI and searches for the location of
RSS, RDF
and Atom feeds assuming the wlebsite's HTML contains the relevant
links. It then returns a value object where you can check for the existence of a
RSS, RDF or Atom feed URI.
rdf)) {
echo $links->rdf, "\n"; // http://www.planet-php.org/rdf/
}
if(isset($links->rss)) {
echo $links->rss, "\n"; // http://www.planet-php.org/rss/
}
if(isset($links->atom)) {
echo $links->atom, "\n"; // http://www.planet-php.org/atom/
}
]]>
Based on these links, you can then import from whichever source you
wish in the usual manner.
Retrieving Feed Information
Retrieving information from a feed (we'll cover entries/items in the
next section though they follow identical principals) uses a clearly
defined API which is exactly the same regardless of whether the feed
in question is RSS/RDF/Atom. The same goes for
sub-versions of these standards and we've tested every single
RSS and Atom version. While
the underlying feed XML can differ substantially in terms of the
tags and elements they present, they nonetheless are all trying to
convey similar information and to reflect this all the differences
and wrangling over alternative tags are handled internally by
Zend_Feed_Reader presenting you with an
identical interface for each. Ideally, you should not have to care
whether a feed is RSS or Atom so long as you can extract the
information you want.
Of course, we don't live in an ideal world so there may be times the
API just does not cover what you're looking for. To assist you,
Zend_Feed_Reader offers a plugin system which
allows you to write Extensions to expand the core API and cover any
additional data you are trying to extract from feeds. If writing
another Extension is too much trouble, you can simply grab the
underlying DOM or XPath objects and do it by hand in your
application. Of course, we really do encourage writing an Extension
simply to make it more portable and reusable.
Here's a summary of the Core API for Feeds. You should note it
comprises not only the basic RSS and Atom standards, but also
accounts for a number of included Extensions bundled with
Zend_Feed_Reader. The naming of these
Extension sourced methods remain fairly generic - all Extension
methods operate at the same level as the Core API though we do allow
you to retrieve any specific Extension object separately if
required.
Feed Level API MethodsgetId()Returns a unique ID associated with this feedgetTitle()Returns the title of the feedgetDescription()Returns the text description of the feedgetLink()
Returns a URI to the HTML website
containing the same or
similar information as this feed (i.e. if the feed is from a blog,
it should provide the blog's URI where the
HTML version of the entries can be read).
getFeedLink()
Returns the URI of this feed, which should be the
same as the URI used to import the feed
getAuthors()
Returns an array of all authors associated with this feed
including email address in the author string if available
getAuthor(integer $index = 0)
Returns either the first author known, or with the
optional $index parameter any specific
index on the array of Authors (returning null if an
invalid index).
getDateCreated()
Returns the date on which this feed was created. Generally
only applicable to Atom where it represents the date the resource
described by an Atom 1.0 document was created.
getDateModified()
Returns the date on which this feed was last modified
getLanguage()
Returns the language of the feed (if defined) or simply the
language noted in the XML document
getGenerator()
Returns the generator of the feed, e.g. the software which
generated it. This may differ between RSS and Atom
since Atom defines a different notation.
getCopyright()
Returns any copyright notice associated with the feed
Given the variety of feeds in the wild, some of these methods will
undoubtedly return NULL indicating the relevant information
couldn't be located. Where possible, Zend_Feed_Reader
will fall back on alternative elements during its search. For
example, searching an RSS feed for a modification date is more
complicated than it looks. RSS 2.0 feeds should include a
<lastBuildDate> tag and/or a
<pubDate> element. But what if it doesn't, maybe
this is an RSS 1.0 feed? Perhaps it instead has an
<atom:updated> element with identical information
(Atom may be used to supplement RSS's syntax)? Failing that, we
could simply look at the entries, pick the most recent, and use its
<pubDate> element. Assuming it exists... Many
feeds also use Dublin Core 1.0/1.1 <dc:date>
elements for feeds/entries. Or we could find Atom lurking again.
The point is, Zend_Feed_Reader was designed
to know this. When you ask for the modification date (or anything
else), it will run off and search for all these alternatives until
it either gives up and returns NULL, or finds an
alternative that should have the right answer.
In addition to the above methods, all Feed objects implement methods
for retrieving the DOM and XPath objects for the current feeds as
described earlier. Feed objects also implement the SPL Iterator and
Countable interfaces. The extended API is summarised below.
Extended Feed Level API MethodsgetDomDocument()
Returns the parent
DOMDocument object for the
entire source XML document
getElement()
Returns the current feed level
DOMElement object
saveXml()
Returns a string containing an XML document of the
entire feed element (this is not the original
document but a rebuilt version)
getXpath()
Returns the DOMXPath object
used internally to run queries on the
DOMDocument object (this
includes core and Extension namespaces
pre-registered)
getXpathPrefix()
Returns the valid DOM path prefix prepended
to all XPath queries matching the feed being queried
getEncoding()
Returns the encoding of the source XML document
(note: this cannot account for errors such as the
server sending documents in a different encoding)
count()
Returns a count of the entries or items this feed contains
(implements SPL Countable
interface)
current()
Returns either the current entry (using the current index
from key())
key()Returns the current entry indexnext()Increments the entry index value by onerewind()Resets the entry index to 0valid()
Checks that the current entry index is valid, i.e.
it does fall below 0 and does not exceed the number
of entries existing.
getExtensions()
Returns an array of all Extension objects loaded for
the current feed (note: both feed-level and entry-level Extensions
exist, and only feed-level Extensions are returned here).
The array keys are of the form {ExtensionName}_Feed.
getExtension(string $name)
Returns an Extension object for the feed registered under the
provided name. This allows more fine-grained access to
Extensions which may otherwise be hidden within the implementation
of the standard API methods.
getType()
Returns a static class constant (e.g.
Zend_Feed_Reader::TYPE_ATOM_03,
i.e. Atom 0.3) indicating exactly what kind of feed
is being consumed.
Retrieving Entry/Item Information
Retrieving information for specific entries or items (depending on
whether you speak Atom or RSS) is identical to feed level data.
Accessing entries is simply a matter of iterating over a Feed object
or using the SPL Iterator interface Feed
objects implement and calling the appropriate method on each.
Entry Level API MethodsgetId()Returns a unique ID for the current entrygetTitle()Returns the title of the current entrygetDescription()Returns a description of the current entrygetLink()
Returns a URI to the HTML version
of the current entry
getPermaLink()
Returns the permanent link to the current entry
getAuthors()
Returns an array of all authors associated with this entry
including email address in the author string if available
getAuthor($index = 0)
Returns either the first author known, or with the
optional $index parameter any specific
index on the array of Authors (returning null if an
invalid index).
getDateCreated()
Returns the date on which the current entry was
created. Generally only applicable to Atom where it
represents the date the resource described by an
Atom 1.0 document was created.
getDateModified()
Returns the date on which the current entry was last
modified
getContent()
Returns the content of the current entry (this has any
entities reversed if possible assuming the content type is
HTML). The description is returned if a
separate content element does not exist.
getCommentCount()
Returns the number of comments made on this entry at the
time the feed was last generated
getCommentLink()
Returns a URI pointing to the HTML
page where comments can be made on this entry
getCommentFeedLink(string $type =
'atom'|'rss')
Returns a URI pointing to a feed of the provided type
containing all comments for this entry (type defaults to
Atom/RSS depending on current feed type).
The extended API for entries is identical to that for feeds with the
exception of the Iterator methods which are not needed here.
There is often confusion over the concepts of modified and
created dates. In Atom, these are two clearly defined concepts
(so knock yourself out) but in RSS they are vague.
RSS 2.0
defines a single <pubDate> element
which typically refers to the date this entry was published,
i.e. a creation date of sorts. This is not always the case, and
it may change with updates or not. As a result, if you really
want to check whether an entry has changed, don't rely on the
results of getDateModified(). Instead,
consider tracking the MD5 hash of three other elements
concatenated, e.g. using getTitle(),
getDescription() and
getContent(). If the entry was trully
updated, this hash computation will give a different result than
previously saved hashes for the same entry. Further muddying the
waters, dates in feeds may follow different standards. Atom and
Dublin Core dates should follow ISO 8601,
and RSS dates should
follow RFC 822 or RFC 2822
which is also common. Date methods
will throw an exception if Zend_Date
cannot load the date string using one of the above standards.
The values returned from these methods are not validated. This
means users must perform validation on all retrieved data
including the filtering of any HTML such as from
getContent() before it is output from
your application. Remember that most feeds come from external
sources, and therefore the default assumption should be that
they cannot be trusted.
Extended Entry Level API MethodsgetDomDocument()
Returns the parent
DOMDocument object for the
entire feed (not just the current entry)
getElement()
Returns the current entry level
DOMElement object
getXpath()
Returns the DOMXPath object
used internally to run queries on the
DOMDocument object (this
includes core and Extension namespaces
pre-registered)
getXpathPrefix()
Returns the valid DOM path prefix prepended
to all XPath queries matching the entry being queried
getEncoding()
Returns the encoding of the source XML document
(note: this cannot account for errors such as the server sending
documents in a different encoding)
getExtensions()
Returns an array of all Extension objects loaded for
the current entry (note: both feed-level and entry-level
Extensions exist, and only entry-level Extensions are returned
here). The array keys are in the form {ExtensionName}_Entry.
getExtension(string $name)
Returns an Extension object for the entry registered under the
provided name. This allows more fine-grained access to
Extensions which may otherwise be hidden within the implementation
of the standard API methods.
getType()
Returns a static class constant (e.g.
Zend_Feed_Reader::TYPE_ATOM_03,
i.e. Atom 0.3) indicating exactly what kind
of feed is being consumed.
Extending Feed and Entry APIs
Extending Zend_Feed_Reader allows you to add
methods at both the feed and entry level which cover the retrieval
of information not already supported by
Zend_Feed_Reader. Given the number of
RSS and
Atom extensions that exist, this is a good thing since
Zend_Feed_Reader couldn't possibly add
everything.
There are two types of Extensions possible, those which retrieve
information from elements which are immediate children of the root
element (e.g. <channel> for RSS or
<feed> for Atom) and those who retrieve
information from child elements of an entry (e.g.
<item> for RSS or <entry> for
Atom). On the filesystem these are grouped as classes within
a namespace based on the extension standard's name. For
example, internally we have
Zend_Feed_Reader_Extension_DublinCore_Feed
and Zend_Feed_Reader_Extension_DublinCore_Entry
classes which are two Extensions implementing Dublin Core
1.0/1.1 support.
Extensions are loaded into Zend_Feed_Reader
using Zend_Loader_PluginLoader, so their operation
will be familiar from other Zend Framework components.
Zend_Feed_Reader already bundles a number of
these Extensions, however those which are not used internally and
registered by default (so called Core Extensions) must be registered
to Zend_Feed_Reader before they are used. The
bundled Extensions include:
Core Extensions (pre-registered)DublinCore (Feed and Entry)Implements support for Dublin Core Metadata Element Set 1.0
and 1.1 Content (Entry only)Implements support for Content 1.0Atom (Feed and Entry)Implements support for Atom 0.3 and Atom 1.0SlashImplements support for the Slash RSS 1.0 moduleWellFormedWebImplements support for the Well Formed Web CommentAPI 1.0ThreadImplements support for Atom Threading Extensions as described
in RFC 4685PodcastImplements support for the Podcast 1.0 DTD from Apple
The Core Extensions are somewhat special since they are extremely
common and multi-faceted. For example, we have a Core Extension for Atom.
Atom is implemented as an Extension (not just a base class) because it
doubles as a valid RSS module - you can insert
Atom elements into RSS feeds. I've even seen
RDF feeds which use a lot of Atom in place of more
common Extensions like Dublin Core.
Non-Core Extensions (must register manually)SyndicationImplements Syndication 1.0 support for RSS feedsCreativeCommonsA RSS module that adds an element at the <channel>
or <item> level that specifies which Creative Commons license
applies.
The additional non-Core Extensions are offered but not registered to
Zend_Feed_Reader by default. If you want to
use them, you'll need to tell
Zend_Feed_Reader to load them in advance of
importing a feed. Additional non-Core Extensions will be included
in future iterations of the component.
Registering an Extension with
Zend_Feed_Reader, so it is loaded and its API
is available to Feed and Entry objects, is a simple affair using the
Zend_Loader_PluginLoader. Here we register
the optional Slash Extension, and discover that it can be directly
called from the Entry level API without any effort. Note that
Extension names are case sensitive and use camel casing for multiple
terms.
current()->getUpdatePeriod();
]]>
In the simple example above, we checked how frequently a feed is being updated
using the getUpdatePeriod()
method. Since it's not part of
Zend_Feed_Reader's core API, it could only be
a method supported by the newly registered Syndication Extension.
As you can also notice, the new methods from Extensions are accessible from the main
API using PHP's magic methods. As an alternative,
you can also directly access any Extension object for a similar result as seen below.
getExtension('Syndication');
$updatePeriod = $syndication->getUpdatePeriod();
]]>Writing Zend_Feed_Reader Extensions
Inevitably, there will be times when the
Zend_Feed_Reader API is just not capable
of getting something you need from a feed or entry. You can use
the underlying source objects, like
DOMDocument, to get these by hand however
there is a more reusable method available by writing Extensions
supporting these new queries.
As an example, let's take the case of a purely fictitious
corporation named Jungle Books. Jungle Books have been
publishing a lot of reviews on books they sell (from external
sources and customers), which are distributed as an RSS 2.0
feed. Their marketing department realises that web applications
using this feed cannot currently figure out exactly what book is
being reviewed. To make life easier for everyone, they determine
that the geek department needs to extend RSS 2.0 to include a
new element per entry supplying the ISBN-10 or
ISBN-13 number of
the publication the entry concerns. They define the new
<isbn> element quite simply with a standard
name and namespace URI:
A snippet of RSS containing this extension in practice could be
something similar to:
Jungle Books Customer Reviews
http://example.com/junglebooks
Many book reviews!Fri, 26 Jun 2009 19:15:10 GMThttp://example.com/junglebooks/book/938Review Of Flatland: A Romance of Many Dimensions
http://example.com/junglebooks/review/987
Confused Physics Student
A romantic square?!
Thu, 25 Jun 2009 20:03:28 -0700048627263X
]]>
Implementing this new ISBN element as a simple entry level
extension would require the following class (using your own class
namespace outside of Zend).
_data['isbn'])) {
return $this->_data['isbn'];
}
$isbn = $this->_xpath->evaluate(
'string(' . $this->getXpathPrefix() . '/jungle:isbn)'
);
if (!$isbn) {
$isbn = null;
}
$this->_data['isbn'] = $isbn;
return $this->_data['isbn'];
}
protected function _registerNamespaces()
{
$this->_xpath->registerNamespace(
'jungle', 'http://example.com/junglebooks/rss/module/1.0/'
);
}
}
]]>
This extension is easy enough to follow. It creates a new method
getIsbn() which runs an XPath query on
the current entry to extract the ISBN number enclosed by the
<jungle:isbn> element. It can optionally
store this to the internal non-persistent cache (no need to keep
querying the DOM if it's called again on the same entry). The
value is returned to the caller. At the end we have a protected
method (it's abstract so it must exist) which registers the
Jungle Books namespace for their custom RSS module. While we
call this an RSS module, there's nothing to prevent the same
element being used in Atom feeds - and all Extensions which use
the prefix provided by getXpathPrefix()
are actually neutral and work on RSS or Atom feeds with no
extra code.
Since this Extension is stored outside of Zend Framework, you'll
need to register the path prefix for your Extensions so
Zend_Loader_PluginLoader can find them.
After that, it's merely a matter of registering the Extension,
if it's not already loaded, and using it in practice.
current()->getIsbn();
]]>
Writing a feed level Extension is not much different. The
example feed from earlier included an unmentioned
<jungle:dayPopular> element which Jungle
Books have added to their standard to include a link to the
day's most popular book (in terms of visitor traffic). Here's
an Extension which adds a
getDaysPopularBookLink() method to the
feel level API.
_data['dayPopular'])) {
return $this->_data['dayPopular'];
}
$dayPopular = $this->_xpath->evaluate(
'string(' . $this->getXpathPrefix() . '/jungle:dayPopular)'
);
if (!$dayPopular) {
$dayPopular = null;
}
$this->_data['dayPopular'] = $dayPopular;
return $this->_data['dayPopular'];
}
protected function _registerNamespaces()
{
$this->_xpath->registerNamespace(
'jungle', 'http://example.com/junglebooks/rss/module/1.0/'
);
}
}
]]>
Let's repeat the last example using a custom Extension to show the
method being used.
getDaysPopularBookLink();
// ISBN for whatever book the first entry in the feed was concerned with
$firstIsbn = $feed->current()->getIsbn();
]]>
Going through these examples, you'll note that we don't register
feed and entry Extensions separately. Extensions within the same
standard may or may not include both a feed and entry class, so
Zend_Feed_Reader only requires you to
register the overall parent name, e.g. JungleBooks, DublinCore,
Slash. Internally, it can check at what level Extensions exist
and load them up if found. In our case, we have a full set of
Extensions now: JungleBooks_Feed and
JungleBooks_Entry.