Zend_Feed_Reader.xml 70 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 18514 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.feed.reader">
  5. <title>Zend_Feed_Reader</title>
  6. <sect2 id="zend.feed.reader.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. <classname>Zend_Feed_Reader</classname> ist eine Komponente die verwendet wird um
  10. <acronym>RSS</acronym> und Atom Feeds jeder Version zu konsumieren, inklusive
  11. <acronym>RDF</acronym>/<acronym>RSS</acronym> 1.0, <acronym>RSS</acronym> 2.0 und
  12. Atom 0.3/1.0. Die <acronym>API</acronym> für das Empfangen von Feed Daten ist relativ
  13. einfach da <classname>Zend_Feed_Reader</classname> in der Lage ist jeden Feed eines
  14. jeden Typs mit Hilfe der <acronym>API</acronym> nach den angefragten Informationen zu
  15. durchsuchen. Wenn die typischen Elemente die diese Informationen enthalten nicht
  16. vorhanden sind, werden diese adaptiert und statt dessen auf eine Vielzahl von
  17. alternativen Elementen zurück gegriffen. Diese Fähigkeit, von Alternativen auszuwählen,
  18. verhindert das Benutzer Ihren eigenen astrakten Layer über die Komponente legen müssen
  19. damit Sie nützlich ist, oder beliebig tiefes Wissen des zugrundeliegenden Standard,
  20. aktueller alternativen und namespaces Erweiterungen haben müssen.
  21. </para>
  22. <para>
  23. Intern arbeitet <classname>Zend_Feed_Reader</classname> fast komplett auf Basis der
  24. Erstellung von XPath Abfragen gegen das Dokument Objekt Modell des Feed
  25. <acronym>XML</acronym>'s. Das <acronym>DOM</acronym> wird nicht durch eine gekettete
  26. Eigenschaften <acronym>API</acronym> wie bei <classname>Zend_Feed</classname> bekannt
  27. gegeben und durch die darunterliegenden <classname>DOMDocument</classname>,
  28. <classname>DOMElement</classname> und <classname>DOMXPath</classname> Objekte für eine
  29. externe Manipulation bekannt gegeben. Dieser Singular Weg des Parsens ist Konsistent
  30. und die Komponente bietet ein Plugin System um dem Feed hinzuzufügen und eine Eintrags
  31. Level <acronym>API</acronym> durch das Schreiben von Erweiterungen auf einer ähnlichen
  32. Basis.
  33. </para>
  34. <para>
  35. Geschwindigkeit wird auf drei Wegen bereitgestellt. Erstens unterstützt
  36. <classname>Zend_Feed_Reader</classname> das Cachen durch Verwendung von
  37. <classname>Zend_Cache</classname> um eine Kopie des Originalen Feed
  38. <acronym>XML</acronym> zu halten. Das erlaubt es Netzwerk Anfragen für eine Feed
  39. <acronym>URI</acronym> zu überspringen wenn der Cache gültig ist. Zweitens wird die
  40. Feed und Eintrag- Level <acronym>API</acronym> durch einen internen Cache gesichert
  41. (nicht persistent) damit wiederholte <acronym>API</acronym> Aufrufe für den gleichen
  42. Feed eine zusätzliche Verwendung von <acronym>DOM</acronym>/XPath verhindert.
  43. Drittens erlaubt das Importieren von Feeds von einer <acronym>URI</acronym> den
  44. Vorteil von konditionellen <acronym>HTTP</acronym> GET Anfragen was es Servern
  45. erlaubt eine leere 304 Anfrage auszulösen wenn der angefragte Fed seit der Zeit zu der
  46. er das letzte Mal angefragt wurde, nicht verändert wurde. Im letzten Fall hält eine
  47. Instanz von <classname>Zend_Cache</classname> den zuletzt empfangenen Feed zusammen mit
  48. dem ETag und dem Last-Modified Header Werten die in der <acronym>HTTP</acronym>
  49. Antwort gesendet wurde.
  50. </para>
  51. <para>
  52. Relativ zu <classname>Zend_Feed</classname> wurde
  53. <classname>Zend_Feed_Reader</classname> als frei stehender Ersatz für
  54. <classname>Zend_Feed</classname> formuliert der aber nicht mit
  55. <classname>Zend_Feed</classname> rückwärts kompatibel ist. Aber es ist eine Alternative
  56. die einer anderen Ideologie folgt die darin fokusiert ist einfach verwendbar zu sein,
  57. flexibel, konsistent und durch das Plugin System erweiterbar.
  58. <classname>Zend_Feed_Reader</classname> ist auch nicht dazu fähig Feeds zu erstellen,
  59. das wird aber zu einem späteren Zeitpunkt hinzugefügt.
  60. </para>
  61. </sect2>
  62. <sect2 id="zend.feed.reader.import">
  63. <title>Feeds importieren</title>
  64. <para>
  65. Das importieren eines Feeds mit <classname>Zend_Feed_Reader</classname> ist zu
  66. <classname>Zend_Feed</classname> nicht sehr unterschiedlich. Feeds können von einem
  67. String, einer Datei, <acronym>URI</acronym> oder einer Instanz des Typs
  68. <classname>Zend_Feed_Abstract</classname> importiert werden. Das importieren von einer
  69. <acronym>URI</acronym> kann zusätzlich eine konditionelle <acronym>HTTP</acronym>
  70. GET Anfrage benützen. Wenn das importieren fehlschlägt, wird eine Exception geworfen.
  71. Das Endergebnis wird ein Objekt des Typs
  72. <classname>Zend_Feed_Reader_FeedInterface</classname> sein, die Core Implementation
  73. von <classname>Zend_Feed_Reader_Feed_Rss</classname> und
  74. <classname>Zend_Feed_Reader_Feed_Atom</classname> (<classname>Zend_Feed</classname>
  75. hat alle kurzen Namen genommen!). Beide Objekte unterstützen mehrere (alle
  76. existierenden) Versionen dieser breiten Feed Typen.
  77. </para>
  78. <para>
  79. Im folgenden Beispiel importieren wir einen
  80. <acronym>RDF</acronym>/<acronym>RSS</acronym> 1.0 Feed und extrahieren einige
  81. grundsätzliche Information die dann in einer Datenbank oder wo anders gespeichert
  82. werden können.
  83. </para>
  84. <programlisting language="php"><![CDATA[
  85. $feed = Zend_Feed_Reader::import('http://www.planet-php.net/rdf/');
  86. $data = array(
  87. 'title' => $feed->getTitle(),
  88. 'link' => $feed->getLink(),
  89. 'dateModified' => $feed->getDateModified(),
  90. 'description' => $feed->getDescription(),
  91. 'language' => $feed->getLanguage(),
  92. 'entries' => array(),
  93. );
  94. foreach ($feed as $entry) {
  95. $edata = array(
  96. 'title' => $entry->getTitle(),
  97. 'description' => $entry->getDescription(),
  98. 'dateModified' => $entry->getDateModified(),
  99. 'author' => $entry->getAuthor(),
  100. 'link' => $entry->getLink(),
  101. 'content' => $entry->getContent()
  102. );
  103. $data['entries'][] = $edata;
  104. }
  105. ]]></programlisting>
  106. <para>
  107. Das obige Beispiel demonstriert die <acronym>API</acronym> von
  108. <classname>Zend_Feed_Reader</classname> und es demonstriert auch einige seiner
  109. internen Operationen. In Wirklichkeit hat der ausgewählte <acronym>RDF</acronym> Feed
  110. keine nativen Daten oder Author Elemente, trotzdem verwendet er das Dublin Core 1.1
  111. Modul welches Namespaced Ersteller und Datums Elemente anbietet.
  112. <classname>Zend_Feed_Reader</classname> fällt auf diese und ähnliche Operationen zurück
  113. wenn keine relativ nativen Elemente existieren. Wenn es absolut keine alternative
  114. finden kann wird es <constant>NULL</constant> zurückgeben, was anzeigt das die
  115. Informationen nicht im Feed gefunden werden können. Man sollte beachten das Klassen die
  116. <classname>Zend_Feed_Reader_FeedInterface</classname> implementieren auch
  117. die <acronym>SPL</acronym> Interfaces <classname>Iterator</classname> und
  118. <classname>Countable</classname> implementieren.
  119. </para>
  120. <para>
  121. Feeds können auch von Strings, Dateien und sogar Objekten des Typs
  122. <classname>Zend_Feed_Abstract</classname> importiert werden.
  123. </para>
  124. <programlisting language="php"><![CDATA[
  125. // von einer URI
  126. $feed = Zend_Feed_Reader::import('http://www.planet-php.net/rdf/');
  127. // von einem String
  128. $feed = Zend_Feed_Reader::importString($feedXmlString);
  129. // von einer Datei
  130. $feed = Zend_Feed_Reader::importFile('./feed.xml');
  131. // von einem abstrakten Zend_Feed_Abstract Objekt
  132. $zfeed = Zend_Feed::import('http://www.planet-php.net/atom/');
  133. $feed = Zend_Feed_Reader::importFeed($zfeed);
  134. ]]></programlisting>
  135. </sect2>
  136. <sect2 id="zend.feed.reader.sources">
  137. <title>Empfangen darunterliegender Quellen von Feeds und Einträgen</title>
  138. <para>
  139. <classname>Zend_Feed_Reader</classname> macht sein bestes um Ihnen die Details
  140. abzunehmen. Wenn man an einem Feed ausserhalb von
  141. <classname>Zend_Feed_Reader</classname> arbeiten muß, kann man das grundsätzliche
  142. <classname>DOMDocument</classname> oder <classname>DOMElement</classname> von jeder
  143. Klasse extrahieren, oder sogar einen <acronym>XML</acronym> String der sie enthält.
  144. Es werden auch Methoden angeboten um das aktuelle <classname>DOMXPath</classname>
  145. Objekt (mit allen registrierten Kern und Erweiterungs Namespaces) zu extrahieren, und
  146. den richtigen Präfix der in allen XPath Anfragen für den aktuellen Feed oder Eintrag
  147. verwendet wird. Die grundsätzlich zu verwenden Methoden (für jedes Objekt) sind
  148. <methodname>saveXml()</methodname>, <methodname>getDomDocument()</methodname>,
  149. <methodname>getElement()</methodname>, <methodname>getXpath()</methodname> und
  150. <methodname>getXpathPrefix()</methodname>. Diese erlauben es sich von
  151. <classname>Zend_Feed_Reader</classname> zu lösen und das zu tun was man selbst
  152. machen will.
  153. </para>
  154. <itemizedlist>
  155. <listitem>
  156. <para>
  157. <methodname>saveXml()</methodname> gibt einen <acronym>XML</acronym> String
  158. zurück der nur das Element enthält welches das aktuelle Objekt repräsentiert.
  159. </para>
  160. </listitem>
  161. <listitem>
  162. <para>
  163. <methodname>getDomDocument()</methodname> gibt das
  164. <classname>DOMDocument</classname> Objekt zurück das den kompletten Feed
  165. repräsentiert (sogar wenn es von einem Entry Objekt aus aufgerufen wird).
  166. </para>
  167. </listitem>
  168. <listitem>
  169. <para>
  170. <methodname>getElement()</methodname> gibt das <classname>DOMElement</classname>
  171. des aktuellen Objekts zurück (z.B. den Feed oder aktuellen Eintrag).
  172. </para>
  173. </listitem>
  174. <listitem>
  175. <para>
  176. <methodname>getXpath()</methodname> gibt das aktuelle
  177. <classname>DOMXPath</classname> Objekt für den aktuellen Feed zurück (sogar wenn
  178. es von einem Entry Objekt aus aufgerufen wird) mit den Namespaces des aktuellen
  179. Feed Typs und allen vor-registrierten geladenen Erweiterungen.
  180. </para>
  181. </listitem>
  182. <listitem>
  183. <para>
  184. <methodname>getXpathPrefix()</methodname> gibt den Präfix der Abfrage für das
  185. aktuelle Objekt zurück (z.B. den Feed oder den aktuellen Eintrag) welcher den
  186. richtigen XPath Query Pfad für den spezifizierten Feed oder Eintrag enthält.
  187. </para>
  188. </listitem>
  189. </itemizedlist>
  190. <para>
  191. Hier ist ein Beispiel bei dem ein Feed eine <acronym>RSS</acronym> Erweiterung enthalten
  192. können die von <classname>Zend_Feed_Reader</classname> nicht out of the Box unterstützt
  193. wird. Beachtenswert ist, das man eine Erweiterungen schreiben und registrieren könnte
  194. (wird später behandelt) um das zu bewerkstelligen, aber das ist nicht immer eine
  195. Garantie für einen schnellen Check. Man muß jeden neuen Namespace beim
  196. <classname>DOMXPath</classname> Objekt registrieren bevor es verwendet wird ausser Sie
  197. werden vorab von <classname>Zend_Feed_Reader</classname> oder einer Erweiterung
  198. registriert.
  199. </para>
  200. <programlisting language="php"><![CDATA[
  201. $feed = Zend_Feed_Reader::import('http://www.planet-php.net/rdf/');
  202. $xpathPrefix = $feed->getXpathPrefix();
  203. $xpath = $feed->getXpath();
  204. $xpath->registerNamespace('admin', 'http://webns.net/mvcb/');
  205. $reportErrorsTo = $xpath->evaluate('string('
  206. . $xpathPrefix
  207. . '/admin:errorReportsTo)');
  208. ]]></programlisting>
  209. <warning>
  210. <para>
  211. Wenn man einen bereits registrierten Namespace mit einem anderen Präfix Namen
  212. registriert als jenen der von <classname>Zend_Feed_Reader</classname> intern
  213. verwendet wird, zerstört das die Interne Arbeitsweise dieser Komponente.
  214. </para>
  215. </warning>
  216. </sect2>
  217. <sect2 id="zend.feed.reader.cache-request">
  218. <title>Unterstützung für Caches und intelligente Anfragen</title>
  219. <sect3 id="zend.feed.reader.cache-request.cache">
  220. <title>Unterstützung für Caches in Zend_Feed_Reader hinzufügen</title>
  221. <para>
  222. <classname>Zend_Feed_Reader</classname> unterstützt die Verwendung einer Instanz von
  223. <classname>Zend_Cache</classname> um Feeds zu cachen (als <acronym>XML</acronym>)
  224. um unnötige Anfragen im Netzwerk zu vermeiden. Das Hinzufügen eines Caches ist hier
  225. so einfach wie bei anderen Zend Framework Komponenten. Den Cache erstellen und
  226. konfigurieren und dann <classname>Zend_Feed_Reader</classname> mitteilen das er
  227. verwendet werden soll! Der verwendete Cache Schlüssel ist
  228. "<classname>Zend_Feed_Reader_</classname>" gefolgt von dem
  229. <acronym>MD5</acronym> Hash der <acronym>URI</acronym> des Feeds.
  230. </para>
  231. <programlisting language="php"><![CDATA[
  232. $frontendOptions = array(
  233. 'lifetime' => 7200,
  234. 'automatic_serialization' => true
  235. );
  236. $backendOptions = array('cache_dir' => './tmp/');
  237. $cache = Zend_Cache::factory(
  238. 'Core', 'File', $frontendOptions, $backendOptions
  239. );
  240. Zend_Feed_Reader::setCache($cache);
  241. ]]></programlisting>
  242. <note>
  243. <para>
  244. Auch wenn es etwas abseits ist, sollte man daran denken zu
  245. <classname>Zend_Loader_PluginLoader</classname> einen Cache hinzuzufügen der
  246. von <classname>Zend_Feed_Reader</classname> verwendet wird um Erweiterungen zu
  247. laden.
  248. </para>
  249. </note>
  250. </sect3>
  251. <sect3 id="zend.feed.reader.cache-request.http-conditional-get">
  252. <title>Unterstützung für HTTP Conditional GET</title>
  253. <para>
  254. Die große Frage wenn man ofters einen Feed importiert, ist ob er sich geändert hat.
  255. Wenn ein Cache aktiviert ist, kann man die Unterstützung für <acronym>HTTP</acronym>
  256. Conditional GET hinzufügen um diese Frage zu beantworten.
  257. </para>
  258. <para>
  259. Durch Verwendung dieser Methode kann man Feeds von <acronym>URI</acronym> anfragen
  260. und deren letzte bekannte Werte der ETag und Last-Modified Antwort Header mit der
  261. Anfrage inkludieren (wobei die If-None-Match und If-Modified-Since Header verwendet
  262. werden). Wenn der Feed auf dem Server unverändert ist, sollte man eine 304 Antwort
  263. empfangen die <classname>Zend_Feed_Reader</classname> mitteilt das die gecachte
  264. Version zu verwenden ist. Wenn ein kompletter Feed in einer Antwort mit einem Status
  265. Code von 200 geschickt wird, bedeutet dieses, das der Feed verändert wurde und
  266. <classname>Zend_Feed_Reader</classname> wird die neue Version parsen und Sie im
  267. Cache abspeichern. Es werden auch die neuen Werte der ETag und Last-Modified Header
  268. für eine zukünftige Verwendung gespeichert.
  269. </para>
  270. <para>
  271. Bei diesen "konditionalen" Abfragen ist nicht garantiert das Sie, vom Server von dem
  272. man eine <acronym>URI</acronym> abfragt, unterstützt werden, können aber trotzdem
  273. angefragt werden. Die meisten Feed Quellen wie Blogs sollten hierfür eine
  274. Unterstützung haben. Um konditionale Anfragen zu erlauben, muss man einen Cache
  275. bei <classname>Zend_Feed_Reader</classname> angeben.
  276. </para>
  277. <programlisting language="php"><![CDATA[
  278. $frontendOptions = array(
  279. 'lifetime' => 86400,
  280. 'automatic_serialization' => true
  281. );
  282. $backendOptions = array('cache_dir' => './tmp/');
  283. $cache = Zend_Cache::factory(
  284. 'Core', 'File', $frontendOptions, $backendOptions
  285. );
  286. Zend_Feed_Reader::setCache($cache);
  287. Zend_Feed_Reader::useHttpConditionalGet();
  288. $feed = Zend_Feed_Reader::import('http://www.planet-php.net/rdf/');
  289. ]]></programlisting>
  290. <para>
  291. Im obige Beispiel werden, bei aktivierten <acronym>HTTP</acronym> Conditional GET
  292. Anfragen, die Werte der Antwort Header für ETag und Last-Modified mit dem Feed
  293. gecacht. Für die nächsten 24 Stunden (die Lebenszeit des Caches) werden Feed am
  294. Cache nur dann aktualisiert wenn eine nicht-304 Antwort empfangen wird, die ein
  295. gültiges <acronym>RSS</acronym> oder Atom <acronym>XML</acronym> Dokument enthält.
  296. </para>
  297. <para>
  298. Wenn man darauf anzielt die Antwort Header ausserhalb von
  299. <classname>Zend_Feed_Reader</classname> zu managen, kann man die relevanten
  300. If-None-Matches und If-Modified-Since Antwort Header über die <acronym>URI</acronym>
  301. Import Methode setzen.
  302. </para>
  303. <programlisting language="php"><![CDATA[
  304. $lastEtagReceived = '5e6cefe7df5a7e95c8b1ba1a2ccaff3d';
  305. $lastModifiedDateReceived = 'Wed, 08 Jul 2009 13:37:22 GMT';
  306. $feed = Zend_Feed_Reader::import(
  307. $uri, $lastEtagReceived, $lastModifiedDateReceived
  308. );
  309. ]]></programlisting>
  310. </sect3>
  311. </sect2>
  312. <sect2 id="zend.feed.reader.locate">
  313. <title>Feed URIs von Webseiten erkennen</title>
  314. <para>
  315. Dieser Tage ist vielen Webseiten bekannt das der Ort Ihrer <acronym>XML</acronym> Feeds
  316. nicht immer eindeutig ist. Eine kleine <acronym>RDF</acronym>, <acronym>RSS</acronym>
  317. oder Atom Grafik hilft wenn der Benutzer die Seite liest, aber was wenn eine Maschine
  318. kommt und versucht herauszufinden So die Feed sind? Um hierbei zu helfen, zeigen viele
  319. Webseiten zu Ihren Feeds indem &lt;link&gt; Tags in der &lt;head&gt; Sektion Ihres
  320. <acronym>HTML</acronym>s verwendet werden. Um diesen Vorteil zu nutzen, kann man
  321. <classname>Zend_Feed_Reader</classname> verwenden diese Feeds zu erkennen, indem die
  322. statische <methodname>findFeedLinks()</methodname> Methode verwendet wird.
  323. </para>
  324. <para>
  325. Diese Methode ruft irgendeine <acronym>URI</acronym> auf und sucht nach dem Ort der
  326. <acronym>RSS</acronym>, <acronym>RDF</acronym> und Atom Feeds mit der Annahme dass das
  327. <acronym>HTML</acronym> der Webseite nur die relevanten Links enthält. Sie gibt dann ein
  328. Wert Objekt zurück indem man die Existenz einer <acronym>RSS</acronym>,
  329. <acronym>RDF</acronym> oder Atom Feed <acronym>URI</acronym> prüfen kann.
  330. </para>
  331. <para>
  332. Das zurückgegebene Objekt ist ein <classname>ArrayObject</classname> welches
  333. <classname>Zend_Feed_Reader_FeedSet</classname> heisst, damit es in ein Array gecastet
  334. werden kann, oder damit man es iterieren kann um auf alle erkannten Links zuzugreifen.
  335. Trotzdem kann man, als einfache Abkürzung, den ersten RSS, RDF oder Atom Link holen
  336. indem dessen öffentliche Eigenschaft wie im beiliegenden Beispiel verwendet wird.
  337. </para>
  338. <programlisting language="php"><![CDATA[
  339. $links = Zend_Feed_Reader::findFeedLinks('http://www.planet-php.net');
  340. if(isset($links->rdf)) {
  341. echo $links->rdf, "\n"; // http://www.planet-php.org/rdf/
  342. }
  343. if(isset($links->rss)) {
  344. echo $links->rss, "\n"; // http://www.planet-php.org/rss/
  345. }
  346. if(isset($links->atom)) {
  347. echo $links->atom, "\n"; // http://www.planet-php.org/atom/
  348. }
  349. ]]></programlisting>
  350. <para>
  351. Basierend auf diesen Links kann man dann, von welchen Quellen man auch immer will,
  352. importieren indem die übliche Vorgehensweise verwendet wird.
  353. </para>
  354. <para>
  355. Diese schnelle Methode gibt nur einen Link für jeden Feed Typ zurück, aber Webseiten
  356. können viele Links von jedem Typ enthalten. Möglicherweise ist es eine News Site mit
  357. einem RSS Feed für jede News Kategorie. Man kann durch alle Links iterieren indem
  358. der ArrayObject Iterator verwendet wird.
  359. </para>
  360. <programlisting language="php"><![CDATA[
  361. $links = Zend_Feed_Reader::findFeedLinks('http://www.planet-php.net');
  362. foreach ($links as $link) {
  363. echo $link['href'], "\n";
  364. }
  365. ]]></programlisting>
  366. <para>
  367. Die möglichen Schlüssel sind <emphasis>href</emphasis>, <emphasis>rel</emphasis> der
  368. immer 'alternate' ist, <emphasis>type</emphasis> welcher
  369. <code>application/rss+xml</code>, <code>application/rdf+xml</code> oder
  370. <code>application/atom+xml</code> ist, und <emphasis>feed</emphasis>.
  371. <emphasis>feed</emphasis>. ist nur vorhanden wenn man <classname>ArrayObject</classname>
  372. erhält (es also nicht in ein Array castet) und dessen Verwendung führt zu einem
  373. Versuch den Feed in eine <classname>Zend_Feed_Reader_FeedAbstract</classname> Instanz
  374. zu laden. Das ist ein Versuch des Lazy Loadings - Feeds werden trotzdem geladen sobald
  375. man versucht auf Sie zuzugreifen indem diese Methode verwendet wird.
  376. </para>
  377. </sect2>
  378. <sect2 id="zend.feed.reader.retrieve-info">
  379. <title>Empfangen von Feed Informationen</title>
  380. <para>
  381. Das Empfangen von Informationen von einem Feed (wir reden über Einträge und Elemente in
  382. der nächsten Sektion da Sie identischen Prinzipien folgen) verwendet eine klar
  383. definierte <acronym>API</acronym> welche exakt die gleiche ist, unabhängig davon ob der
  384. angefragte Feed <acronym>RSS</acronym>/<acronym>RDF</acronym>/Atom ist. Das selbe gilt
  385. für Sub-Versionen dieser Standards da wir jede einzelne <acronym>RSS</acronym> und Atom
  386. Version getestet haben. Wärend sich der darunterliegende <acronym>XML</acronym> Feed
  387. substantiell unterscheiden kann, im Sinne von Tags und Elementen die vorhanden sind,
  388. versuchen trotzdem alle ähnliche Informationen zu geben und um das alles zu reflektieren
  389. werden unterschiede und das Hanteln durch alternative Tags intern von
  390. <classname>Zend_Feed_Reader</classname> behandelt welche einem ein identisches Interface
  391. für jeden anzeigt. Idealerweise sollte man sich nicht darum kümmern ob ein Feed
  392. <acronym>RSS</acronym> oder Atom ist, solange man die Informationen extrahieren kann
  393. die man benötigt.
  394. </para>
  395. <para>
  396. Natürlich leben wir nicht in einer idealen Welt sodas es Zeiten gibt in denen die
  397. <acronym>API</acronym> einfach nicht das bietet wonach man sucht. Um hierbei zu helfen
  398. bietet <classname>Zend_Feed_Reader</classname> ein Plugin System an das es erlaubt
  399. Erweiterungen zu schreiben und die Kern <acronym>API</acronym> zu erweitern sowie
  400. alle zusätzliche Daten abzudecken die man von Feeds extrahieren will. Wenn das schreiben
  401. einer weiteren Erweiterung zu problematisch ist, kann man einfach das darunterliegende
  402. <acronym>DOM</acronym> oder die XPath Objekte holen und das von Hand in der Anwendung
  403. machen. Natürlich sollte wirklich eine Erweiterung geschrieben werden, einfach um es
  404. portabler und wiederverwendbarer zu machen.
  405. </para>
  406. <para>
  407. Hier ist eine Zusammenfassung der Kern <acronym>API</acronym> für Feeds. Man sollte
  408. beachten das es nicht nur die grundsätzlichen <acronym>RSS</acronym> und Atom
  409. Standard abdeckt, sondern das es auch eine Anzahl von mitgelieferten Erweiterungen
  410. gibt die mit <classname>Zend_Feed_Reader</classname> gebündelt sind. Die Benennung
  411. dieser Methoden von Erweiterungen ist recht generisch - alle erweiterten Methoden
  412. arbeiten auf dem gleichen Level wie die Kern <acronym>API</acronym> da wir es
  413. erlauben alle spefizischen Erweiterungs Objekte separat zu empfangen wenn das
  414. notwendig ist.
  415. </para>
  416. <table>
  417. <title>API Methoden auf dem Level des Feeds</title>
  418. <tgroup cols="2">
  419. <tbody>
  420. <row>
  421. <entry><methodname>getId()</methodname></entry>
  422. <entry>
  423. Gibt eine eindeutige ID zurück die mit dem Feed assoziiert ist
  424. </entry>
  425. </row>
  426. <row>
  427. <entry><methodname>getTitle()</methodname></entry>
  428. <entry>Gibt den Titel des Feeds zurück</entry>
  429. </row>
  430. <row>
  431. <entry><methodname>getDescription()</methodname></entry>
  432. <entry>Gibt die textuelle Beschreibung des Feeds zurück</entry>
  433. </row>
  434. <row>
  435. <entry><methodname>getLink()</methodname></entry>
  436. <entry>
  437. Gibt eine <acronym>URI</acronym> zu der <acronym>HTML</acronym> Webseite
  438. zurück welche die gleiche oder ähnliche Informationen wie dieser Feed
  439. enthält (z.B. wenn der Feed von einem Blog ist, sollte die
  440. <acronym>URI</acronym> des Blogs enthalten sein indem die
  441. <acronym>HTML</acronym> Version des Eintrags gelesen werden kann)
  442. </entry>
  443. </row>
  444. <row>
  445. <entry><methodname>getFeedLink()</methodname></entry>
  446. <entry>
  447. Gibt die <acronym>URI</acronym> dieses Feeds zurück, welche die gleiche
  448. sein sollte wie die <acronym>URI</acronym> welche verwendet wurde um
  449. den Feed zu importieren
  450. </entry>
  451. </row>
  452. <row>
  453. <entry><methodname>getAuthors()</methodname></entry>
  454. <entry>
  455. Gibt ein Array aller Authoren zurück die mit diesem Feed assoziiert
  456. sind, inklusive Email Adressen im String des Authors wenn vorhanden
  457. </entry>
  458. </row>
  459. <row>
  460. <entry><methodname>getAuthor(integer $index = 0)</methodname></entry>
  461. <entry>
  462. Gibt entweder den ersten bekannten Author zurück, oder mit dem
  463. optionalen Parameter <varname>$index</varname> jeden spezifischen
  464. Index des Arrays von Authoren (gibt null bei einem ungültigen Index
  465. zurück).
  466. </entry>
  467. </row>
  468. <row>
  469. <entry><methodname>getDateCreated()</methodname></entry>
  470. <entry>
  471. Gibt das Datum zurück zu dem dieser Feed erstellt wurde. Generell nur
  472. anwendbar bei Atom da es das Datum repräsentiert zu der das Atom 1.0
  473. Dokument erstellt wurde das die Ressource beschreibt.
  474. </entry>
  475. </row>
  476. <row>
  477. <entry><methodname>getDateModified()</methodname></entry>
  478. <entry>
  479. Gibt das Datum zurück zu dem der Feed das letzte mal geändert wurde
  480. </entry>
  481. </row>
  482. <row>
  483. <entry><methodname>getLanguage()</methodname></entry>
  484. <entry>
  485. Gibt die Sprache des Feeds zurüc (wenn definiert) oder einfach die
  486. Sprache die im <acronym>XML</acronym> Dokument notiert wurde
  487. </entry>
  488. </row>
  489. <row>
  490. <entry><methodname>getGenerator()</methodname></entry>
  491. <entry>
  492. Gibt den Erzeuger des Feeds zurück, z.B. die Software die Ihm erzeugt
  493. hat. Das kann sich zwischen <acronym>RSS</acronym> und Atom
  494. unterscheiden, da Atom eine andere Schreibweise definiert.
  495. </entry>
  496. </row>
  497. <row>
  498. <entry><methodname>getCopyright()</methodname></entry>
  499. <entry>
  500. Gibt alle Copyright Notizen zurück die mit dem Feed assoziiert sind
  501. </entry>
  502. </row>
  503. <row>
  504. <entry><methodname>getHubs()</methodname></entry>
  505. <entry>
  506. Gibt ein Array der <acronym>URI</acronym> Endpunkte aller Hub Server
  507. zurück welche vom Feed für die Berwendung mit dem Pubsubhubbub
  508. Protokoll bekanntgegeben werden, und erlaubt damit das Einschreiben
  509. für Feeds für Real-Time Updates.
  510. </entry>
  511. </row>
  512. </tbody>
  513. </tgroup>
  514. </table>
  515. <para>
  516. Angehend von der Vielzahl von Feeds in der Wildnis, werden einige dieser Methoden
  517. erwartungsgemäßg <constant>NULL</constant> zurückgeben, was anzeigt das die relevanten
  518. Informationen nicht gefunden wurden. Wo es möglich ist wird
  519. <classname>Zend_Feed_Reader</classname> wärend der Suche auf alternative Elemente
  520. zurück greifen. Zum Beispiel ist das Durchsuchen eines <acronym>RSS</acronym> Feeds
  521. nach einem Modifikations Datum komplizierter als es aussieht. <acronym>RSS</acronym>
  522. Feeds sollten ein <code>&lt;lastBuildDate&gt;</code> Tag und/oder ein
  523. <code>&lt;pubDate&gt;</code> Element enthalten. Aber was wenn Sie es nicht tun, weil es
  524. z.B. ein <acronym>RSS</acronym> 1.0 Feed ist? Vielleicht ist stattdessen ein
  525. <code>&lt;atom:updated&gt;</code> Element mit identischen Informationen vorhanden (Atom
  526. kann verwendet werden um die <acronym>RSS</acronym> Syntax anzubieten)? Bei einem
  527. Fehlschlag können wir einfach auf die Einträge sehen, den aktuellsten herausholen, und
  528. sein <code>&lt;pubDate&gt;</code> Element verwenden. In der Annahme das es existiert...
  529. viele Feeds verwenden auch Dublin Core 1.0/1.1 <code>&lt;dc:date&gt;</code> Elemente für
  530. Feeds und Einträge. Oder wir können wieder ein Atom finden das herumliegt.
  531. </para>
  532. <para>
  533. Der Punkt ist, das <classname>Zend_Feed_Reader</classname> entwickelt wurde um das zu
  534. wissen. Wenn man nach dem Änderungsdatum fragt (oder irgendwas anderes), wird er
  535. starten und alle diese Alternativen suchen bis er entweder aufgibt und
  536. <constant>NULL</constant> zurückgibt, oder eine Alternative findet welche die richtige
  537. Antwort hat.
  538. </para>
  539. <para>
  540. Zusätzlich zu den obigen Methoden, implementieren alle Feed Objekte Methoden für das
  541. empfangen der <acronym>DOM</acronym> und XPath Objekte für die aktuellen Feeds wie
  542. vorher beschrieben. Feed Objekte implementieren auch die Interfaces für
  543. <acronym>SPL</acronym> Iterator und Countable. Die erweiterte <acronym>API</acronym>
  544. wird anbei zusammengefasst.
  545. </para>
  546. <table>
  547. <title>Erweiterte API Methoden auf Level des Feeds</title>
  548. <tgroup cols="2">
  549. <tbody>
  550. <row>
  551. <entry><methodname>getDomDocument()</methodname></entry>
  552. <entry>
  553. Gibt das elterliche <classname>DOMDocument</classname> Objekt für das
  554. komplette <acronym>XML</acronym> Quelldokument zurück
  555. </entry>
  556. </row>
  557. <row>
  558. <entry><methodname>getElement()</methodname></entry>
  559. <entry>
  560. Gibt das aktuelle <classname>DOMElement</classname> Objekt des Feed
  561. Levels zurück
  562. </entry>
  563. </row>
  564. <row>
  565. <entry><methodname>saveXml()</methodname></entry>
  566. <entry>
  567. Gibt einen String zurück der ein <acronym>XML</acronym> Dokument
  568. zurück welches das komplette Feed Element enthält (das ist nicht das
  569. originale Dokument sondern eine nachgebaute Version)
  570. </entry>
  571. </row>
  572. <row>
  573. <entry><methodname>getXpath()</methodname></entry>
  574. <entry>
  575. Gibt das intern verwendete <classname>DOMXPath</classname> Objekt
  576. zurück mit dem Abfragen auf das <classname>DOMDocument</classname>
  577. Objekt durchgeführt werden (das enthält die Kern und Erweiterungs
  578. Namespaces die vor-registriert sind)
  579. </entry>
  580. </row>
  581. <row>
  582. <entry><methodname>getXpathPrefix()</methodname></entry>
  583. <entry>
  584. Gibt den gültigen <acronym>DOM</acronym> Pfad Präfix zurück der bei
  585. allen XPath Abfragen passt die dem Feed entsprechen der abgefragt wird.
  586. </entry>
  587. </row>
  588. <row>
  589. <entry><methodname>getEncoding()</methodname></entry>
  590. <entry>
  591. Gibt die Kodierung des <acronym>XML</acronym> Quelldokuments zurück
  592. (Beachte: Das kann nicht verwendet werden für Fehler wie einen
  593. Server der Dokumente in einer anderen Kodierung verschickt)
  594. </entry>
  595. </row>
  596. <row>
  597. <entry><methodname>count()</methodname></entry>
  598. <entry>
  599. Gibt eine Zahl von Einträgen oder Elementen zurück welche dieser Feed
  600. enthält (implementiert das <acronym>SPL</acronym> Interface
  601. <classname>Countable</classname>)
  602. </entry>
  603. </row>
  604. <row>
  605. <entry><methodname>current()</methodname></entry>
  606. <entry>
  607. Gibt nur den aktuellen Eintrag zurück (verwendet den aktuellen
  608. Index von <methodname>key()</methodname>)
  609. </entry>
  610. </row>
  611. <row>
  612. <entry><methodname>key()</methodname></entry>
  613. <entry>Gibt den aktuellen Index für Einträge zurück</entry>
  614. </row>
  615. <row>
  616. <entry><methodname>next()</methodname></entry>
  617. <entry>Addiert den Wert des Index für Einträge um Eins</entry>
  618. </row>
  619. <row>
  620. <entry><methodname>rewind()</methodname></entry>
  621. <entry>Resetiert den Index für Einträge auf 0</entry>
  622. </row>
  623. <row>
  624. <entry><methodname>valid()</methodname></entry>
  625. <entry>
  626. Prüft pb der aktuelle Index für Einträge gültig ist, z.B. ob er nicht
  627. unter 0 fällt und die Anzahl der existierenden Einträge nicht
  628. übersteigt.
  629. </entry>
  630. </row>
  631. <row>
  632. <entry><methodname>getExtensions()</methodname></entry>
  633. <entry>
  634. Gibt ein Array aller Erweiterungs Objekte zurück die für den aktuellen
  635. Feed geladen sind (Beachte: sowohl Feel-Level als auch Element-Level
  636. Erweiterungen exstieren, aber nur Feed-Level Erweiterungen werden hier
  637. zurückgegeben). Die Array Schlüssel sind in der Form
  638. (ErweiterungsName)_Feed.
  639. </entry>
  640. </row>
  641. <row>
  642. <entry><methodname>getExtension(string $name)</methodname></entry>
  643. <entry>
  644. Gibt ein Erweiterungs Objekt für den Feed zurück der unter dem
  645. angegebenen Namen registriert ist. Das erlaubt einen feiner
  646. gestaffelten Zugriff auf Erweiterungen welche andernfalls in der
  647. Implementation der standardmäßigen <acronym>API</acronym> Methoden
  648. versteckt wären.
  649. </entry>
  650. </row>
  651. <row>
  652. <entry><methodname>getType()</methodname></entry>
  653. <entry>
  654. Gibt eine statische Klassenkonstante zurück (z.B.
  655. <constant>Zend_Feed_Reader::TYPE_ATOM_03</constant>, z.B. Atom 0.3)
  656. welche exakt anzeigt welche Art von Feed gerade konsumiert wird.
  657. </entry>
  658. </row>
  659. </tbody>
  660. </tgroup>
  661. </table>
  662. </sect2>
  663. <sect2 id="zend.feed.reader.entry">
  664. <title>Empfangen von Informationen aus Einträgen/Elementen</title>
  665. <para>
  666. Das Empfangen von Informationen für spezifische Einträge oder Elemente (abhängig davon
  667. ob man Atom oder <acronym>RSS</acronym> spricht) ist identisch wie bei den Daten auf
  668. Feed Level. Der Zugriff auf Einträge ist einfach ein Fall von Iteration über ein Feed
  669. Objekt oder durch Verwendung des <acronym>SPL</acronym> Interfaces
  670. <classname>Iterator</classname> welches Feed Objekte implementieren und durch
  671. Aufruf der betreffenden Methoden auf Ihnen.
  672. </para>
  673. <table>
  674. <title>API Methoden auf Level des Eintrags</title>
  675. <tgroup cols="2">
  676. <tbody>
  677. <row>
  678. <entry><methodname>getId()</methodname></entry>
  679. <entry>Gibt eine eindeutige ID für den aktuellen Eintrag zurück</entry>
  680. </row>
  681. <row>
  682. <entry><methodname>getTitle()</methodname></entry>
  683. <entry>Gibt den Titel des aktuellen Eintrags zurück</entry>
  684. </row>
  685. <row>
  686. <entry><methodname>getDescription()</methodname></entry>
  687. <entry>Gibt eine Beschreibung des aktuellen Eintrags zurück</entry>
  688. </row>
  689. <row>
  690. <entry><methodname>getLink()</methodname></entry>
  691. <entry>
  692. Gibt eine <acronym>URI</acronym> zur <acronym>HTML</acronym> Version des
  693. aktuellen Eintrags zurück
  694. </entry>
  695. </row>
  696. <row>
  697. <entry><methodname>getPermaLink()</methodname></entry>
  698. <entry>
  699. Gibt einen permanenten Link zum aktuellen Eintrag zurück
  700. </entry>
  701. </row>
  702. <row>
  703. <entry><methodname>getAuthors()</methodname></entry>
  704. <entry>
  705. Gibt ein Array aller Authoren zurück die mit diesem Eintrag assoziiert
  706. sind, inklusive Email Adresse wenn diese im String des Authors vorhanden
  707. ist
  708. </entry>
  709. </row>
  710. <row>
  711. <entry><methodname>getAuthor($index = 0)</methodname></entry>
  712. <entry>
  713. Gibt entweder den ersten bekannten Author zurück, oder mit dem
  714. optionalen Parameter <varname>$index</varname> jeden spezifischen Index
  715. aus dem Array der Authoren (gibt null zurück wenn der Index ungültig
  716. ist).
  717. </entry>
  718. </row>
  719. <row>
  720. <entry><methodname>getDateCreated()</methodname></entry>
  721. <entry>
  722. Gibt das Datum zurück an dem der aktuelle Eintrag erstellt wurde.
  723. Generell kann das nur auf Atom angewendet werden wo es das Datum der
  724. Ressource beschreibt zu welche das Atom 1.0 Dokument erstellt wurde.
  725. </entry>
  726. </row>
  727. <row>
  728. <entry><methodname>getDateModified()</methodname></entry>
  729. <entry>
  730. Gibt das Datum zurück an welchem der aktuelle Eintrag zuletzt geändert
  731. wurde.
  732. </entry>
  733. </row>
  734. <row>
  735. <entry><methodname>getContent()</methodname></entry>
  736. <entry>
  737. Gibt den Inhalt des aktuellen Eintrags zurück (das retourniert alle
  738. Entities wenn das möglich ist, mit der Annahme das der Content Type
  739. <acronym>HTML</acronym> ist). Die Beschreibung wird zurückgegeben wenn
  740. ein kein seperates Content Element existiert.
  741. </entry>
  742. </row>
  743. <row>
  744. <entry><methodname>getEnclosure()</methodname></entry>
  745. <entry>
  746. Gibt ein Array zurück welches die Werte aller Attribute eines
  747. Multimedia &lt;enclosure&gt; Elements enthält, inklusive den Array
  748. Schlüsseln: <emphasis>url</emphasis>, <emphasis>length</emphasis>,
  749. <emphasis>type</emphasis>.
  750. </entry>
  751. </row>
  752. <row>
  753. <entry><methodname>getCommentCount()</methodname></entry>
  754. <entry>
  755. Gibt die Anzahl der Kommentare zurück die auf diesen Eintrag gemacht
  756. wurden seit der Zeit an welcher der Feed erstellt wurde
  757. </entry>
  758. </row>
  759. <row>
  760. <entry><methodname>getCommentLink()</methodname></entry>
  761. <entry>
  762. Gibt eine <acronym>URI</acronym> zurück welche auf die
  763. <acronym>HTML</acronym> Seite zeigt, auf der Kommentare zu diesem
  764. Eintrag gemacht werden können
  765. </entry>
  766. </row>
  767. <row>
  768. <entry>
  769. <methodname>getCommentFeedLink(string $type =
  770. 'atom'|'rss')</methodname>
  771. </entry>
  772. <entry>
  773. Gibt eine <acronym>URI</acronym> zurück die auf einen Feed zeigt welcher
  774. vom angegebenen Typ ist, und alle Kommentare für diesen Eintrag enthält
  775. (Der Typ ist standardmäßig Atom/<acronym>RSS</acronym> abhängig vom
  776. aktuellen Feed Typ).
  777. </entry>
  778. </row>
  779. </tbody>
  780. </tgroup>
  781. </table>
  782. <para>
  783. Die erweiterte <acronym>API</acronym> für Einträge ist identisch zu der für die Feed
  784. mit der Aufnahme der Iterator Methoden die hier nicht benötigt werden.
  785. </para>
  786. <caution>
  787. <para>
  788. Es gibt oft Missverständnisse über die Konzepte vom Zeitpunkt der Änderung und des
  789. Erstellungsdatums. In Atom, sind diese zwei klar definierte Konzepte aber in
  790. <acronym>RSS</acronym> sind Sie vage. <acronym>RSS</acronym> 2.0 definiert ein
  791. einzelnes <emphasis>&lt;pubDate&gt;</emphasis> Element das typischerweise auf das
  792. Datum referiert an dem dieser Eintrag veröffentlicht wurde, z.B. etwas in der Art
  793. eines Erstellungsdatums. Das ist nicht immer das gleiche, und kann sich durch
  794. Updates ändern oder auch nicht. Als Resultat sollte man sich, wenn man wirklich
  795. prüfen will ob der Eintrag geändert wurde oder nicht, nicht auf das Ergebnis von
  796. <methodname>getDateModified()</methodname> verlassen. Stattdessen sollte man
  797. Erwägen den <acronym>MD5</acronym> Hash von drei anderen verknpüften Elementen
  798. zu beobachten, z.B. durch Verwendung von <methodname>getTitle()</methodname>,
  799. <methodname>getDescription()</methodname> und
  800. <methodname>getContent()</methodname>. Wenn der Eintrag wirklich geändert wurde,
  801. gibt diese Hash Berechnung ein anderes Ergebnis als die vorher gespeicherten Hashs
  802. für den gleichen Eintrag. Weitere Schritte in diesen Wassern zeigen das die Daten
  803. von Feeds unterschiedlichen Standards folgen. Atom und Dublin Core Daten sollten
  804. <acronym>ISO</acronym> 86001 folgen und <acronym>RSS</acronym> Daten sollten
  805. <acronym>RFC</acronym> 822 oder <acronym>RFC</acronym> 2822 folgen welche auch
  806. üblicherweise verwendet werden. Datumsmethoden werfen eine Exception wenn
  807. <classname>Zend_Date</classname> das Datum durch Verwendung der obigen Standards
  808. nicht laden kann.
  809. </para>
  810. </caution>
  811. <warning>
  812. <para>
  813. Die Werte die von diesen Methoden zurückgegeben werden, sind nicht geprüft. Das
  814. bedeutet das der Benutzer Prüfungen auf allen empfangenen Daten durchführen muss
  815. inklusive filtern von jeglichem <acronym>HTML</acronym> wie von
  816. <methodname>getContent()</methodname> bevor es von der eigenen Anwendung ausgegeben
  817. wird. Es ist zu beachten das die meisten Feeds von externen Quellen kommen, und
  818. deshalb die normale Annahme sein sollte das man Ihnen nicht trauen kann.
  819. </para>
  820. </warning>
  821. <table>
  822. <title>Erweiterte API Methoden auf Level des Eintrags</title>
  823. <tgroup cols="2">
  824. <tbody>
  825. <row>
  826. <entry><methodname>getDomDocument()</methodname></entry>
  827. <entry>
  828. Gibt das elterliche <classname>DOMDocument</classname> Objekt für den
  829. kompletten Feed zurück (nicht nur den aktuellen Eintrag)
  830. </entry>
  831. </row>
  832. <row>
  833. <entry><methodname>getElement()</methodname></entry>
  834. <entry>
  835. Gibt das <classname>DOMDocument</classname> Objekt für den
  836. aktuellen Level des Eintrags zurück
  837. </entry>
  838. </row>
  839. <row>
  840. <entry><methodname>getXpath()</methodname></entry>
  841. <entry>
  842. Gibt das <classname>DOMXPath</classname> Objekt zurück welches
  843. intern verwendet wird um Abfragen auf dem
  844. <classname>DOMDocument</classname> Objekt durchzuführen (das enthält
  845. auch die vorregistrierten Kern und Erweiterungs Namespaces)
  846. </entry>
  847. </row>
  848. <row>
  849. <entry><methodname>getXpathPrefix()</methodname></entry>
  850. <entry>
  851. Gibt einen gültigen <acronym>DOM</acronym> Pfad Präfix zurück der allen
  852. XPath Abfrage vorangestellt wird, welche dem Eintrag entsprechen der
  853. abgefragt wird.
  854. </entry>
  855. </row>
  856. <row>
  857. <entry><methodname>getEncoding()</methodname></entry>
  858. <entry>
  859. Gibt die Kodierung des <acronym>XML</acronym> Quelldokuments zurück
  860. (Achtung: Das kann nicht für Fehler genommen werden bei denen der
  861. Server eine andere Kodierung sendet als die Dokumente)
  862. </entry>
  863. </row>
  864. <row>
  865. <entry><methodname>getExtensions()</methodname></entry>
  866. <entry>
  867. Gibt ein Array aller Erweiterungsobjekte zurück die für den aktuellen
  868. Eintrag geladen wurden (Achtung: Sowohl Erweiterung auf Level von Feeds
  869. als auch auf Level von Einträgen existieren, und nur Erweiterungen auf
  870. Level von Einträgen werden hier zurückgegeben). Die Arrayschlüssel sind
  871. im Format {ErweiterungsName}_Entry.
  872. </entry>
  873. </row>
  874. <row>
  875. <entry><methodname>getExtension(string $name)</methodname></entry>
  876. <entry>
  877. Gibt das Erweiterungsobjekt zurück für das der Eintrag mit dem
  878. angegebenen Namen registriert wurde. Das erlaubt einen feineren
  879. Zugriff auf Erweiterungen welche andernfalls innerhalb der
  880. Implementierung der standardmäßigen <acronym>API</acronym> Methoden
  881. versteckt wären.
  882. </entry>
  883. </row>
  884. <row>
  885. <entry><methodname>getType()</methodname></entry>
  886. <entry>
  887. Gibt eine statische Klassenkonstante zurück (z.B.
  888. <constant>Zend_Feed_Reader::TYPE_ATOM_03</constant>, z.B. Atom 0.3)
  889. die exakt anzeigt von welcher Art der Feed ist der gerade konsumiert
  890. wird.
  891. </entry>
  892. </row>
  893. </tbody>
  894. </tgroup>
  895. </table>
  896. </sect2>
  897. <sect2 id="zend.feed.reader.extending">
  898. <title>Erweitern der APIs für Feeds und Einträge</title>
  899. <para>
  900. Die Erweiterung von <classname>Zend_Feed_Reader</classname> erlaubt es Methoden sowohl
  901. auf Level von Feeds als auch auf Level von Einträgen hinzuzufügen, welche das Empfangen
  902. von Informationen abdecken die nicht bereits von <classname>Zend_Feed_Reader</classname>
  903. unterstützt werden. Bei der Anzahl an <acronym>RSS</acronym> und Atom Erweiterungen die
  904. existieren, ist das ein guter Weg da <classname>Zend_Feed_Reader</classname> einfach
  905. nicht alles hinzufügen kann.
  906. </para>
  907. <para>
  908. Es gibt zwei Typen von Erweiterungen, jene welche Informationen von Elementen empfangen
  909. die unmittelbare Kunder des Root Elements sind (z.B. <code>&lt;channel&gt;</code> für
  910. <acronym>RSS</acronym> oder <code>&lt;feed&gt;</code> für Atom), und jene die
  911. Informationen von Kind-Elementen eines Eintrags empfangen (z.B.
  912. <code>&lt;item&gt;</code> für <acronym>RSS</acronym> oder <code>&lt;entry&gt;</code>
  913. für Atom). Auf dem Filesystem sind Sie als Klassen in einem Namespace gruppiert,
  914. basierend auf dem Standardnamen der Erweiterung. Zum Beispiel haben wir intern
  915. <classname>Zend_Feed_Reader_Extension_DublinCore_Feed</classname> und
  916. <classname>Zend_Feed_Reader_Extension_DublinCore_Entry</classname> Klassen welche zwei
  917. Klassen sind welche die Unterstützung für Dublin Core 1.0/1.1 implementieren.
  918. </para>
  919. <para>
  920. Erweiterungen werden in <classname>Zend_Feed_Reader</classname> durch Verwendung von
  921. <classname>Zend_Loader_PluginLoader</classname> geladen, sodas dessen Operationen
  922. ähnlich denen anderer Zend Framework Komponenten ist.
  923. <classname>Zend_Feed_Reader</classname> kommt bereits mit einer Anzahl dieser
  924. Erweiterungen. Trotzdem müssen jene, die nicht intern verwendet und standardmäßig
  925. registriert werden (sogenannte Core Erweiterungen), bei
  926. <classname>Zend_Feed_Reader</classname> registriert werden bevor Sie verwendet werden.
  927. Die gebündelten Erweiterungen sind:
  928. </para>
  929. <table>
  930. <title>Core Extensions (pre-registered)</title>
  931. <tgroup cols="2">
  932. <tbody>
  933. <row>
  934. <entry>DublinCore (Feed und Eintrag)</entry>
  935. <entry>
  936. Implementiert die Unterstützung für das Dublin Core Metadata Element
  937. Set 1.0 und 1.1
  938. </entry>
  939. </row>
  940. <row>
  941. <entry>Content (nur Eintrag)</entry>
  942. <entry>Implementiert Unterstützung für Content 1.0</entry>
  943. </row>
  944. <row>
  945. <entry>Atom (Feed und Eintrag)</entry>
  946. <entry>Implementiert Unterstützung für Atom 0.3 und Atom 1.0</entry>
  947. </row>
  948. <row>
  949. <entry>Slash</entry>
  950. <entry>
  951. Implementiert Unterstützung für das Slash <acronym>RSS</acronym> 1.0
  952. Modul
  953. </entry>
  954. </row>
  955. <row>
  956. <entry>WellFormedWeb</entry>
  957. <entry>
  958. Implementiert Unterstützung für das Well Formed Web CommentAPI 1.0
  959. </entry>
  960. </row>
  961. <row>
  962. <entry>Thread</entry>
  963. <entry>
  964. Implementiert Unterstützung für Atom Threading Erweiterungen wie in
  965. <acronym>RFC</acronym> 4685 beschrieben
  966. </entry>
  967. </row>
  968. <row>
  969. <entry>Podcast</entry>
  970. <entry>
  971. Implementiert Unterstützung fpr das Podcast 1.0 <acronym>DTD</acronym>
  972. von Apple
  973. </entry>
  974. </row>
  975. </tbody>
  976. </tgroup>
  977. </table>
  978. <para>
  979. Die Core Erweiterungen sind irgendwie speziell da Sie extrem allgemein sind und viele
  980. Facetten haben. Zum Beispiel haben wir eine Core Erweiterung für Atom. Atom ist als
  981. Erweiterung (und nicht nur als Basis Klasse) implementiert weil es ein gültiges
  982. <acronym>RSS</acronym> Modul dupliziert - so kann man Atom Elemente in
  983. <acronym>RSS</acronym> Feeds einfügen. Wir haben sogar <acronym>RDF</acronym> Feeds
  984. gesehen die viel von Atom verwenden statt den üblicheren Erweiterungen wie Dublin Core.
  985. </para>
  986. <table>
  987. <title>Nicht-Core Erweiterungen (müssen per Hand registriert werden)</title>
  988. <tgroup cols="2">
  989. <tbody>
  990. <row>
  991. <entry>Syndication</entry>
  992. <entry>
  993. Implementiert Unterstützung für Syndication 1.0 <acronym>RSS</acronym>
  994. Feeds
  995. </entry>
  996. </row>
  997. <row>
  998. <entry>CreativeCommons</entry>
  999. <entry>
  1000. Ein <acronym>RSS</acronym> Modul das ein Element auf &lt;channel&gt;
  1001. oder &lt;item&gt; Level hinzufügt welches spezifiziert welche
  1002. Creative Commons Lizenz anzuwenden ist.
  1003. </entry>
  1004. </row>
  1005. </tbody>
  1006. </tgroup>
  1007. </table>
  1008. <para>
  1009. Die zusätzlichen nicht-Core Erweiterungen werden angeboten aber standardmäßig bei
  1010. <classname>Zend_Feed_Reader</classname> nicht registriert. Wenn man Sie verwenden will,
  1011. muß man <classname>Zend_Feed_Reader</classname> sagen dass Sie diese zusätzlich zum
  1012. Importieren eines Feeds laden soll. Zusätzliche nicht-Core Erweiterungen werden in
  1013. zukünftigen Releases dieser Komponente enthalten sein.
  1014. </para>
  1015. <para>
  1016. Das Registrieren einer Erweiterung bei <classname>Zend_Feed_Reader</classname>, so dass
  1017. diese geladen wird und dessen <acronym>API</acronym> für Feed und Entry Objekte zur
  1018. Verfügung steht, ist eine einfache Sache wenn der
  1019. <classname>Zend_Loader_PluginLoader</classname> verwendet wird. Hier registrieren wir
  1020. die optionale Slash Erweiterung und finden heraus das Sie direkt von der Entry Level
  1021. <acronym>API</acronym> heraus aufgerufen werden kann, ohne große Dinge notwendig sind.
  1022. Es ist zu beachten das die Namen der Erweiterungen von der Schreibweise abhängig sind
  1023. und Camel Casing für mehrere Ausdrücke verwenden.
  1024. </para>
  1025. <programlisting language="php"><![CDATA[
  1026. Zend_Feed_Reader::registerExtension('Syndication');
  1027. $feed = Zend_Feed_Reader::import('http://rss.slashdot.org/Slashdot/slashdot');
  1028. $updatePeriod = $feed->current()->getUpdatePeriod();
  1029. ]]></programlisting>
  1030. <para>
  1031. Im obigen Beispiel haben wir geprüft wie oft ein Feed aktualisiert wurde indem wir die
  1032. <methodname>getUpdatePeriod()</methodname> Methode verwendet haben. Da das nicht Teil
  1033. der Kern <acronym>API</acronym> von <classname>Zend_Feed_Reader</classname> ist, kann es
  1034. nur eine Methode sein die von der neu registrieren Syndication Erweiterung unterstützt
  1035. wird.
  1036. </para>
  1037. <para>
  1038. Wie man auch sieht, kann man auf die neuen Methoden vlon Erweiterungen aus der Haupt
  1039. <acronym>API</acronym> heraus zugreifen indem <acronym>PHP</acronym>'s magische
  1040. Methoden verwendet werden. Als Alternative kann man, für ein ähnliches Ergebnis, auf
  1041. jedes Erweiterungs Objekt auch direkt zugreifen, wie anbei gezeigt.
  1042. </para>
  1043. <programlisting language="php"><![CDATA[
  1044. Zend_Feed_Reader::registerExtension('Syndication');
  1045. $feed = Zend_Feed_Reader::import('http://rss.slashdot.org/Slashdot/slashdot');
  1046. $syndication = $feed->getExtension('Syndication');
  1047. $updatePeriod = $syndication->getUpdatePeriod();
  1048. ]]></programlisting>
  1049. <sect3 id="zend.feed.reader.extending.feed">
  1050. <title>Erweiterungen für Zend_Feed_Reader schreiben</title>
  1051. <para>
  1052. Unweigerlich gibt es Zeiten in denen die <acronym>API</acronym> von
  1053. <classname>Zend_Feed_Reader</classname> einfach nicht in der Lage ist etwas das man
  1054. von einem Feed oder Eintrag benötigt zu erhalten. Man kann die darunterliegenden
  1055. Quell Objekte, wie ein <classname>DOMDocument</classname>, verwenden um Sie
  1056. von Hand zu erhalten. Trotzdem sind weitere wiederverwendbare Methoden vorhanden
  1057. indem man Erweiterungen schreibt die diese neuen Abfragen unterstützen.
  1058. </para>
  1059. <para>
  1060. Als Beispiel nehmen wir den Fall eine komplett fiktiven Firma an die Jungle Books
  1061. heißt. Jungle Books hat eine Vielzahl an Reviews für Bücher veröffentlicht die Sie
  1062. verkaufen (von externen Quellen und Kunden), welche als <acronym>RSS</acronym> 2.0
  1063. Feed verteilt werden. Die Marketing Abteilung realisiert das Web Anwendungen welche
  1064. diesen Feed verwenden, aktuell nicht herausfinden können welches Buch exakt
  1065. betrachtet wird. Um jedem das Leben leichter zu machen entscheiden Sie dass die
  1066. Streber Abteilung <acronym>RSS</acronym> 2.0 erweitern muß um ein neues Element
  1067. pro Eintrag hinzuzufügen das die <acronym>ISBN</acronym>-10 oder
  1068. <acronym>ISBN</acronym>-13 Zahl der Veröffentlichung die der Eintrag betrifft
  1069. unterstützt. Sie definieren das neue <code>&lt;isbn&gt;</code> Element recht einfach
  1070. mit dem standardmäßigen Namen und Namespace <acronym>URI</acronym>:
  1071. </para>
  1072. <programlisting language="php"><![CDATA[
  1073. JungleBooks 1.0:
  1074. http://example.com/junglebooks/rss/module/1.0/
  1075. ]]></programlisting>
  1076. <para>
  1077. Ein Teil des <acronym>RSS</acronym> das diese Erweiterung in der Praxis enthält
  1078. könnte in etwa so aussehen:
  1079. </para>
  1080. <programlisting language="php"><![CDATA[
  1081. <?xml version="1.0" encoding="utf-8" ?>
  1082. <rss version="2.0"
  1083. xmlns:content="http://purl.org/rss/1.0/modules/content/"
  1084. xmlns:jungle="http://example.com/junglebooks/rss/module/1.0/">
  1085. <channel>
  1086. <title>Jungle Books Customer Reviews</title>
  1087. <link>http://example.com/junglebooks</link>
  1088. <description>Many book reviews!</description>
  1089. <pubDate>Fri, 26 Jun 2009 19:15:10 GMT</pubDate>
  1090. <jungle:dayPopular>http://example.com/junglebooks/book/938</jungle:dayPopular>
  1091. <item>
  1092. <title>Review Of Flatland: A Romance of Many Dimensions</title>
  1093. <link>http://example.com/junglebooks/review/987</link>
  1094. <author>Confused Physics Student</author>
  1095. <content:encoded>
  1096. A romantic square?!
  1097. </content:encoded>
  1098. <pubDate>Thu, 25 Jun 2009 20:03:28 -0700</pubDate>
  1099. <jungle:isbn>048627263X</jungle:isbn>
  1100. </item>
  1101. </channel>
  1102. </rss>
  1103. ]]></programlisting>
  1104. <para>
  1105. Die Implementierung dieses neuen <acronym>ISBN</acronym> Elements als eine einfache
  1106. Eintrags Level Erweiterung wird die folgende Klasse benötigen (und die Verwendung
  1107. des eigenen Klassen Namespaces ausserhalb von Zend).
  1108. </para>
  1109. <programlisting language="php"><![CDATA[
  1110. class My_FeedReader_Extension_JungleBooks_Entry
  1111. extends Zend_Feed_Reader_Extension_EntryAbstract
  1112. {
  1113. public function getIsbn()
  1114. {
  1115. if (isset($this->_data['isbn'])) {
  1116. return $this->_data['isbn'];
  1117. }
  1118. $isbn = $this->_xpath->evaluate(
  1119. 'string(' . $this->getXpathPrefix() . '/jungle:isbn)'
  1120. );
  1121. if (!$isbn) {
  1122. $isbn = null;
  1123. }
  1124. $this->_data['isbn'] = $isbn;
  1125. return $this->_data['isbn'];
  1126. }
  1127. protected function _registerNamespaces()
  1128. {
  1129. $this->_xpath->registerNamespace(
  1130. 'jungle', 'http://example.com/junglebooks/rss/module/1.0/'
  1131. );
  1132. }
  1133. }
  1134. ]]></programlisting>
  1135. <para>
  1136. Diese Erweiterung ist einfach genug um Ihr zu folgen. Sie erstellt eine neue Methode
  1137. <methodname>getIsbn()</methodname>, welche eine XPath Abfrage auf dem aktuellen
  1138. Eintrag durchführt, um die <acronym>ISBN</acronym> Nummer welche vom
  1139. <code>&lt;jungle:isbn&gt;</code> Element umhüllt ist, zu extrahieren. Das kann
  1140. optional auch im internen nicht-persistenten Cache gespeichert werden (keine
  1141. Notwendigkeit den <acronym>DOM</acronym> abzufragen wenn es auf dem gleichen
  1142. Eintrag nochmals aufgerufen wird). Der Wert wird dem Anrufer zurückgegeben.
  1143. Am Ende haben wir eine geschützte Methode (Sie ist abstrakt, muss also existieren)
  1144. welche den Jungle Books Namespace für Ihre eigenen <acronym>RSS</acronym> Module
  1145. registriert. Wärend wir das ein <acronym>RSS</acronym> Modul nennen, gibt es nichts
  1146. das verhindert dass das gleiche Element in Atom Feeds verwendet wird - und alle
  1147. Erweiterungen welche den Prefix verwenden der von
  1148. <methodname>getXpathPrefix()</methodname> angeboten wird, sind aktuell neutral und
  1149. arbeiten auf <acronym>RSS</acronym> oder Atom Feeds ohne zusätzlichen Code.
  1150. </para>
  1151. <para>
  1152. Da die Erweiterung ausserhalb vom Zend Framework gespeichert ist, muss man den Pfad
  1153. Prefix für die eigenen Erweiterungen registrieren damit
  1154. <classname>Zend_Loader_PluginLoader</classname> diese finden kann. Danach ist es
  1155. einfach ein Problem der Registrierung der Erweiterung, wenn diese nicht bereits
  1156. geladen wurde, und deren Verwendung in der Praxis.
  1157. </para>
  1158. <programlisting language="php"><![CDATA[
  1159. if(!Zend_Feed_Reader::isRegistered('JungleBooks')) {
  1160. Zend_Feed_Reader::addPrefixPath(
  1161. '/path/to/My/FeedReader/Extension', 'My_FeedReader_Extension'
  1162. );
  1163. Zend_Feed_Reader::registerExtension('JungleBooks');
  1164. }
  1165. $feed = Zend_Feed_Reader::import('http://example.com/junglebooks/rss');
  1166. // ISBN für irgendein Buch dem der erste Eintrag im Feed gewidmet war
  1167. $firstIsbn = $feed->current()->getIsbn();
  1168. ]]></programlisting>
  1169. <para>
  1170. Das Schreiben einer Feed Level Erweiterung unterscheidet sich nicht sehr. Der
  1171. Beispiel Feed von vorher enthält ein nicht erwähntes
  1172. <code>&lt;jungle:dayPopular&gt;</code> Element das Jungle Books bei Ihrem Standard
  1173. hinzugefügt haben um einen Link zum beliebtesten Buch des Tages hinzuzufügen
  1174. (im Sinne von Verkehr der Besucher). Hier ist eine Erweiterung welche eine
  1175. <methodname>getDaysPopularBookLink()</methodname> Methode bei der Feed Level
  1176. <acronym>API</acronym> hinzufügt.
  1177. </para>
  1178. <programlisting language="php"><![CDATA[
  1179. class My_FeedReader_Extension_JungleBooks_Feed
  1180. extends Zend_Feed_Reader_Extension_FeedAbstract
  1181. {
  1182. public function getDaysPopularBookLink()
  1183. {
  1184. if (isset($this->_data['dayPopular'])) {
  1185. return $this->_data['dayPopular'];
  1186. }
  1187. $dayPopular = $this->_xpath->evaluate(
  1188. 'string(' . $this->getXpathPrefix() . '/jungle:dayPopular)'
  1189. );
  1190. if (!$dayPopular) {
  1191. $dayPopular = null;
  1192. }
  1193. $this->_data['dayPopular'] = $dayPopular;
  1194. return $this->_data['dayPopular'];
  1195. }
  1196. protected function _registerNamespaces()
  1197. {
  1198. $this->_xpath->registerNamespace(
  1199. 'jungle', 'http://example.com/junglebooks/rss/module/1.0/'
  1200. );
  1201. }
  1202. }
  1203. ]]></programlisting>
  1204. <para>
  1205. Wiederholen wir das letzte Beispiel der Verwendung einer eigenen Erweiterung um zu
  1206. zeigen wie die Methode verwendet wird.
  1207. </para>
  1208. <programlisting language="php"><![CDATA[
  1209. if(!Zend_Feed_Reader::isRegistered('JungleBooks')) {
  1210. Zend_Feed_Reader::addPrefixPath(
  1211. '/path/to/My/FeedReader/Extension', 'My_FeedReader_Extension'
  1212. );
  1213. Zend_Feed_Reader::registerExtension('JungleBooks');
  1214. }
  1215. $feed = Zend_Feed_Reader::import('http://example.com/junglebooks/rss');
  1216. // URI zur Informations Seite des populärsten Buchs des Tages mit Besuchern
  1217. $daysPopularBookLink = $feed->getDaysPopularBookLink();
  1218. // ISBN für irgendein Buch dem der erste Eintrag im Feed gewidmet war
  1219. $firstIsbn = $feed->current()->getIsbn();
  1220. ]]></programlisting>
  1221. <para>
  1222. Beim Betrachten dieser Beispiele, konnte man sehen das wir Feed und Eintrags
  1223. Erweiterungen nicht separat registriert haben. Erweiterungen im selben Standard
  1224. können sowohl eine Feed und Entry Klasse enthalten oder auch nicht, sodas
  1225. <classname>Zend_Feed_Reader</classname> nur die Registrierung des darüberliegenden
  1226. Eltern Namens benötigt, z.B. JungleBooks, DublinCore, Slash. Intern kann sie
  1227. prüfen für welchen Level Erweiterungen existieren und und diese Laden wenn Sie
  1228. gefunden werden. In unserem Fall haben wir jetzt ein komplettes Set von
  1229. Erweiterungen: <classname>JungleBooks_Feed</classname> und
  1230. <classname>JungleBooks_Entry</classname>.
  1231. </para>
  1232. </sect3>
  1233. </sect2>
  1234. </sect1>