Zend_Service_Audioscrobbler.xml 20 KB

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