Zend_Service_Audioscrobbler.xml 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 14978 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.service.audioscrobbler">
  5. <title>Zend_Service_Audioscrobbler</title>
  6. <sect2 id="zend.service.audioscrobbler.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. <classname>Zend_Service_Audioscrobbler</classname> ist eine einfache API für die Verwendung des Audioscrobbler REST
  10. Web Services. Der Audioscrobbler Web Service bietet Zugang zu seinen Datenbanken von Benutzern, Artisten,
  11. Albums, Lieder, tags, Gruppen und Foren. Die Methoden der <classname>Zend_Service_Audioscrobbler</classname> Klasse
  12. beginnt mit einem dieser Bezeichner. Der Syntax und der Namensraum des Audioscrobbler Web Services sind in
  13. <classname>Zend_Service_Audioscrobbler</classname> gespiegelt. Für weitere Informationen über das Audioscrobbler
  14. REST Web Service, siehe die
  15. <ulink url="http://www.audioscrobbler.net/data/webservices/">Audioscrobbler Web Service Seite</ulink>.
  16. </para>
  17. </sect2>
  18. <sect2 id="zend.service.audioscrobbler.users">
  19. <title>Benutzer</title>
  20. <para>
  21. Um Informationen über einen bestimmten Benutzer zu erhalten, wird zuerst die <code>setUser()</code>
  22. Methode verwendet um den Benutzer zu selektieren für den Daten empfangen werden sollen.
  23. <classname>Zend_Service_Audioscrobbler</classname> bietet verschiedene Methoden für das empfangen von Daten eines
  24. einzelnen Benutzers:
  25. <itemizedlist>
  26. <listitem>
  27. <para>
  28. <code>userGetProfileInformation()</code>: Gibt ein SimpleXML Objekt zurück das die
  29. aktuellen Profilinformationen des Benutzers enthält.
  30. </para>
  31. </listitem>
  32. <listitem>
  33. <para>
  34. <code>userGetTopArtists()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der
  35. aktuell am meisten gelisteten Artisten des Benutzers enthält.
  36. </para>
  37. </listitem>
  38. <listitem>
  39. <para>
  40. <code>userGetTopAlbums()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der
  41. aktuell am meisten gelisteten Alben des Benutzer enthält.
  42. </para>
  43. </listitem>
  44. <listitem>
  45. <para>
  46. <code>userGetTopTracks()</code>: Gibt ein SimpleXML Objekt zurück das das aktuell am
  47. meisten gelistete Lied des Benutzers enthält.
  48. </para>
  49. </listitem>
  50. <listitem>
  51. <para>
  52. <code>userGetTopTags()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der
  53. Tags enthält die am meisten vom aktuellen Benutzer zugeordnet wurden.
  54. </para>
  55. </listitem>
  56. <listitem>
  57. <para>
  58. <code>userGetTopTagsForArtist()</code>: Erfordert das ein Artist über
  59. <code>setArtist()</code> gesetzt wurde. Gibt ein SimpleXML Objekt zurück das die Tags
  60. enthält die am meisten dem aktuellen Artisten durch den aktuellen Benutzer zugeordnet
  61. worden sind.
  62. </para>
  63. </listitem>
  64. <listitem>
  65. <para>
  66. <code>userGetTopTagsForAlbum()</code>: Erfordert das ein Album über
  67. <code>setAlbum()</code> gesetzt wurde. Gibt ein SimpleXML Objekt zurück das die Tags
  68. enthält die am meisten dem aktuellen Album durch den aktuellen Benutzer zugeordnet
  69. worden sind.
  70. </para>
  71. </listitem>
  72. <listitem>
  73. <para>
  74. <code>userGetTopTagsForTrack()</code>: Erfordert das ein Lied über <code>setTrack()</code>
  75. gesetzt wurde. Gibt ein SimpleXML Objekt zurück das die Tags enthält die am meisten dem
  76. aktuellen Lied vom aktuellen Benutzer zugeordnet worden sind.
  77. </para>
  78. </listitem>
  79. <listitem>
  80. <para>
  81. <code>userGetFriends()</code>: Gibt ein SimpleXML Objekt zurück das die Benutzernamen der
  82. Freunde des aktuellen Benutzers enthält.
  83. </para>
  84. </listitem>
  85. <listitem>
  86. <para>
  87. <code>userGetNeighbours()</code>: Gibt ein SimpleXML Objekt zurück das die Benutzernamen
  88. der Personen enthält die ähnliche Unterhaltungs-Gewohnheiten wie der aktuelle Benutzer
  89. haben.
  90. </para>
  91. </listitem>
  92. <listitem>
  93. <para>
  94. <code>userGetRecentTracks()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der
  95. 10 zuletzt gespielten Lieder des aktuellen Benutzers enthält.
  96. </para>
  97. </listitem>
  98. <listitem>
  99. <para>
  100. <code>userGetRecentBannedTracks()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste
  101. der 10 zuletzt verbannten Lieder des aktuellen Benutzers enthält.
  102. </para>
  103. </listitem>
  104. <listitem>
  105. <para>
  106. <code>userGetRecentLovedTracks()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste
  107. der 10 zuletzt geliebten Lieder des aktuellen Benutzers enthält.
  108. </para>
  109. </listitem>
  110. <listitem>
  111. <para>
  112. <code>userGetRecentJournals()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste
  113. der letzten Journaleintröge des aktuellen Benutzers enthält.
  114. </para>
  115. </listitem>
  116. <listitem>
  117. <para>
  118. <code>userGetWeeklyChartList()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste
  119. der Wochen enthält für die ein Wochenchart des aktuellen Benutzers existiert.
  120. </para>
  121. </listitem>
  122. <listitem>
  123. <para>
  124. <code>userGetRecentWeeklyArtistChart()</code>: Gibt ein SimpleXML Objekt zurück das die
  125. letzten wöchentlichen Artistencharts des aktuellen Benutzers enthält.
  126. </para>
  127. </listitem>
  128. <listitem>
  129. <para>
  130. <code>userGetRecentWeeklyAlbumChart()</code>: Gibt ein SimpleXML Objekt zurück das die
  131. letzten wöchentlichen Albumcharts des aktuellen Benutzers enthält.
  132. </para>
  133. </listitem>
  134. <listitem>
  135. <para>
  136. <code>userGetRecentWeeklyTrackChart()</code>: Gibt ein SimpleXML Objekt zurück das die
  137. letzten wöchentlichen Liedercharts des aktuellen Benutzers enthält.
  138. </para>
  139. </listitem>
  140. <listitem>
  141. <para>
  142. <code>userGetPreviousWeeklyArtistChart($fromDate, $toDate)</code>: Gibt ein SimpleXML
  143. Objekt zurück das die wöchentliche Artistencharts von <code>$fromDate</code> bis
  144. <code>$toDate</code> für den aktuellen Benutzer enthält.
  145. </para>
  146. </listitem>
  147. <listitem>
  148. <para>
  149. <code>userGetPreviousWeeklyAlbumChart($fromDate, $toDate)</code>: Gibt ein SimpleXML
  150. Objekt zurück das die wöchentlichen Albumcharts von <code>$fromDate</code> bis
  151. <code>$toDate</code> für den aktuellen Benutzer enthält.
  152. </para>
  153. </listitem>
  154. <listitem>
  155. <para>
  156. <code>userGetPreviousWeeklyTrackChart($fromDate, $toDate)</code>: Gibt ein SimpleXML
  157. Objekt zurück das die wöchentlichen Liedercharts von <code>$fromDate</code> bis
  158. <code>$toDate</code> für den aktuellen Benutzer enthält.
  159. </para>
  160. </listitem>
  161. </itemizedlist>
  162. </para>
  163. <example id="zend.service.audioscrobbler.users.example.profile_information">
  164. <title>Informationen von Benutzerprofilen erhalten</title>
  165. <para>
  166. In diesem Beispiel werden die <code>setUser()</code> und <code>userGetProfileInformation()</code>
  167. Methoden verwendet um Informationen über ein spezielles Benutzerprofil zu erhalten:
  168. </para>
  169. <programlisting role="php"><![CDATA[
  170. $as = new Zend_Service_Audioscrobbler();
  171. // Den Benutzer setzen dessen Profilinformationen man empfangen will
  172. $as->setUser('BigDaddy71');
  173. // Informationen von BigDaddy71's Profil erhalten
  174. $profileInfo = $as->userGetProfileInformation();
  175. // Einige von Ihnen darstellen
  176. print "Informationen für $profileInfo->realname können unter "
  177. . "$profileInfo->url gefunden werden";
  178. ]]>
  179. </programlisting>
  180. </example>
  181. <example id="zend.service.audioscrobbler.users.example.weekly_artist_chart">
  182. <title>Die wöchentlichen Artistencharts eines Benutzers erhalten</title>
  183. <programlisting role="php"><![CDATA[
  184. $as = new Zend_Service_Audioscrobbler();
  185. // Den Benutzer setzen dessen wöchentliche Artistencharts man empfangen will
  186. $as->setUser('lo_fye');
  187. // Eine Liste von vorherigen Wochen erhalten in denen Chartdaten vorhanden sind
  188. $weeks = $as->userGetWeeklyChartList();
  189. if (count($weeks) < 1) {
  190. echo 'Keine Daten vorhanden';
  191. }
  192. sort($weeks); // Die Liste der Wochen sortieren
  193. $as->setFromDate($weeks[0]); // Das Startdatum setzen
  194. $as->setToDate($weeks[0]); // Das Enddatum setzen
  195. $previousWeeklyArtists = $as->userGetPreviousWeeklyArtistChart();
  196. echo 'Artisten Chart für Woche '
  197. . date('Y-m-d h:i:s', $as->from_date)
  198. . '<br />';
  199. foreach ($previousWeeklyArtists as $artist) {
  200. // Artistennamen mit Links zu Ihrem Profil darstellen
  201. print '<a href="' . $artist->url . '">' . $artist->name . '</a><br />';
  202. }
  203. ]]>
  204. </programlisting>
  205. </example>
  206. </sect2>
  207. <sect2 id="zend.service.audioscrobbler.artists">
  208. <title>Artisten</title>
  209. <para>
  210. <classname>Zend_Service_Audioscrobbler</classname> bietet verschiedene Methoden um Daten über einen speziellen
  211. Artisten zu empfangen, der über die <code>setArtist()</code> Methode spezifiziert wurde:
  212. <itemizedlist>
  213. <listitem>
  214. <para>
  215. <code>artistGetRelatedArtists()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste
  216. von Artisten enthält die dem aktuellen Artisten ähnlich sind.
  217. </para>
  218. </listitem>
  219. <listitem>
  220. <para>
  221. <code>artistGetTopFans()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste von
  222. Benutzern enthält die den aktuellen Artisten am meisten hören.
  223. </para>
  224. </listitem>
  225. <listitem>
  226. <para>
  227. <code>artistGetTopTracks()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der
  228. am meisten gewählten Lieder des aktuellen Artisten enthält.
  229. </para>
  230. </listitem>
  231. <listitem>
  232. <para>
  233. <code>artistGetTopAlbums()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der
  234. aktuell am meisten gewählten Alben des aktuellen Artisten enthält.
  235. </para>
  236. </listitem>
  237. <listitem>
  238. <para>
  239. <code>artistGetTopTags()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der
  240. Tags enthält die dem aktuellen Artisten am meisten zugeordnet werden.
  241. </para>
  242. </listitem>
  243. </itemizedlist>
  244. </para>
  245. <example id="zend.service.audioscrobbler.artists.example.related_artists">
  246. <title>Ähnliche Artisten erhalten</title>
  247. <programlisting role="php"><![CDATA[
  248. $as = new Zend_Service_Audioscrobbler();
  249. // Den Artisten setzen für den man ähnliche Artisten bekommen will
  250. $as->setArtist('LCD Soundsystem');
  251. // Ähnliche Artisten erhalten
  252. $relatedArtists = $as->artistGetRelatedArtists();
  253. foreach ($relatedArtists as $artist) {
  254. // Die ähnlichen Artisten anzeigen
  255. print '<a href="' . $artist->url . '">' . $artist->name . '</a><br />';
  256. }
  257. ]]>
  258. </programlisting>
  259. </example>
  260. </sect2>
  261. <sect2 id="zend.service.audioscrobbler.tracks">
  262. <title>Lieder</title>
  263. <para>
  264. <classname>Zend_Service_Audioscrobbler</classname> bietet zwei Methoden für das empfangen von Daten für ein
  265. einzelnes Lied, das über die <code>setTrack()</code> Methode spezifiziert wurde:
  266. <itemizedlist>
  267. <listitem>
  268. <para>
  269. <code>trackGetTopFans()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste mit den
  270. Benutzern enthält die das aktuelle Lied am meisten gehört haben.
  271. </para>
  272. </listitem>
  273. <listitem>
  274. <para>
  275. <code>trackGetTopTags()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der Tags
  276. enthält die dem aktuellen Tag am meisten hinzugefügt werden.
  277. </para>
  278. </listitem>
  279. </itemizedlist>
  280. </para>
  281. </sect2>
  282. <sect2 id="zend.service.audioscrobbler.tags">
  283. <title>Tags</title>
  284. <para>
  285. <classname>Zend_Service_Audioscrobbler</classname> bietet verschiedene Methoden für das empfangen von Daten die
  286. einem einzelnen Tag zugeordnet sind, welches über die <code>setTag()</code> Methode zugeordnet werden:
  287. <itemizedlist>
  288. <listitem>
  289. <para>
  290. <code>tagGetOverallTopTags()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste von
  291. Tags enthält die am meisten in Audioscrobbler verwendet werden.
  292. </para>
  293. </listitem>
  294. <listitem>
  295. <para>
  296. <code>tagGetTopArtists()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste von
  297. Artisten enthält denen das aktuelle Tag am meisten zugeordnet wurden.
  298. </para>
  299. </listitem>
  300. <listitem>
  301. <para>
  302. <code>tagGetTopAlbums()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste von Alben
  303. enthält die dem aktuellen Tag am meisten zugeordnet wurden.
  304. </para>
  305. </listitem>
  306. <listitem>
  307. <para>
  308. <code>tagGetTopTracks()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste von
  309. Liedern enthält die dem aktuellen Tag am meisten zugeordnet wurden.
  310. </para>
  311. </listitem>
  312. </itemizedlist>
  313. </para>
  314. </sect2>
  315. <sect2 id="zend.service.audioscrobbler.groups">
  316. <title>Gruppen</title>
  317. <para>
  318. <classname>Zend_Service_Audioscrobbler</classname> bietet verschiedene Methoden um Daten zu erhalten die einer
  319. speziellen Gruppe gehören, die über die <code>setGroup()</code> Methode zugeordnet wurde:
  320. <itemizedlist>
  321. <listitem>
  322. <para>
  323. <code>groupGetRecentJournals()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste
  324. der letzten Journalbeiträge der Benutzer der aktuellen Gruppe enthält.
  325. </para>
  326. </listitem>
  327. <listitem>
  328. <para>
  329. <code>groupGetWeeklyChart()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der
  330. Wochen enthält für die ein wöchentliches Chart der aktuellen Gruppe existiert.
  331. </para>
  332. </listitem>
  333. <listitem>
  334. <para>
  335. <code>groupGetRecentWeeklyArtistChart()</code>: Gibt ein SimpleXML Objekt zurück das
  336. die letzten wöchentlichen Artistencharts der aktuellen Gruppe enthält.
  337. </para>
  338. </listitem>
  339. <listitem>
  340. <para>
  341. <code>groupGetRecentWeeklyAlbumChart()</code>: Gibt ein SimpleXML Objekt zurück das die
  342. letzten wöchentlichen Albumcharts der aktuellen Gruppe enthält.
  343. </para>
  344. </listitem>
  345. <listitem>
  346. <para>
  347. <code>groupGetRecentWeeklyTrackChart()</code>: Gibt ein SimpleXML Objekt zurück das die
  348. letzten wöchentlichen Liedercharts der aktuellen Gruppe enthält.
  349. </para>
  350. </listitem>
  351. <listitem>
  352. <para>
  353. <code>groupGetPreviousWeeklyArtistChart($fromDate, $toDate)</code>: Erfordert
  354. <code>setFromDate()</code> und <code>setToDate()</code>. Gibt ein SimpleXML Objekt zurück
  355. das die wöchentlichen Artistencharts vom aktuellen fromDate bis zum aktuellen toDate
  356. der aktuellen Gruppe enthält.
  357. </para>
  358. </listitem>
  359. <listitem>
  360. <para>
  361. <code>groupGetPreviousWeeklyAlbumChart($fromDate, $toDate)</code>: Erfordert
  362. <code>setFromDate()</code> und <code>setToDate()</code>. Gibt ein SimpleXML Objekt
  363. zurück das die wöchentlichen Albumcharts vom aktuellen fromDate bis zum aktuellen toDate
  364. der aktuellen Gruppe enthält.
  365. </para>
  366. </listitem>
  367. <listitem>
  368. <para>
  369. <code>groupGetPreviousWeeklyTrackChart($fromDate, $toDate)</code>: Gibt ein SimpleXML
  370. Objekt zurück das die wöchentlichen Liedercharts vom aktuellen fromDate bis zum
  371. aktuellen toDate für die aktuelle Gruppe enthält.
  372. </para>
  373. </listitem>
  374. </itemizedlist>
  375. </para>
  376. </sect2>
  377. <sect2 id="zend.service.audioscrobbler.forums">
  378. <title>Foren</title>
  379. <para>
  380. <classname>Zend_Service_Audioscrobbler</classname> bietet eine Methode für das Empfangen von Daten eines
  381. einzelnen Forums, das über die <code>setForum()</code> Methode spezifiziert wurde:
  382. <itemizedlist>
  383. <listitem>
  384. <para>
  385. <code>forumGetRecentPosts()</code>: Gibt ein SimpleXML Objekt zurück das eine Liste der
  386. letzten Beiträge im aktuellen Forum enthält.
  387. </para>
  388. </listitem>
  389. </itemizedlist>
  390. </para>
  391. </sect2>
  392. </sect1>
  393. <!--
  394. vim:se ts=4 sw=4 et:
  395. -->