Zend_Feed_Reader.xml 78 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 21588 -->
  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. delegiert diese Aufgabe aber an <classname>Zend_Feed_Writer</classname>, seinen Bruder.
  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. 'authors' => $entry->getAuthors(),
  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 eine Unterklasse von <classname>ArrayObject</classname>
  333. welche <classname>Zend_Feed_Reader_Collection_FeedLink</classname> heisst, damit es in
  334. ein Array gecastet werden kann, oder damit man es iterieren kann um auf alle erkannten
  335. Links zuzugreifen. Trotzdem kann man, als einfache Abkürzung, den ersten RSS, RDF oder
  336. Atom Link holen indem dessen öffentliche Eigenschaft wie im beiliegenden Beispiel
  337. verwendet wird. Andernfalls ist jedes Element von <classname>ArrayObject</classname>
  338. ein einfaches Array mit den Schlüsseln "type" und "uri" wobei der Typ "rdf", "rss" oder
  339. "atom" sein kann.
  340. </para>
  341. <programlisting language="php"><![CDATA[
  342. $links = Zend_Feed_Reader::findFeedLinks('http://www.planet-php.net');
  343. if(isset($links->rdf)) {
  344. echo $links->rdf, "\n"; // http://www.planet-php.org/rdf/
  345. }
  346. if(isset($links->rss)) {
  347. echo $links->rss, "\n"; // http://www.planet-php.org/rss/
  348. }
  349. if(isset($links->atom)) {
  350. echo $links->atom, "\n"; // http://www.planet-php.org/atom/
  351. }
  352. ]]></programlisting>
  353. <para>
  354. Basierend auf diesen Links kann man dann, von welchen Quellen man auch immer will,
  355. importieren indem die übliche Vorgehensweise verwendet wird.
  356. </para>
  357. <para>
  358. Diese schnelle Methode gibt nur einen Link für jeden Feed Typ zurück, aber Webseiten
  359. können viele Links von jedem Typ enthalten. Möglicherweise ist es eine News Site mit
  360. einem RSS Feed für jede News Kategorie. Man kann durch alle Links iterieren indem
  361. der ArrayObject Iterator verwendet wird.
  362. </para>
  363. <programlisting language="php"><![CDATA[
  364. $links = Zend_Feed_Reader::findFeedLinks('http://www.planet-php.net');
  365. foreach ($links as $link) {
  366. echo $link['uri'], "\n";
  367. }
  368. ]]></programlisting>
  369. </sect2>
  370. <sect2 id="zend.feed.reader.attribute-collections">
  371. <title>Attribut Sammlungen</title>
  372. <para>
  373. In einem Versuch die Rückgabetypen zu vereinfachen, können Rückgabetypen für die
  374. verschiedenen Feed und Entry Level Methoden ab Zend Framework 1.10 ein Objekt vom Typ
  375. <classname>Zend_Feed_Reader_Collection_CollectionAbstract</classname> enthalten.
  376. Abgesehen vom speziellen Klassennamen der anbei erklärt wird, ist es nur eine einfache
  377. Subklasse von SPL's <classname>ArrayObject</classname>.
  378. </para>
  379. <para>
  380. Der Hauptzweck hierbei besteht darin, die Präsentation von so vielen Daten wie möglich
  381. von den angefragten Elementen zu erlauben, wärend trotzdem der Zugriff auf die meisten
  382. relevanten Daten über ein einfaches Array erlaubt wird. Das erzwingt auch einen
  383. Standardweg um solche Daten zurückzugeben, was vorher zwischen Arrays und Objekten
  384. gewandert ist.
  385. </para>
  386. <para>
  387. Der neue Klassentyp arbeitet identisch zu <classname>ArrayObject</classname>, mit der
  388. gleichen kleinen Änderung dass eine neue Methode <methodname>getValues()</methodname>
  389. existiert welche ein einfaches flaches Array zurückgibt dass die meisten relevanten
  390. Informationen enthält.
  391. </para>
  392. <para>
  393. Ein einfaches Beispiel hiervon ist
  394. <methodname>Zend_Feed_Reader_FeedInterface::getCategories()</methodname>. Wenn es in
  395. irgendeinem RSS oder Atom Feed verwendet wird, gibt diese Methode Daten der Kategorie
  396. als Container Objekt zurück welches
  397. <classname>Zend_Feed_Reader_Collection_Category</classname> genannt wird. Das Container
  398. Objekt wird, für jede Kategorie, drei Felder an Daten enthalten: term, schema und label.
  399. "term" ist der grundsätzliche Name der Kategorie, oft Maschinen lesbar (normalerweise
  400. ein URI Identifikator) und in RSS 2.0 auch bekannt als "domain". "label" ist ein
  401. menschlich lesbarer Kategorie Name welcher Html Entities unterstützt. In RSS 2.0 gibt es
  402. kein Label Attribut deshalb wird es der Bequemlichkeit halber immer auf den selben Wert
  403. gesetzt wie der Ausdruck.
  404. </para>
  405. <para>
  406. Um auf die Label der Kategorie selbst als einfache Array Werte zuzugreifen könnte man
  407. das folgende verwenden:
  408. </para>
  409. <programlisting language="php"><![CDATA[
  410. $feed = Zend_Feed_Reader::import('http://www.example.com/atom.xml');
  411. $categories = $feed->getCategories();
  412. $labels = array();
  413. foreach ($categories as $cat) {
  414. $labels[] = $cat['label']
  415. }
  416. ]]></programlisting>
  417. <para>
  418. Es ist ein erfundenes Beispiel, aber der Punkt ist, dass Label zusammen mit anderen
  419. Informationen gebunden sind.
  420. </para>
  421. <para>
  422. Trotzdem erlaubt die Container Klasse den Zugriff auf die "relevantesten" Daten als
  423. einfaches Array indem die Methode <methodname>getValues()</methodname> verwendet wird.
  424. Das Konzept der "relevantesten" Daten ist offensichtlich ein beurteilter Aufruf. Für
  425. Kategorien bedeutet es die Label der Kategorien (nicht die Typen oder Schemata) wärend
  426. es für Autoren der Name des Autors wäre (nicht deren Email Adressen oder die URIs). Das
  427. einfache Array ist flach (nur Werte) und durchläuft
  428. <methodname>array_unique</methodname> um doppelte Werte zu entfernen.
  429. </para>
  430. <programlisting language="php"><![CDATA[
  431. $feed = Zend_Feed_Reader::import('http://www.example.com/atom.xml');
  432. $categories = $feed->getCategories();
  433. $labels = $categories->getValues();
  434. ]]></programlisting>
  435. <para>
  436. Das obige Beispiel zeigt wie nur die Label und sonst nichts extrahiert wird. Das gibt
  437. einen einfachen Zugriff auf die Label der Kategorie ohne zusätzliche Arbeit die Daten
  438. selbst zu extrahieren.
  439. </para>
  440. </sect2>
  441. <sect2 id="zend.feed.reader.retrieve-info">
  442. <title>Empfangen von Feed Informationen</title>
  443. <para>
  444. Das Empfangen von Informationen von einem Feed (wir reden über Einträge und Elemente in
  445. der nächsten Sektion da Sie identischen Prinzipien folgen) verwendet eine klar
  446. definierte <acronym>API</acronym> welche exakt die gleiche ist, unabhängig davon ob der
  447. angefragte Feed <acronym>RSS</acronym>/<acronym>RDF</acronym>/Atom ist. Das selbe gilt
  448. für Sub-Versionen dieser Standards da wir jede einzelne <acronym>RSS</acronym> und Atom
  449. Version getestet haben. Wärend sich der darunterliegende <acronym>XML</acronym> Feed
  450. substantiell unterscheiden kann, im Sinne von Tags und Elementen die vorhanden sind,
  451. versuchen trotzdem alle ähnliche Informationen zu geben und um das alles zu reflektieren
  452. werden unterschiede und das Hanteln durch alternative Tags intern von
  453. <classname>Zend_Feed_Reader</classname> behandelt welche einem ein identisches Interface
  454. für jeden anzeigt. Idealerweise sollte man sich nicht darum kümmern ob ein Feed
  455. <acronym>RSS</acronym> oder Atom ist, solange man die Informationen extrahieren kann
  456. die man benötigt.
  457. </para>
  458. <note>
  459. <para>
  460. Wärend die Erkennung von Gemeinsamkeiten zwischen den Feed Typen selbst sehr komplex
  461. ist, sollte erwähnt werden das RSS selbst eine konstant strittige "Spezifikation".
  462. Das hat seine Wurzeln im originalen RSS 2.0 Dokument welches Doppeldeutigkeiten
  463. enthält und die richtige Behandlung alle Elemente nicht im Detail erklärt. Als
  464. Ergebnis verwendet diese Komponente riguros die RSS 2.0.11 Spezifikation welche vom
  465. RSS Advisory Board veröffentlicht wurde und dessen beigefügtes RSS Best Practices
  466. Profil. Keine andere Interpretation von RSS 2.0 wird unterstützt wobei Ausnahmen
  467. erlaubt sein können wo es die anwendung der zwei vorher erwähnten Dokumente nicht
  468. direkt verhindert.
  469. </para>
  470. </note>
  471. <para>
  472. Natürlich leben wir nicht in einer idealen Welt sodas es Zeiten gibt in denen die
  473. <acronym>API</acronym> einfach nicht das bietet wonach man sucht. Um hierbei zu helfen
  474. bietet <classname>Zend_Feed_Reader</classname> ein Plugin System an das es erlaubt
  475. Erweiterungen zu schreiben und die Kern <acronym>API</acronym> zu erweitern sowie
  476. alle zusätzliche Daten abzudecken die man von Feeds extrahieren will. Wenn das schreiben
  477. einer weiteren Erweiterung zu problematisch ist, kann man einfach das darunterliegende
  478. <acronym>DOM</acronym> oder die XPath Objekte holen und das von Hand in der Anwendung
  479. machen. Natürlich sollte wirklich eine Erweiterung geschrieben werden, einfach um es
  480. portabler und wiederverwendbarer zu machen. Und nützliche Erweiterungen können für den
  481. Framework vorgeschlagen werden um Sie formal hinzuzufügen.
  482. </para>
  483. <para>
  484. Hier ist eine Zusammenfassung der Kern <acronym>API</acronym> für Feeds. Man sollte
  485. beachten das es nicht nur die grundsätzlichen <acronym>RSS</acronym> und Atom
  486. Standard abdeckt, sondern das es auch eine Anzahl von mitgelieferten Erweiterungen
  487. gibt die mit <classname>Zend_Feed_Reader</classname> gebündelt sind. Die Benennung
  488. dieser Methoden von Erweiterungen ist recht generisch - alle erweiterten Methoden
  489. arbeiten auf dem gleichen Level wie die Kern <acronym>API</acronym> da wir es
  490. erlauben alle spefizischen Erweiterungs Objekte separat zu empfangen wenn das
  491. notwendig ist.
  492. </para>
  493. <table>
  494. <title>API Methoden auf dem Level des Feeds</title>
  495. <tgroup cols="2">
  496. <tbody>
  497. <row>
  498. <entry><methodname>getId()</methodname></entry>
  499. <entry>
  500. Gibt eine eindeutige ID zurück die mit dem Feed assoziiert ist
  501. </entry>
  502. </row>
  503. <row>
  504. <entry><methodname>getTitle()</methodname></entry>
  505. <entry>Gibt den Titel des Feeds zurück</entry>
  506. </row>
  507. <row>
  508. <entry><methodname>getDescription()</methodname></entry>
  509. <entry>Gibt die textuelle Beschreibung des Feeds zurück</entry>
  510. </row>
  511. <row>
  512. <entry><methodname>getLink()</methodname></entry>
  513. <entry>
  514. Gibt eine <acronym>URI</acronym> zu der <acronym>HTML</acronym> Webseite
  515. zurück welche die gleiche oder ähnliche Informationen wie dieser Feed
  516. enthält (z.B. wenn der Feed von einem Blog ist, sollte die
  517. <acronym>URI</acronym> des Blogs enthalten sein indem die
  518. <acronym>HTML</acronym> Version des Eintrags gelesen werden kann)
  519. </entry>
  520. </row>
  521. <row>
  522. <entry><methodname>getFeedLink()</methodname></entry>
  523. <entry>
  524. Gibt die <acronym>URI</acronym> dieses Feeds zurück, welche die gleiche
  525. sein kann wie die <acronym>URI</acronym> welche verwendet wurde um
  526. den Feed zu importieren. Es gibt wichtige Fälle in denen sich der Feed
  527. Link unterscheiden kann weil die Quell URI aktualisiert wird und
  528. geplant ist Sie in Zukunft zu entfernen.
  529. </entry>
  530. </row>
  531. <row>
  532. <entry><methodname>getAuthors()</methodname></entry>
  533. <entry>
  534. Gibt ein Objekt vom Typ
  535. <classname>Zend_Feed_Reader_Collection_Author</classname> zurück welches
  536. ein <classname>ArrayObject</classname> ist dessen Elemente einfach
  537. Arrays sind die eine Kombination der Schlüssel "name", "email" und
  538. uri" enthalten. Wo es wegen der Quelldaten irrelevant ist können
  539. einige dieser Schlüssel unterdrückt werden.
  540. </entry>
  541. </row>
  542. <row>
  543. <entry><methodname>getAuthor(integer $index = 0)</methodname></entry>
  544. <entry>
  545. Gibt entweder den ersten bekannten Author zurück, oder mit dem
  546. optionalen Parameter <varname>$index</varname> jeden spezifischen
  547. Index des Arrays von Authoren wie vorher beschrieben (gibt
  548. <constant>NULL</constant> bei einem ungültigen Index zurück).
  549. </entry>
  550. </row>
  551. <row>
  552. <entry><methodname>getDateCreated()</methodname></entry>
  553. <entry>
  554. Gibt das Datum zurück zu dem dieser Feed erstellt wurde. Generell nur
  555. anwendbar bei Atom da es das Datum repräsentiert zu der das Atom 1.0
  556. Dokument erstellt wurde das die Ressource beschreibt. Das zurückgegebene
  557. Datum ist ein <classname>Zend_Date</classname> Objekt.
  558. </entry>
  559. </row>
  560. <row>
  561. <entry><methodname>getDateModified()</methodname></entry>
  562. <entry>
  563. Gibt das Datum zurück zu dem der Feed das letzte mal geändert wurde. Das
  564. zurückgegebene Datum ist ein <classname>Zend_Date</classname> Objekt.
  565. </entry>
  566. </row>
  567. <row>
  568. <entry><methodname>getLanguage()</methodname></entry>
  569. <entry>
  570. Gibt die Sprache des Feeds zurüc (wenn definiert) oder einfach die
  571. Sprache die im <acronym>XML</acronym> Dokument notiert wurde
  572. </entry>
  573. </row>
  574. <row>
  575. <entry><methodname>getGenerator()</methodname></entry>
  576. <entry>
  577. Gibt den Erzeuger des Feeds zurück, z.B. die Software die Ihn erzeugt
  578. hat. Das kann sich zwischen <acronym>RSS</acronym> und Atom
  579. unterscheiden, da Atom eine andere Schreibweise definiert.
  580. </entry>
  581. </row>
  582. <row>
  583. <entry><methodname>getCopyright()</methodname></entry>
  584. <entry>
  585. Gibt alle Copyright Notizen zurück die mit dem Feed assoziiert sind
  586. </entry>
  587. </row>
  588. <row>
  589. <entry><methodname>getHubs()</methodname></entry>
  590. <entry>
  591. Gibt ein Array der <acronym>URI</acronym> Endpunkte aller Hub Server
  592. zurück welche vom Feed für die Berwendung mit dem Pubsubhubbub
  593. Protokoll bekanntgegeben werden, und erlaubt damit das Einschreiben
  594. für Feeds für Real-Time Updates.
  595. </entry>
  596. </row>
  597. <row>
  598. <entry><methodname>getCategories()</methodname></entry>
  599. <entry>
  600. Gibt ein <classname>Zend_Feed_Reader_Collection_Category</classname>
  601. Objekt zurück welches die Details aller Kategorien enthält die im
  602. kompletten Feed enthalten sind. Die unterstützten Felder enthalten
  603. "term" (den Maschinen lesbaren Namen der Kategorie), "scheme"
  604. (dem Schema der Kategorisierung für diese Kategorie), und "label" (ein
  605. Html dekodierter menschlich lesbarer Kategoriename). Wenn irgendeines
  606. der drei Felder abwesend ist, werden Sie entweder auf die näheste
  607. vorhandene Alternative gesetzt, oder im Fall von "scheme", auf
  608. <constant>NULL</constant> gesetzt.
  609. </entry>
  610. </row>
  611. </tbody>
  612. </tgroup>
  613. </table>
  614. <para>
  615. Angehend von der Vielzahl von Feeds in der Wildnis, werden einige dieser Methoden
  616. erwartungsgemäßg <constant>NULL</constant> zurückgeben, was anzeigt das die relevanten
  617. Informationen nicht gefunden wurden. Wo es möglich ist wird
  618. <classname>Zend_Feed_Reader</classname> wärend der Suche auf alternative Elemente
  619. zurück greifen. Zum Beispiel ist das Durchsuchen eines <acronym>RSS</acronym> Feeds
  620. nach einem Modifikations Datum komplizierter als es aussieht. <acronym>RSS</acronym>
  621. Feeds sollten ein <command>&lt;lastBuildDate&gt;</command> Tag und (oder) ein
  622. <command>&lt;pubDate&gt;</command> Element enthalten. Aber was wenn Sie es nicht tun,
  623. weil es z.B. ein <acronym>RSS</acronym> 1.0 Feed ist? Vielleicht ist stattdessen ein
  624. <command>&lt;atom:updated&gt;</command> Element mit identischen Informationen vorhanden
  625. (Atom kann verwendet werden um die <acronym>RSS</acronym> Syntax anzubieten)? Bei einem
  626. Fehlschlag können wir einfach auf die Einträge sehen, den aktuellsten herausholen, und
  627. sein <command>&lt;pubDate&gt;</command> Element verwenden. In der Annahme das es
  628. existiert... viele Feeds verwenden auch Dublin Core 1.0/1.1
  629. <command>&lt;dc:date&gt;</command> Elemente für Feeds und Einträge. Oder wir können
  630. wieder ein Atom finden das herumliegt.
  631. </para>
  632. <para>
  633. Der Punkt ist, das <classname>Zend_Feed_Reader</classname> entwickelt wurde um das zu
  634. wissen. Wenn man nach dem Änderungsdatum fragt (oder irgendwas anderes), wird er
  635. starten und alle diese Alternativen suchen bis er entweder aufgibt und
  636. <constant>NULL</constant> zurückgibt, oder eine Alternative findet welche die richtige
  637. Antwort hat.
  638. </para>
  639. <para>
  640. Zusätzlich zu den obigen Methoden, implementieren alle Feed Objekte Methoden für das
  641. empfangen der <acronym>DOM</acronym> und XPath Objekte für die aktuellen Feeds wie
  642. vorher beschrieben. Feed Objekte implementieren auch die Interfaces für
  643. <acronym>SPL</acronym> Iterator und Countable. Die erweiterte <acronym>API</acronym>
  644. wird anbei zusammengefasst.
  645. </para>
  646. <table>
  647. <title>Erweiterte API Methoden auf Level des Feeds</title>
  648. <tgroup cols="2">
  649. <tbody>
  650. <row>
  651. <entry><methodname>getDomDocument()</methodname></entry>
  652. <entry>
  653. Gibt das elterliche <classname>DOMDocument</classname> Objekt für das
  654. komplette <acronym>XML</acronym> Quelldokument zurück
  655. </entry>
  656. </row>
  657. <row>
  658. <entry><methodname>getElement()</methodname></entry>
  659. <entry>
  660. Gibt das aktuelle <classname>DOMElement</classname> Objekt des Feed
  661. Levels zurück
  662. </entry>
  663. </row>
  664. <row>
  665. <entry><methodname>saveXml()</methodname></entry>
  666. <entry>
  667. Gibt einen String zurück der ein <acronym>XML</acronym> Dokument
  668. zurück welches das komplette Feed Element enthält (das ist nicht das
  669. originale Dokument sondern eine nachgebaute Version)
  670. </entry>
  671. </row>
  672. <row>
  673. <entry><methodname>getXpath()</methodname></entry>
  674. <entry>
  675. Gibt das intern verwendete <classname>DOMXPath</classname> Objekt
  676. zurück mit dem Abfragen auf das <classname>DOMDocument</classname>
  677. Objekt durchgeführt werden (das enthält die Kern und Erweiterungs
  678. Namespaces die vor-registriert sind)
  679. </entry>
  680. </row>
  681. <row>
  682. <entry><methodname>getXpathPrefix()</methodname></entry>
  683. <entry>
  684. Gibt den gültigen <acronym>DOM</acronym> Pfad Präfix zurück der bei
  685. allen XPath Abfragen passt die dem Feed entsprechen der abgefragt wird.
  686. </entry>
  687. </row>
  688. <row>
  689. <entry><methodname>getEncoding()</methodname></entry>
  690. <entry>
  691. Gibt die Kodierung des <acronym>XML</acronym> Quelldokuments zurück
  692. (Beachte: Das kann nicht verwendet werden für Fehler wie einen
  693. Server der Dokumente in einer anderen Kodierung verschickt). Wo diese
  694. nicht definiert ist, wird die Standardkodierung UTF-8 von Unicode
  695. angewendet.
  696. </entry>
  697. </row>
  698. <row>
  699. <entry><methodname>count()</methodname></entry>
  700. <entry>
  701. Gibt eine Zahl von Einträgen oder Elementen zurück welche dieser Feed
  702. enthält (implementiert das <acronym>SPL</acronym> Interface
  703. <classname>Countable</classname>)
  704. </entry>
  705. </row>
  706. <row>
  707. <entry><methodname>current()</methodname></entry>
  708. <entry>
  709. Gibt nur den aktuellen Eintrag zurück (verwendet den aktuellen
  710. Index von <methodname>key()</methodname>)
  711. </entry>
  712. </row>
  713. <row>
  714. <entry><methodname>key()</methodname></entry>
  715. <entry>Gibt den aktuellen Index für Einträge zurück</entry>
  716. </row>
  717. <row>
  718. <entry><methodname>next()</methodname></entry>
  719. <entry>Addiert den Wert des Index für Einträge um Eins</entry>
  720. </row>
  721. <row>
  722. <entry><methodname>rewind()</methodname></entry>
  723. <entry>Setzt den Index für Einträge auf 0 zurück</entry>
  724. </row>
  725. <row>
  726. <entry><methodname>valid()</methodname></entry>
  727. <entry>
  728. Prüft ob der aktuelle Index für Einträge gültig ist, z.B. ob er nicht
  729. unter 0 fällt und die Anzahl der existierenden Einträge nicht
  730. übersteigt.
  731. </entry>
  732. </row>
  733. <row>
  734. <entry><methodname>getExtensions()</methodname></entry>
  735. <entry>
  736. Gibt ein Array aller Erweiterungs Objekte zurück die für den aktuellen
  737. Feed geladen sind (Beachte: sowohl Feel-Level als auch Element-Level
  738. Erweiterungen exstieren, aber nur Feed-Level Erweiterungen werden hier
  739. zurückgegeben). Die Array Schlüssel sind in der Form
  740. (ErweiterungsName)_Feed.
  741. </entry>
  742. </row>
  743. <row>
  744. <entry><methodname>getExtension(string $name)</methodname></entry>
  745. <entry>
  746. Gibt ein Erweiterungs Objekt für den Feed zurück der unter dem
  747. angegebenen Namen registriert ist. Das erlaubt einen feiner
  748. gestaffelten Zugriff auf Erweiterungen welche andernfalls in der
  749. Implementation der standardmäßigen <acronym>API</acronym> Methoden
  750. versteckt wären.
  751. </entry>
  752. </row>
  753. <row>
  754. <entry><methodname>getType()</methodname></entry>
  755. <entry>
  756. Gibt eine statische Klassenkonstante zurück (z.B.
  757. <constant>Zend_Feed_Reader::TYPE_ATOM_03</constant>, z.B. Atom 0.3)
  758. welche exakt anzeigt welche Art von Feed gerade konsumiert wird.
  759. </entry>
  760. </row>
  761. </tbody>
  762. </tgroup>
  763. </table>
  764. </sect2>
  765. <sect2 id="zend.feed.reader.entry">
  766. <title>Empfangen von Informationen aus Einträgen/Elementen</title>
  767. <para>
  768. Das Empfangen von Informationen für spezifische Einträge oder Elemente (abhängig davon
  769. ob man Atom oder <acronym>RSS</acronym> spricht) ist identisch wie bei den Daten auf
  770. Feed Level. Der Zugriff auf Einträge ist einfach ein Fall von Iteration über ein Feed
  771. Objekt oder durch Verwendung des <acronym>SPL</acronym> Interfaces
  772. <classname>Iterator</classname> welches Feed Objekte implementieren und durch
  773. Aufruf der betreffenden Methoden auf Ihnen.
  774. </para>
  775. <table>
  776. <title>API Methoden auf Level des Eintrags</title>
  777. <tgroup cols="2">
  778. <tbody>
  779. <row>
  780. <entry><methodname>getId()</methodname></entry>
  781. <entry>Gibt eine eindeutige ID für den aktuellen Eintrag zurück.</entry>
  782. </row>
  783. <row>
  784. <entry><methodname>getTitle()</methodname></entry>
  785. <entry>Gibt den Titel des aktuellen Eintrags zurück.</entry>
  786. </row>
  787. <row>
  788. <entry><methodname>getDescription()</methodname></entry>
  789. <entry>Gibt eine Beschreibung des aktuellen Eintrags zurück.</entry>
  790. </row>
  791. <row>
  792. <entry><methodname>getLink()</methodname></entry>
  793. <entry>
  794. Gibt eine <acronym>URI</acronym> zur <acronym>HTML</acronym> Version des
  795. aktuellen Eintrags zurück.
  796. </entry>
  797. </row>
  798. <row>
  799. <entry><methodname>getPermaLink()</methodname></entry>
  800. <entry>
  801. Gibt einen permanenten Link zum aktuellen Eintrag zurück. In den meisten
  802. Fällen ist dies das selbe wie die Verwendung von
  803. <methodname>getLink()</methodname>.
  804. </entry>
  805. </row>
  806. <row>
  807. <entry><methodname>getAuthors()</methodname></entry>
  808. <entry>
  809. Gibt ein Objekt vom Typ
  810. <classname>Zend_Feed_Reader_Collection_Author</classname> zurück welches
  811. ein <classname>ArrayObject</classname> ist, dessen Elemente alle
  812. einfache Array sind welche beliebige Kombinationen der Schlüssel "name",
  813. "email" und "uri" enthalten können. Wo es für die Quelldaten irrelevant
  814. ist können einige dieser Schlüssel unterdrückt sein.
  815. </entry>
  816. </row>
  817. <row>
  818. <entry><methodname>getAuthor(integer $index = 0)</methodname></entry>
  819. <entry>
  820. Gibt entweder den ersten bekannten Autor zurück, oder mit dem
  821. optionalen Parameter <varname>$index</varname> jeden spezifischen Index
  822. aus dem Array der Authoren wie vorher beschrieben (gibt
  823. <constant>NULL</constant> zurück wenn der Index ungültig ist).
  824. </entry>
  825. </row>
  826. <row>
  827. <entry><methodname>getDateCreated()</methodname></entry>
  828. <entry>
  829. Gibt das Datum zurück an dem der aktuelle Eintrag erstellt wurde.
  830. Generell kann das nur auf Atom angewendet werden wo es das Datum der
  831. Ressource beschreibt zu welche das Atom 1.0 Dokument erstellt wurde.
  832. </entry>
  833. </row>
  834. <row>
  835. <entry><methodname>getDateModified()</methodname></entry>
  836. <entry>
  837. Gibt das Datum zurück an welchem der aktuelle Eintrag zuletzt geändert
  838. wurde.
  839. </entry>
  840. </row>
  841. <row>
  842. <entry><methodname>getContent()</methodname></entry>
  843. <entry>
  844. Gibt den Inhalt des aktuellen Eintrags zurück (das retourniert alle
  845. Entities wenn das möglich ist, mit der Annahme das der Content Type
  846. <acronym>HTML</acronym> ist). Die Beschreibung wird zurückgegeben wenn
  847. ein kein seperates Content Element existiert.
  848. </entry>
  849. </row>
  850. <row>
  851. <entry><methodname>getEnclosure()</methodname></entry>
  852. <entry>
  853. Gibt ein Array zurück welches die Werte aller Attribute eines
  854. Multimedia &lt;enclosure&gt; Elements enthält, inklusive der Array
  855. Schlüssel: <emphasis>url</emphasis>, <emphasis>length</emphasis>,
  856. <emphasis>type</emphasis>. Basierend auf dem RSS Best Practices Profile
  857. des TSS Advisory Boards, wird keine Unterstützung für mehrere Enclosures
  858. angeboten da so eine Unterstützung kein Teil der RSS Spezifikation ist.
  859. </entry>
  860. </row>
  861. <row>
  862. <entry><methodname>getCommentCount()</methodname></entry>
  863. <entry>
  864. Gibt die Anzahl der Kommentare zurück die auf diesen Eintrag gemacht
  865. wurden seit der Zeit an welcher der Feed erstellt wurde
  866. </entry>
  867. </row>
  868. <row>
  869. <entry><methodname>getCommentLink()</methodname></entry>
  870. <entry>
  871. Gibt eine <acronym>URI</acronym> zurück welche auf die
  872. <acronym>HTML</acronym> Seite zeigt, auf der Kommentare zu diesem
  873. Eintrag gemacht werden können
  874. </entry>
  875. </row>
  876. <row>
  877. <entry>
  878. <methodname>getCommentFeedLink([string $type =
  879. 'atom'|'rss'])</methodname>
  880. </entry>
  881. <entry>
  882. Gibt eine <acronym>URI</acronym> zurück die auf einen Feed zeigt welcher
  883. vom angegebenen Typ ist, und alle Kommentare für diesen Eintrag enthält
  884. (Der Typ ist standardmäßig Atom/<acronym>RSS</acronym> abhängig vom
  885. aktuellen Feed Typ).
  886. </entry>
  887. </row>
  888. <row>
  889. <entry><methodname>getCategories()</methodname></entry>
  890. <entry>
  891. Gibt ein <classname>Zend_Feed_Reader_Collection_Category</classname>
  892. Objekt zurück welches die Details jeder Kategorie enthält welche mit dem
  893. Eintrag assoziiert ist. Die unterstützten Felder sind "term" (der
  894. Maschinen lesbare Name der Kategorie), "scheme" (der Name des Schemas
  895. der Kategorisierung für diese Kategorie), und "label" (ein Html
  896. dekodierter menschlich lesbarer Name der Kategorie). Wenn eines der drei
  897. Felder nicht vorhanden ist, werden Sie entweder auf den näheste
  898. vorhandene Alternative, oder im Fall von "scheme", auf
  899. <constant>NULL</constant> gesetzt.
  900. </entry>
  901. </row>
  902. </tbody>
  903. </tgroup>
  904. </table>
  905. <para>
  906. Die erweiterte <acronym>API</acronym> für Einträge ist identisch zu der für die Feed
  907. mit der Aufnahme der Iterator Methoden die hier nicht benötigt werden.
  908. </para>
  909. <caution>
  910. <para>
  911. Es gibt oft Missverständnisse über die Konzepte vom Zeitpunkt der Änderung und des
  912. Erstellungsdatums. In Atom, sind diese zwei klar definierte Konzepte aber in
  913. <acronym>RSS</acronym> sind Sie vage. <acronym>RSS</acronym> 2.0 definiert ein
  914. einzelnes <emphasis>&lt;pubDate&gt;</emphasis> Element das typischerweise auf das
  915. Datum referiert an dem dieser Eintrag veröffentlicht wurde, z.B. etwas in der Art
  916. eines Erstellungsdatums. Das ist nicht immer das gleiche, und kann sich durch
  917. Updates ändern oder auch nicht. Als Resultat sollte man sich, wenn man wirklich
  918. prüfen will ob der Eintrag geändert wurde oder nicht, nicht auf das Ergebnis von
  919. <methodname>getDateModified()</methodname> verlassen. Stattdessen sollte man
  920. Erwägen den <acronym>MD5</acronym> Hash von drei anderen verknpüften Elementen
  921. zu beobachten, z.B. durch Verwendung von <methodname>getTitle()</methodname>,
  922. <methodname>getDescription()</methodname> und
  923. <methodname>getContent()</methodname>. Wenn der Eintrag wirklich geändert wurde,
  924. gibt diese Hash Berechnung ein anderes Ergebnis als die vorher gespeicherten Hashs
  925. für den gleichen Eintrag. Das ist natürlich Inhalts-Orientiert und hilft nicht
  926. bei der Erkennung von anderen relevanten Elementen. Atom Feeds sollten solche
  927. Schritte nicht benötigen.
  928. </para>
  929. <para>
  930. Weitere Schritte in diesen Wassern zeigen das die Daten
  931. von Feeds unterschiedlichen Standards folgen. Atom und Dublin Core Daten sollten
  932. <acronym>ISO</acronym> 86001 folgen und <acronym>RSS</acronym> Daten sollten
  933. <acronym>RFC</acronym> 822 oder <acronym>RFC</acronym> 2822 folgen welche auch
  934. üblicherweise verwendet werden. Datumsmethoden werfen eine Exception wenn
  935. <classname>Zend_Date</classname>, oder die PHP basierenden Möglichkeiten für
  936. <acronym>RSS</acronym> Daten, das Datum durch Verwendung der obigen Standards
  937. nicht laden kann.
  938. </para>
  939. </caution>
  940. <warning>
  941. <para>
  942. Die Werte die von diesen Methoden zurückgegeben werden, sind nicht geprüft. Das
  943. bedeutet das der Benutzer Prüfungen auf allen empfangenen Daten durchführen muss
  944. inklusive filtern von jeglichem <acronym>HTML</acronym> wie von
  945. <methodname>getContent()</methodname> bevor es von der eigenen Anwendung ausgegeben
  946. wird. Es ist zu beachten das die meisten Feeds von externen Quellen kommen, und
  947. deshalb die normale Annahme sein sollte das man Ihnen nicht trauen kann.
  948. </para>
  949. </warning>
  950. <table>
  951. <title>Erweiterte API Methoden auf Level des Eintrags</title>
  952. <tgroup cols="2">
  953. <tbody>
  954. <row>
  955. <entry><methodname>getDomDocument()</methodname></entry>
  956. <entry>
  957. Gibt das elterliche <classname>DOMDocument</classname> Objekt für den
  958. kompletten Feed zurück (nicht nur den aktuellen Eintrag)
  959. </entry>
  960. </row>
  961. <row>
  962. <entry><methodname>getElement()</methodname></entry>
  963. <entry>
  964. Gibt das <classname>DOMDocument</classname> Objekt für den
  965. aktuellen Level des Eintrags zurück
  966. </entry>
  967. </row>
  968. <row>
  969. <entry><methodname>getXpath()</methodname></entry>
  970. <entry>
  971. Gibt das <classname>DOMXPath</classname> Objekt zurück welches
  972. intern verwendet wird um Abfragen auf dem
  973. <classname>DOMDocument</classname> Objekt durchzuführen (das enthält
  974. auch die vorregistrierten Kern und Erweiterungs Namespaces)
  975. </entry>
  976. </row>
  977. <row>
  978. <entry><methodname>getXpathPrefix()</methodname></entry>
  979. <entry>
  980. Gibt einen gültigen <acronym>DOM</acronym> Pfad Präfix zurück der allen
  981. XPath Abfrage vorangestellt wird, welche dem Eintrag entsprechen der
  982. abgefragt wird.
  983. </entry>
  984. </row>
  985. <row>
  986. <entry><methodname>getEncoding()</methodname></entry>
  987. <entry>
  988. Gibt die Kodierung des <acronym>XML</acronym> Quelldokuments zurück
  989. (Achtung: Das kann nicht für Fehler genommen werden bei denen der
  990. Server eine andere Kodierung sendet als die Dokumente). Die Standard
  991. Kodierung welche bei Abwesenheit jeglicher anderen Kodierung angewendet
  992. wird, ist die UTF-8 Kodierung von Unicode.
  993. </entry>
  994. </row>
  995. <row>
  996. <entry><methodname>getExtensions()</methodname></entry>
  997. <entry>
  998. Gibt ein Array aller Erweiterungsobjekte zurück die für den aktuellen
  999. Eintrag geladen wurden (Achtung: Sowohl Erweiterung auf Level von Feeds
  1000. als auch auf Level von Einträgen existieren, und nur Erweiterungen auf
  1001. Level von Einträgen werden hier zurückgegeben). Die Arrayschlüssel sind
  1002. im Format {ErweiterungsName}_Entry.
  1003. </entry>
  1004. </row>
  1005. <row>
  1006. <entry><methodname>getExtension(string $name)</methodname></entry>
  1007. <entry>
  1008. Gibt das Erweiterungsobjekt zurück für das der Eintrag mit dem
  1009. angegebenen Namen registriert wurde. Das erlaubt einen feineren
  1010. Zugriff auf Erweiterungen welche andernfalls innerhalb der
  1011. Implementierung der standardmäßigen <acronym>API</acronym> Methoden
  1012. versteckt wären.
  1013. </entry>
  1014. </row>
  1015. <row>
  1016. <entry><methodname>getType()</methodname></entry>
  1017. <entry>
  1018. Gibt eine statische Klassenkonstante zurück (z.B.
  1019. <constant>Zend_Feed_Reader::TYPE_ATOM_03</constant>, z.B. Atom 0.3)
  1020. die exakt anzeigt von welcher Art der Feed ist der gerade konsumiert
  1021. wird.
  1022. </entry>
  1023. </row>
  1024. </tbody>
  1025. </tgroup>
  1026. </table>
  1027. </sect2>
  1028. <sect2 id="zend.feed.reader.extending">
  1029. <title>Erweitern der APIs für Feeds und Einträge</title>
  1030. <para>
  1031. Die Erweiterung von <classname>Zend_Feed_Reader</classname> erlaubt es Methoden sowohl
  1032. auf Level von Feeds als auch auf Level von Einträgen hinzuzufügen, welche das Empfangen
  1033. von Informationen abdecken die nicht bereits von <classname>Zend_Feed_Reader</classname>
  1034. unterstützt werden. Bei der Anzahl an <acronym>RSS</acronym> und Atom Erweiterungen die
  1035. existieren, ist das ein guter Weg da <classname>Zend_Feed_Reader</classname> einfach
  1036. nicht alles hinzufügen kann.
  1037. </para>
  1038. <para>
  1039. Es gibt zwei Typen von Erweiterungen, jene welche Informationen von Elementen empfangen
  1040. die unmittelbare Kunder des Root Elements sind (z.B. <command>&lt;channel&gt;</command>
  1041. für <acronym>RSS</acronym> oder <command>&lt;feed&gt;</command> für Atom), und jene die
  1042. Informationen von Kind-Elementen eines Eintrags empfangen (z.B.
  1043. <command>&lt;item&gt;</command> für <acronym>RSS</acronym> oder
  1044. <command>&lt;entry&gt;</command> für Atom). Auf dem Filesystem sind Sie als Klassen in
  1045. einem Namespace gruppiert, basierend auf dem Standardnamen der Erweiterung. Zum Beispiel
  1046. haben wir intern <classname>Zend_Feed_Reader_Extension_DublinCore_Feed</classname> und
  1047. <classname>Zend_Feed_Reader_Extension_DublinCore_Entry</classname> Klassen welche zwei
  1048. Klassen sind welche die Unterstützung für Dublin Core 1.0/1.1 implementieren.
  1049. </para>
  1050. <para>
  1051. Erweiterungen werden in <classname>Zend_Feed_Reader</classname> durch Verwendung von
  1052. <classname>Zend_Loader_PluginLoader</classname> geladen, sodas dessen Operationen
  1053. ähnlich denen anderer Zend Framework Komponenten ist.
  1054. <classname>Zend_Feed_Reader</classname> kommt bereits mit einer Anzahl dieser
  1055. Erweiterungen. Trotzdem müssen jene, die nicht intern verwendet und standardmäßig
  1056. registriert werden (sogenannte Core Erweiterungen), bei
  1057. <classname>Zend_Feed_Reader</classname> registriert werden bevor Sie verwendet werden.
  1058. Die gebündelten Erweiterungen sind:
  1059. </para>
  1060. <table>
  1061. <title>Core Extensions (pre-registered)</title>
  1062. <tgroup cols="2">
  1063. <tbody>
  1064. <row>
  1065. <entry>DublinCore (Feed und Eintrag)</entry>
  1066. <entry>
  1067. Implementiert die Unterstützung für das Dublin Core Metadata Element
  1068. Set 1.0 und 1.1
  1069. </entry>
  1070. </row>
  1071. <row>
  1072. <entry>Content (nur Eintrag)</entry>
  1073. <entry>Implementiert Unterstützung für Content 1.0</entry>
  1074. </row>
  1075. <row>
  1076. <entry>Atom (Feed und Eintrag)</entry>
  1077. <entry>Implementiert Unterstützung für Atom 0.3 und Atom 1.0</entry>
  1078. </row>
  1079. <row>
  1080. <entry>Slash</entry>
  1081. <entry>
  1082. Implementiert Unterstützung für das Slash <acronym>RSS</acronym> 1.0
  1083. Modul
  1084. </entry>
  1085. </row>
  1086. <row>
  1087. <entry>WellFormedWeb</entry>
  1088. <entry>
  1089. Implementiert Unterstützung für das Well Formed Web CommentAPI 1.0
  1090. </entry>
  1091. </row>
  1092. <row>
  1093. <entry>Thread</entry>
  1094. <entry>
  1095. Implementiert Unterstützung für Atom Threading Erweiterungen wie in
  1096. <acronym>RFC</acronym> 4685 beschrieben
  1097. </entry>
  1098. </row>
  1099. <row>
  1100. <entry>Podcast</entry>
  1101. <entry>
  1102. Implementiert Unterstützung für das Podcast 1.0 <constant>DTD</constant>
  1103. von Apple
  1104. </entry>
  1105. </row>
  1106. </tbody>
  1107. </tgroup>
  1108. </table>
  1109. <para>
  1110. Die Core Erweiterungen sind irgendwie speziell da Sie extrem allgemein sind und viele
  1111. Facetten haben. Zum Beispiel haben wir eine Core Erweiterung für Atom. Atom ist als
  1112. Erweiterung (und nicht nur als Basis Klasse) implementiert weil es ein gültiges
  1113. <acronym>RSS</acronym> Modul dupliziert - so kann man Atom Elemente in
  1114. <acronym>RSS</acronym> Feeds einfügen. Wir haben sogar <acronym>RDF</acronym> Feeds
  1115. gesehen die viel von Atom verwenden statt den üblicheren Erweiterungen wie Dublin Core.
  1116. </para>
  1117. <table>
  1118. <title>Nicht-Core Erweiterungen (müssen per Hand registriert werden)</title>
  1119. <tgroup cols="2">
  1120. <tbody>
  1121. <row>
  1122. <entry>Syndication</entry>
  1123. <entry>
  1124. Implementiert Unterstützung für Syndication 1.0 <acronym>RSS</acronym>
  1125. Feeds
  1126. </entry>
  1127. </row>
  1128. <row>
  1129. <entry>CreativeCommons</entry>
  1130. <entry>
  1131. Ein <acronym>RSS</acronym> Modul das ein Element auf &lt;channel&gt;
  1132. oder &lt;item&gt; Level hinzufügt welches spezifiziert welche
  1133. Creative Commons Lizenz anzuwenden ist.
  1134. </entry>
  1135. </row>
  1136. </tbody>
  1137. </tgroup>
  1138. </table>
  1139. <para>
  1140. Die zusätzlichen nicht-Core Erweiterungen werden angeboten aber standardmäßig bei
  1141. <classname>Zend_Feed_Reader</classname> nicht registriert. Wenn man Sie verwenden will,
  1142. muß man <classname>Zend_Feed_Reader</classname> sagen dass Sie diese zusätzlich zum
  1143. Importieren eines Feeds laden soll. Zusätzliche nicht-Core Erweiterungen werden in
  1144. zukünftigen Releases dieser Komponente enthalten sein.
  1145. </para>
  1146. <para>
  1147. Das Registrieren einer Erweiterung bei <classname>Zend_Feed_Reader</classname>, so dass
  1148. diese geladen wird und dessen <acronym>API</acronym> für Feed und Entry Objekte zur
  1149. Verfügung steht, ist eine einfache Sache wenn der
  1150. <classname>Zend_Loader_PluginLoader</classname> verwendet wird. Hier registrieren wir
  1151. die optionale Slash Erweiterung und finden heraus das Sie direkt von der Entry Level
  1152. <acronym>API</acronym> heraus aufgerufen werden kann, ohne große Dinge notwendig sind.
  1153. Es ist zu beachten das die Namen der Erweiterungen von der Schreibweise abhängig sind
  1154. und Camel Casing für mehrere Ausdrücke verwenden.
  1155. </para>
  1156. <programlisting language="php"><![CDATA[
  1157. Zend_Feed_Reader::registerExtension('Syndication');
  1158. $feed = Zend_Feed_Reader::import('http://rss.slashdot.org/Slashdot/slashdot');
  1159. $updatePeriod = $feed->current()->getUpdatePeriod();
  1160. ]]></programlisting>
  1161. <para>
  1162. Im obigen Beispiel haben wir geprüft wie oft ein Feed aktualisiert wurde indem wir die
  1163. <methodname>getUpdatePeriod()</methodname> Methode verwendet haben. Da das nicht Teil
  1164. der Kern <acronym>API</acronym> von <classname>Zend_Feed_Reader</classname> ist, kann es
  1165. nur eine Methode sein die von der neu registrieren Syndication Erweiterung unterstützt
  1166. wird.
  1167. </para>
  1168. <para>
  1169. Wie man auch sieht, kann man auf die neuen Methoden vlon Erweiterungen aus der Haupt
  1170. <acronym>API</acronym> heraus zugreifen indem <acronym>PHP</acronym>'s magische
  1171. Methoden verwendet werden. Als Alternative kann man, für ein ähnliches Ergebnis, auf
  1172. jedes Erweiterungs Objekt auch direkt zugreifen, wie anbei gezeigt.
  1173. </para>
  1174. <programlisting language="php"><![CDATA[
  1175. Zend_Feed_Reader::registerExtension('Syndication');
  1176. $feed = Zend_Feed_Reader::import('http://rss.slashdot.org/Slashdot/slashdot');
  1177. $syndication = $feed->getExtension('Syndication');
  1178. $updatePeriod = $syndication->getUpdatePeriod();
  1179. ]]></programlisting>
  1180. <sect3 id="zend.feed.reader.extending.feed">
  1181. <title>Erweiterungen für Zend_Feed_Reader schreiben</title>
  1182. <para>
  1183. Unweigerlich gibt es Zeiten in denen die <acronym>API</acronym> von
  1184. <classname>Zend_Feed_Reader</classname> einfach nicht in der Lage ist etwas das man
  1185. von einem Feed oder Eintrag benötigt zu erhalten. Man kann die darunterliegenden
  1186. Quell Objekte, wie ein <classname>DOMDocument</classname>, verwenden um Sie
  1187. von Hand zu erhalten. Trotzdem sind weitere wiederverwendbare Methoden vorhanden
  1188. indem man Erweiterungen schreibt die diese neuen Abfragen unterstützen.
  1189. </para>
  1190. <para>
  1191. Als Beispiel nehmen wir den Fall eine komplett fiktiven Firma an die Jungle Books
  1192. heißt. Jungle Books hat eine Vielzahl an Reviews für Bücher veröffentlicht die Sie
  1193. verkaufen (von externen Quellen und Kunden), welche als <acronym>RSS</acronym> 2.0
  1194. Feed verteilt werden. Die Marketing Abteilung realisiert das Web Anwendungen welche
  1195. diesen Feed verwenden, aktuell nicht herausfinden können welches Buch exakt
  1196. betrachtet wird. Um jedem das Leben leichter zu machen entscheiden Sie dass die
  1197. Streber Abteilung <acronym>RSS</acronym> 2.0 erweitern muß um ein neues Element
  1198. pro Eintrag hinzuzufügen das die <acronym>ISBN</acronym>-10 oder
  1199. <acronym>ISBN</acronym>-13 Zahl der Veröffentlichung die der Eintrag betrifft
  1200. unterstützt. Sie definieren das neue <command>&lt;isbn&gt;</command> Element recht
  1201. einfach mit dem standardmäßigen Namen und Namespace <acronym>URI</acronym>:
  1202. </para>
  1203. <programlisting language="php"><![CDATA[
  1204. JungleBooks 1.0:
  1205. http://example.com/junglebooks/rss/module/1.0/
  1206. ]]></programlisting>
  1207. <para>
  1208. Ein Teil des <acronym>RSS</acronym> das diese Erweiterung in der Praxis enthält
  1209. könnte in etwa so aussehen:
  1210. </para>
  1211. <programlisting language="php"><![CDATA[
  1212. <?xml version="1.0" encoding="utf-8" ?>
  1213. <rss version="2.0"
  1214. xmlns:content="http://purl.org/rss/1.0/modules/content/"
  1215. xmlns:jungle="http://example.com/junglebooks/rss/module/1.0/">
  1216. <channel>
  1217. <title>Jungle Books Customer Reviews</title>
  1218. <link>http://example.com/junglebooks</link>
  1219. <description>Many book reviews!</description>
  1220. <pubDate>Fri, 26 Jun 2009 19:15:10 GMT</pubDate>
  1221. <jungle:dayPopular>
  1222. http://example.com/junglebooks/book/938
  1223. </jungle:dayPopular>
  1224. <item>
  1225. <title>Review Of Flatland: A Romance of Many Dimensions</title>
  1226. <link>http://example.com/junglebooks/review/987</link>
  1227. <author>Confused Physics Student</author>
  1228. <content:encoded>
  1229. A romantic square?!
  1230. </content:encoded>
  1231. <pubDate>Thu, 25 Jun 2009 20:03:28 -0700</pubDate>
  1232. <jungle:isbn>048627263X</jungle:isbn>
  1233. </item>
  1234. </channel>
  1235. </rss>
  1236. ]]></programlisting>
  1237. <para>
  1238. Die Implementierung dieses neuen <acronym>ISBN</acronym> Elements als eine einfache
  1239. Eintrags Level Erweiterung wird die folgende Klasse benötigen (und die Verwendung
  1240. des eigenen Klassen Namespaces ausserhalb von Zend).
  1241. </para>
  1242. <programlisting language="php"><![CDATA[
  1243. class My_FeedReader_Extension_JungleBooks_Entry
  1244. extends Zend_Feed_Reader_Extension_EntryAbstract
  1245. {
  1246. public function getIsbn()
  1247. {
  1248. if (isset($this->_data['isbn'])) {
  1249. return $this->_data['isbn'];
  1250. }
  1251. $isbn = $this->_xpath->evaluate(
  1252. 'string(' . $this->getXpathPrefix() . '/jungle:isbn)'
  1253. );
  1254. if (!$isbn) {
  1255. $isbn = null;
  1256. }
  1257. $this->_data['isbn'] = $isbn;
  1258. return $this->_data['isbn'];
  1259. }
  1260. protected function _registerNamespaces()
  1261. {
  1262. $this->_xpath->registerNamespace(
  1263. 'jungle', 'http://example.com/junglebooks/rss/module/1.0/'
  1264. );
  1265. }
  1266. }
  1267. ]]></programlisting>
  1268. <para>
  1269. Diese Erweiterung ist einfach genug um Ihr zu folgen. Sie erstellt eine neue Methode
  1270. <methodname>getIsbn()</methodname>, welche eine XPath Abfrage auf dem aktuellen
  1271. Eintrag durchführt, um die <acronym>ISBN</acronym> Nummer welche vom
  1272. <command>&lt;jungle:isbn&gt;</command> Element umhüllt ist, zu extrahieren. Das kann
  1273. optional auch im internen nicht-persistenten Cache gespeichert werden (keine
  1274. Notwendigkeit den <acronym>DOM</acronym> abzufragen wenn es auf dem gleichen
  1275. Eintrag nochmals aufgerufen wird). Der Wert wird dem Anrufer zurückgegeben.
  1276. Am Ende haben wir eine geschützte Methode (Sie ist abstrakt, muss also existieren)
  1277. welche den Jungle Books Namespace für Ihre eigenen <acronym>RSS</acronym> Module
  1278. registriert. Wärend wir das ein <acronym>RSS</acronym> Modul nennen, gibt es nichts
  1279. das verhindert dass das gleiche Element in Atom Feeds verwendet wird - und alle
  1280. Erweiterungen welche den Prefix verwenden der von
  1281. <methodname>getXpathPrefix()</methodname> angeboten wird, sind aktuell neutral und
  1282. arbeiten auf <acronym>RSS</acronym> oder Atom Feeds ohne zusätzlichen Code.
  1283. </para>
  1284. <para>
  1285. Da die Erweiterung ausserhalb vom Zend Framework gespeichert ist, muss man den Pfad
  1286. Prefix für die eigenen Erweiterungen registrieren damit
  1287. <classname>Zend_Loader_PluginLoader</classname> diese finden kann. Danach ist es
  1288. einfach ein Problem der Registrierung der Erweiterung, wenn diese nicht bereits
  1289. geladen wurde, und deren Verwendung in der Praxis.
  1290. </para>
  1291. <programlisting language="php"><![CDATA[
  1292. if(!Zend_Feed_Reader::isRegistered('JungleBooks')) {
  1293. Zend_Feed_Reader::addPrefixPath(
  1294. '/path/to/My/FeedReader/Extension', 'My_FeedReader_Extension'
  1295. );
  1296. Zend_Feed_Reader::registerExtension('JungleBooks');
  1297. }
  1298. $feed = Zend_Feed_Reader::import('http://example.com/junglebooks/rss');
  1299. // ISBN für irgendein Buch dem der erste Eintrag im Feed gewidmet war
  1300. $firstIsbn = $feed->current()->getIsbn();
  1301. ]]></programlisting>
  1302. <para>
  1303. Das Schreiben einer Feed Level Erweiterung unterscheidet sich nicht sehr. Der
  1304. Beispiel Feed von vorher enthält ein nicht erwähntes
  1305. <command>&lt;jungle:dayPopular&gt;</command> Element das Jungle Books bei Ihrem
  1306. Standard hinzugefügt haben um einen Link zum beliebtesten Buch des Tages
  1307. hinzuzufügen (im Sinne von Verkehr der Besucher). Hier ist eine Erweiterung welche
  1308. eine <methodname>getDaysPopularBookLink()</methodname> Methode bei der Feed Level
  1309. <acronym>API</acronym> hinzufügt.
  1310. </para>
  1311. <programlisting language="php"><![CDATA[
  1312. class My_FeedReader_Extension_JungleBooks_Feed
  1313. extends Zend_Feed_Reader_Extension_FeedAbstract
  1314. {
  1315. public function getDaysPopularBookLink()
  1316. {
  1317. if (isset($this->_data['dayPopular'])) {
  1318. return $this->_data['dayPopular'];
  1319. }
  1320. $dayPopular = $this->_xpath->evaluate(
  1321. 'string(' . $this->getXpathPrefix() . '/jungle:dayPopular)'
  1322. );
  1323. if (!$dayPopular) {
  1324. $dayPopular = null;
  1325. }
  1326. $this->_data['dayPopular'] = $dayPopular;
  1327. return $this->_data['dayPopular'];
  1328. }
  1329. protected function _registerNamespaces()
  1330. {
  1331. $this->_xpath->registerNamespace(
  1332. 'jungle', 'http://example.com/junglebooks/rss/module/1.0/'
  1333. );
  1334. }
  1335. }
  1336. ]]></programlisting>
  1337. <para>
  1338. Wiederholen wir das letzte Beispiel der Verwendung einer eigenen Erweiterung um zu
  1339. zeigen wie die Methode verwendet wird.
  1340. </para>
  1341. <programlisting language="php"><![CDATA[
  1342. if(!Zend_Feed_Reader::isRegistered('JungleBooks')) {
  1343. Zend_Feed_Reader::addPrefixPath(
  1344. '/path/to/My/FeedReader/Extension', 'My_FeedReader_Extension'
  1345. );
  1346. Zend_Feed_Reader::registerExtension('JungleBooks');
  1347. }
  1348. $feed = Zend_Feed_Reader::import('http://example.com/junglebooks/rss');
  1349. // URI zur Informations Seite des populärsten Buchs des Tages mit Besuchern
  1350. $daysPopularBookLink = $feed->getDaysPopularBookLink();
  1351. // ISBN für irgendein Buch dem der erste Eintrag im Feed gewidmet war
  1352. $firstIsbn = $feed->current()->getIsbn();
  1353. ]]></programlisting>
  1354. <para>
  1355. Beim Betrachten dieser Beispiele, konnte man sehen das wir Feed und Eintrags
  1356. Erweiterungen nicht separat registriert haben. Erweiterungen im selben Standard
  1357. können sowohl eine Feed und Entry Klasse enthalten oder auch nicht, sodas
  1358. <classname>Zend_Feed_Reader</classname> nur die Registrierung des darüberliegenden
  1359. Eltern Namens benötigt, z.B. JungleBooks, DublinCore, Slash. Intern kann sie
  1360. prüfen für welchen Level Erweiterungen existieren und und diese Laden wenn Sie
  1361. gefunden werden. In unserem Fall haben wir jetzt ein komplettes Set von
  1362. Erweiterungen: <classname>JungleBooks_Feed</classname> und
  1363. <classname>JungleBooks_Entry</classname>.
  1364. </para>
  1365. </sect3>
  1366. </sect2>
  1367. </sect1>