Zend_Service_Audioscrobbler.xml 21 KB

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