Class Zend_Service_Audioscrobbler

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

Located in /Service/Audioscrobbler.php (line 45)


	
			
Variable Summary
Method Summary
 void __construct ([boolean $testing = false], [string $testingResponse = null])
 void albumGetInfo ()
 SimpleXML artistGetTopAlbums ()
 SimpleXML artistGetTopFans ()
 SimpleXML artistGetTopTags ()
 SimpleXML artistGetTopTracks ()
 string|false get (string $field)
 void groupGetWeeklyAlbumChartList ([ $from = NULL], [ $to = NULL])
 void groupGetWeeklyArtistChartList ([ $from = NULL], [ $to = NULL])
 void groupGetWeeklyTrackChartList ([ $from = NULL], [ $to = NULL])
 Zend_Service_Audioscrobbler set (string $field, string $value)
 void tagGetTopAlbums ()
 void tagGetTopTags ()
 void tagGetTopTracks ()
 void trackGetTopFans ()
 void trackGetTopTags ()
 SimpleXML userGetFriends ()
 SimpleXML userGetNeighbours ()
 SimpleXML userGetRecentTracks ()
 SimpleXML userGetTopAlbums ()
 SimpleXML userGetTopTags ()
 SimpleXML userGetTopTagsForAlbum ()
 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])
 void _errorHandler (integer $errno, string $errstr, string $errfile, integer $errline,  $errcontext)
Variables
Zend_Http_Client $_client (line 52)

Zend_Http_Client Object

  • access: protected
array $_error = null (line 80)

Holds error information (e.g., for handling simplexml_load_string() warnings)

  • access: protected
array $_params (line 59)

Array that contains parameters being used by the webservice

  • access: protected
boolean $_testing (line 66)

Flag if we're doing testing or not

  • access: protected
string $_testingResponse (line 73)

Http response used for testing purposes

  • access: protected
Methods
Constructor __construct (line 96)

Sets up character encoding, instantiates the HTTP client, and assigns the web service version and testing parameters (if provided).

  • access: public
void __construct ([boolean $testing = false], [string $testingResponse = null])
  • boolean $testing
  • string $testingResponse
albumGetInfo (line 492)
  • access: public
void albumGetInfo ()
artistGetRelatedArtists (line 438)

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

  • return: object containing result set
  • access: public
SimpleXML artistGetRelatedArtists ()
artistGetTopAlbums (line 471)

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

  • return: object containing result set
  • access: public
SimpleXML artistGetTopAlbums ()
artistGetTopFans (line 449)

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

  • return: object containing result set
  • access: public
SimpleXML artistGetTopFans ()
artistGetTopTags (line 482)

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

  • return: object containing result set
  • access: public
SimpleXML artistGetTopTags ()
artistGetTopTracks (line 460)

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

  • return: object containing result set
  • access: public
SimpleXML artistGetTopTracks ()
get (line 117)

Returns a field value, or false if the named field does not exist

  • access: public
string|false get (string $field)
  • string $field
groupGetWeeklyAlbumChartList (line 581)
  • access: public
void groupGetWeeklyAlbumChartList ([ $from = NULL], [ $to = NULL])
  • $from
  • $to
groupGetWeeklyArtistChartList (line 552)
  • access: public
void groupGetWeeklyArtistChartList ([ $from = NULL], [ $to = NULL])
  • $from
  • $to
groupGetWeeklyChartList (line 546)
  • access: public
void groupGetWeeklyChartList ()
groupGetWeeklyTrackChartList (line 567)
  • access: public
void groupGetWeeklyTrackChartList ([ $from = NULL], [ $to = NULL])
  • $from
  • $to
set (line 133)

Generic set action for a field in the parameters being used

  • return: Provides a fluent interface
  • access: public
Zend_Service_Audioscrobbler set (string $field, string $value)
  • string $field: name of field to set
  • string $value: value to assign to the named field
tagGetTopAlbums (line 524)
  • access: public
void tagGetTopAlbums ()
tagGetTopArtists (line 530)
  • access: public
void tagGetTopArtists ()
tagGetTopTags (line 518)
  • access: public
void tagGetTopTags ()
tagGetTopTracks (line 536)
  • access: public
void tagGetTopTracks ()
trackGetTopFans (line 502)
  • access: public
void trackGetTopFans ()
trackGetTopTags (line 508)
  • access: public
void trackGetTopTags ()
userGetFriends (line 296)

Utility function that retrieves this user's list of friends

  • return: object containing result set
  • access: public
SimpleXML userGetFriends ()
userGetNeighbours (line 307)

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 210)

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

  • return: containing information
  • access: public
array userGetProfileInformation ()
userGetRecentBannedTracks (line 329)

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 340)

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 318)

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 230)

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

  • return: object containing result set
  • access: public
SimpleXML userGetTopAlbums ()
userGetTopArtists (line 220)

Utility function get this user's 50 most played artists

  • return: containing info
  • access: public
array userGetTopArtists ()
userGetTopTags (line 250)

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

  • return: object containing result set
  • access: public
SimpleXML userGetTopTags ()
userGetTopTagsForAlbum (line 273)

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

  • return: object containing result set
  • access: public
SimpleXML userGetTopTagsForAlbum ()
userGetTopTagsForArtist (line 261)

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 285)

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

  • return: object containing result set
  • access: public
SimpleXML userGetTopTagsForTrack ()
userGetTopTracks (line 240)

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

  • return: object containing resut set
  • access: public
SimpleXML userGetTopTracks ()
userGetWeeklyAlbumChart (line 366)

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 387)

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 352)

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 408)

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
_errorHandler (line 605)

Saves the provided error information to this instance

  • access: protected
void _errorHandler (integer $errno, string $errstr, string $errfile, integer $errline,  $errcontext)
  • integer $errno
  • string $errstr
  • string $errfile
  • integer $errline
  • array $errcontext

Documentation generated on Sun, 27 May 2007 23:20:52 -0700 by phpDocumentor 1.3.2