Zend_Service_Twitter_Search.xml 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 17227 -->
  3. <!-- Reviewed: no -->
  4. <sect2 id="zend.service.twitter.search">
  5. <title>Zend_Service_Twitter_Search</title>
  6. <sect3 id="zend.service.twitter.search.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. <classname>Zend_Service_Twitter_Search</classname> bietet einen Client für die <ulink
  10. url="http://apiwiki.twitter.com/Search+API+Documentation">Such
  11. <acronym>API</acronym> von Twitter</ulink>. Das Twitter Suchservice wird verwendet
  12. um in Twitter zu suchen. Aktuell gibt es Daten nur im Atom oder <acronym>JSON</acronym>
  13. Format zurück, aber ein komplettes REST Service kommt in Zukunft welche auch
  14. <acronym>XML</acronym> Antworten unterstützen wird.
  15. </para>
  16. </sect3>
  17. <sect3 id="zend.service.twitter.search.trends">
  18. <title>Twitter Trends</title>
  19. <para>
  20. Gibt die Top Zehn Abfragen zurück die aktuell bei Twitter Trend sind. Die Antwort
  21. enthält die Zeit der Abfragen, den Namen jedes einzelnen Trendtopics, und auch die Url
  22. zur Twitter Suchseite für dieses Topic. Aktuell unterstützt die Such
  23. <acronym>API</acronym> für Trends nur eine Rückgabe von <acronym>JSON</acronym>
  24. weswegen die Funktion ein Array zurückgibt.
  25. </para>
  26. <programlisting language="php"><![CDATA[
  27. $twitter_search = new Zend_Service_Twitter_Search();
  28. $twitter_trends = $twitter_search->trends();
  29. foreach($twitter_trends as $trend) {
  30. print $trend['name'] . ' - ' . $trend['url'] . PHP_EOL
  31. }
  32. ]]></programlisting>
  33. <para>
  34. Das zurückgegebene Array enthält zwei Werte:
  35. </para>
  36. <itemizedlist>
  37. <listitem>
  38. <para>
  39. <code>name</code>, ist der Name des Trends.
  40. </para>
  41. </listitem>
  42. <listitem>
  43. <para>
  44. <code>url</code>, ist die Url um die Tweets für diesen Trend zu sehen.
  45. </para>
  46. </listitem>
  47. </itemizedlist>
  48. </sect3>
  49. <sect3 id="zend.service.twitter.search.search">
  50. <title>Suchen in Twitter</title>
  51. <para>
  52. Die Verwendung der Suchmethode gibt Tweets zurück die einer speziellen Abfrage
  53. entsprechen. Es gibt eine Anzahl von <ulink
  54. url="http://search.twitter.com/operators">Suchoperatoren</ulink> die für die Abfrage
  55. verwendet werden können.
  56. </para>
  57. <para>
  58. Die Suchmethode akzeptiert sechs verschiedene optionale <acronym>URL</acronym> Parameter
  59. die als Array übergeben werden:
  60. </para>
  61. <itemizedlist>
  62. <listitem>
  63. <para>
  64. <code>lang</code>, begrenzt die Tweets auf eine angegebene Sprache, wobei lang
  65. durch einen <ulink url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1
  66. Code</ulink> angegeben werden muß
  67. </para>
  68. </listitem>
  69. <listitem>
  70. <para>
  71. <code>rpp</code>, die Anzahl der Tweets die pro Seite zurückzugeben sind, bis zu
  72. einem Maximum von 100
  73. </para>
  74. </listitem>
  75. <listitem>
  76. <para>
  77. <code>page</code>, die Seitennummer die zurückzugeben ist, bis zu einem Maximum
  78. von etwa 1500 Ergebnissen (basierend auf RPP * Seite)
  79. </para>
  80. </listitem>
  81. <listitem>
  82. <para>
  83. <code>since_id</code>, gibt Tweets mit den Status IDs zurück die größer als die
  84. angegebene ID sind
  85. </para>
  86. </listitem>
  87. <listitem>
  88. <para>
  89. <code>show_user</code>, ist es "true", fügt es "&gt;user&lt;:" am Anfang des
  90. Tweets hinzu. Das ist nützlich für Leser die das Authorfeld in Atom nicht
  91. anzeigen. Der Standardwert ist "false"
  92. </para>
  93. </listitem>
  94. <listitem>
  95. <para>
  96. <code>geocode</code>, gibt Tweets zurück bei denen Benutzer in einerm
  97. angegebenen Radius zum angegebenen Längen- und Breitengrad sind, wobei der Ort
  98. des Benutzers von seinem Twitter Profil genommen wird. Der Wert des Parameters
  99. wird durch "latitude,longitude,radius" spezifiziert, wobei die Einheiten des
  100. Radius entweder in "mi" (Meilen) oder "km" (Kilometer) spezifiziert werden
  101. müssen.
  102. </para>
  103. </listitem>
  104. </itemizedlist>
  105. <example id="zend.service.twitter.search.search.json">
  106. <title>Suchbeispiel für JSON</title>
  107. <para>
  108. Das folgende Codebeispiel gibt ein Array mit den Werten der Suchergebnisse zurück
  109. </para>
  110. <programlisting language="php"><![CDATA[
  111. $twitter_search = new Zend_Service_Twitter_Search('json');
  112. $search_results = $twitter_search->search('zend', array('lang' => 'en'));
  113. ]]></programlisting>
  114. </example>
  115. <example id="zend.service.twitter.search.search.atom">
  116. <title>Suchbeispiel für ATOM</title>
  117. <para>
  118. Das folgende Codebeispiel gibt ein <classname>Zend_Feed_Atom</classname> Objekt
  119. zurück.
  120. </para>
  121. <programlisting language="php"><![CDATA[
  122. $twitter_search = new Zend_Service_Twitter_Search('atom');
  123. $search_results = $twitter_search->search('zend', array('lang' => 'en'));
  124. ]]></programlisting>
  125. </example>
  126. </sect3>
  127. <sect3 id="zend.service.twitter.search.accessors">
  128. <title>Zend-Spezifische Zugriffsmethoden</title>
  129. <para>
  130. Wärend die Such <acronym>API</acronym> von Twitter nur zwei Methoden spezifiziert, hat
  131. <classname>Zend_Service_Twitter_Search</classname> zusätzliche Zugriffsmethoden die für
  132. die Modifizierung von internen Eigenschaften verwendet werden können.
  133. </para>
  134. <itemizedlist>
  135. <listitem>
  136. <para>
  137. <methodname>getResponseType()</methodname> und
  138. <methodname>setResponseType()</methodname> erlauben es den Antworttype der Suche
  139. zu empfangen und, zwischen <acronym>JSON</acronym> und ATOM, zu verändern.
  140. </para>
  141. </listitem>
  142. </itemizedlist>
  143. </sect3>
  144. </sect2>
  145. <!--
  146. vim:se ts=4 sw=4 et:
  147. -->