Docs For Class Zend_Service_Audioscrobbler

## Class Zend_Service_Audioscrobbler

Description

- author: Chris Hartjes chartjes@littlehart.net (ZCE # 901167)
- author: Derek Martin derek@geekunity.com (ZCE # 901168)
- license: New BSD License
- copyright: Copyright (c) 2005-2006 Zend Technologies Inc. (http://www.zend.com)

Located in /Zend/Service/Audioscrobbler.php (line 40)

Variable Summary
array $params
Zend_Service_Rest $_rest
Method Summary
Zend_Service_Audioscrobbler __construct ()
SimpleXML artistGetRelatedArtists ()
SimpleXML artistGetTopAlbums ()
SimpleXML artistGetTopFans ()
SimpleXML artistGetTopTags ()
SimpleXML artistGetTopTracks ()
SimpleXML forumGetRecentPosts ()
void get ( $field, string $key)
SimpleXML groupGetPreviousWeeklyAlbumChart ()
SimpleXML groupGetPreviousWeeklyArtistChart ()
SimpleXML groupGetPreviousWeeklyTrackChart ()
SimpleXML groupGetRecentJournals ()
SimpleXML groupGetRecentWeeklyAlbumChart ()
SimpleXML groupGetRecentWeeklyArtistChart ()
SimpleXML groupGetRecentWeeklyTrackChart ()
SimpleXML groupGetWeeklyChart ()
void set (string $field, $value, string $val)
SimpleXML tagGetOverallTopTags ()
SimpleXML tagGetTopAlbums ()
SimpleXML tagGetTopArtists ()
SimpleXML tagGetTopTracks ()
SimpleXML trackGetTopFans ()
SimpleXML trackGetTopTags ()
SimpleXML userGetFriends ()
SimpleXML userGetNeighbours ()
array userGetProfileInformation ()
SimpleXML userGetRecentBannedTracks ()
SimpleXML userGetRecentLovedTracks ()
SimpleXML userGetRecentTracks ()
SimpleXML userGetTopAlbums ()
array userGetTopArtists ()
SimpleXML userGetTopTags ()
SimpleXML userGetTopTagsForAlbum ()
SimpleXML userGetTopTagsForArtist ()
SimpleXML userGetTopTagsForTrack ()
SimpleXML userGetTopTracks ()
SimpleXML userGetWeeklyAlbumChart ([integer $from = NULL], [integer $to = NULL])
SimpleXML userGetWeeklyArtistChart ([integer $from = NULL], [integer $to = NULL])
SimpleXML userGetWeeklyChartList ()
SimpleXML userGetWeeklyTrackChart ([integer $from = NULL], [integer $to = NULL])
Variables
array $params (line 53)

Array that contains parameters being used by the webservice

- access: protected

Zend_Service_Rest $_rest (line 47)

Zend_Service_Rest Object

- access: protected

Methods
Constructor __construct (line 64)

Zend_Service_Audioscrobbler Constructor, setup character encoding

- access: public

Zend_Service_Audioscrobbler __construct ()
artistGetRelatedArtists (line 375)

Utility function that returns a list of artists similiar to this artist

- return: object containing result set
- access: public

SimpleXML artistGetRelatedArtists ()
artistGetTopAlbums (line 408)

Utility function that returns a list of this artist's top-rated albums

- return: object containing result set
- access: public

SimpleXML artistGetTopAlbums ()
artistGetTopFans (line 386)

Utility function that returns a list of this artist's top listeners

- return: object containing result set
- access: public

SimpleXML artistGetTopFans ()
artistGetTopTags (line 419)

Utility function that returns a list of this artist's top-rated tags

- return: object containing result set
- access: public

SimpleXML artistGetTopTags ()
artistGetTopTracks (line 397)

Utility function that returns a list of this artist's top-rated tracks

- return: object containing result set
- access: public

SimpleXML artistGetTopTracks ()
forumGetRecentPosts (line 600)

Utility function that gets an RSS feed of recent forum posts in a specific forum

- return: object containing result set
- access: public

SimpleXML forumGetRecentPosts ()
get (line 85)

Generic get action for a particular field

- access: public

void get ( $field, string $key)

- string $key: object to be retrieved
- $field

groupGetPreviousWeeklyAlbumChart (line 573)

Utility function that gets this group's weekly album chart by date

Use groupGetWeeklyChartList() to get a list of valid dates

- return: object containing result set
- access: public

SimpleXML groupGetPreviousWeeklyAlbumChart ()
groupGetPreviousWeeklyArtistChart (line 561)

Utility function that gets this group's weekly artist chart by date

Use groupGetWeeklyChartList() to get a list of valid dates

- return: object containing result set
- access: public

SimpleXML groupGetPreviousWeeklyArtistChart ()
groupGetPreviousWeeklyTrackChart (line 585)

Utility function that gets this group's weekly track chart by date

Use groupGetWeeklyChartList() to get a list of valid dates

- return: object containing result set
- access: public

SimpleXML groupGetPreviousWeeklyTrackChart ()
groupGetRecentJournals (line 510)

Utility function that returns a a list of recent journal posts by members of this group

- return: object containing result set
- access: public

SimpleXML groupGetRecentJournals ()
groupGetRecentWeeklyAlbumChart (line 540)

Utility function that gets the most recent album chart for this group

- return: object containing result set
- access: public

SimpleXML groupGetRecentWeeklyAlbumChart ()
groupGetRecentWeeklyArtistChart (line 530)

Utility function that gets the most recent weekly artist chart for this group

- return: object containing result set
- access: public

SimpleXML groupGetRecentWeeklyArtistChart ()
groupGetRecentWeeklyTrackChart (line 550)

Utility function that gets the most recent track chart for this group

- return: object containing result set
- access: public

SimpleXML groupGetRecentWeeklyTrackChart ()
groupGetWeeklyChart (line 520)

Utility function that gets list of dates of available weekly charts for this group

- return: object containing result set
- access: public

SimpleXML groupGetWeeklyChart ()
set (line 101)

Generic set action for a field in the parameters being used

- access: public

void set (string $field, $value, string $val)

- string $field: field to set
- string $val: value to set in the field
- $value

tagGetOverallTopTags (line 462)

Utility function that returns a list of the site's overall most used tags

- return: object containing result set
- access: public

SimpleXML tagGetOverallTopTags ()
tagGetTopAlbums (line 482)

Utility function that returns a list of albums to which this tag was most applied

- return: object containing result set
- access: public

SimpleXML tagGetTopAlbums ()
tagGetTopArtists (line 472)

Utility function that returns a list of artists this tag was most applied to

- return: object containing result set
- access: public

SimpleXML tagGetTopArtists ()
tagGetTopTracks (line 491)

Utility function that returns a list of tracks to which this tag was most applied

- return: object containing result set
- access: public

SimpleXML tagGetTopTracks ()
trackGetTopFans (line 434)

Utility function that returns a list of this track's top listeners

- return: object containing result set
- access: public

SimpleXML trackGetTopFans ()
trackGetTopTags (line 444)

Utility function that returns a list of tags most applied to this track

- return: object containing result set
- access: public

SimpleXML trackGetTopTags ()
userGetFriends (line 233)

Utility function that retrieves this user's list of friends

- return: object containing result set
- access: public

SimpleXML userGetFriends ()
userGetNeighbours (line 244)

Utility function that returns a list of people with similar listening preferences to this user

- return: object containing result set
- access: public

SimpleXML userGetNeighbours ()
userGetProfileInformation (line 147)

Utility function to get Audioscrobbler profile information (eg: Name, Gender)

- return: containing information
- access: public

array userGetProfileInformation ()
userGetRecentBannedTracks (line 266)

Utility function that returns a list of the 10 tracks most recently banned by this user

- return: object containing result set
- access: public

SimpleXML userGetRecentBannedTracks ()
userGetRecentLovedTracks (line 277)

Utility function that returns a list of the 10 tracks most recently loved by this user

- return: object containing result set
- access: public

SimpleXML userGetRecentLovedTracks ()
userGetRecentTracks (line 255)

Utility function that returns a list of the 10 most recent tracks played by this user

- return: object containing result set
- access: public

SimpleXML userGetRecentTracks ()
userGetTopAlbums (line 167)

Utility function to get this user's 50 most played albums

- return: object containing result set
- access: public

SimpleXML userGetTopAlbums ()
userGetTopArtists (line 157)

Utility function get this user's 50 most played artists

- return: containing info
- access: public

array userGetTopArtists ()
userGetTopTags (line 187)

Utility function to get this user's 50 most used tags

- return: object containing result set
- access: public

SimpleXML userGetTopTags ()
userGetTopTagsForAlbum (line 210)

Utility function that returns this user's top tags for an album

- return: object containing result set
- access: public

SimpleXML userGetTopTagsForAlbum ()
userGetTopTagsForArtist (line 198)

Utility function that returns the user's top tags used most used on a specific artist

- return: object containing result set
- access: public

SimpleXML userGetTopTagsForArtist ()
userGetTopTagsForTrack (line 222)

Utility function that returns this user's top tags for a track

- return: object containing result set
- access: public

SimpleXML userGetTopTagsForTrack ()
userGetTopTracks (line 177)

Utility function to get this user's 50 most played tracks

- return: object containing resut set
- access: public

SimpleXML userGetTopTracks ()
userGetWeeklyAlbumChart (line 303)

Utility function that returns weekly album chart data for this user

- return: object containing result set
- access: public

SimpleXML userGetWeeklyAlbumChart ([integer $from = NULL], [integer $to = NULL])

- integer $from: optional UNIX timestamp for start of date range
- integer $to: optional UNIX timestamp for end of date range

userGetWeeklyArtistChart (line 324)

Utility function that returns weekly artist chart data for this user

- return: object containing result set
- access: public

SimpleXML userGetWeeklyArtistChart ([integer $from = NULL], [integer $to = NULL])

- integer $from: optional UNIX timestamp for start of date range
- integer $to: optional UNIX timestamp for end of date range

userGetWeeklyChartList (line 289)

Utility function that returns a list of dates of available weekly charts for a this user

Should actually be named userGetWeeklyChartDateList() but we have to follow audioscrobbler's naming

- return: object containing result set
- access: public

SimpleXML userGetWeeklyChartList ()
userGetWeeklyTrackChart (line 345)

Utility function that returns weekly track chart data for this user

- return: object containing result set
- access: public

SimpleXML userGetWeeklyTrackChart ([integer $from = NULL], [integer $to = NULL])

- integer $from: optional UNIX timestamp for start of date range
- integer $to: optional UNIX timestamp for end of date range

Documentation generated on Sun, 29 Oct 2006 21:27:51 -0600 by phpDocumentor 1.3.0RC6