Zend Framework API Documentation
Back to top  

category Zend
package Zend_Service
subpackage Audioscrobbler
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Call Intercept for set($name, $field)

__call(string $method, array $args) : \Zend_Service_Audioscrobbler

Parameters

$method

string

$args

array

Returns

\Zend_Service_Audioscrobbler

Sets up character encoding, instantiates the HTTP client, and assigns the web service version.

__construct() 

Saves the provided error information to this instance

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

Parameters

$errno

integer

$errstr

string

$errfile

string

$errline

integer

$errcontext

array

Get information about an album

albumGetInfo() : \SimpleXMLElement

Returns

\SimpleXMLElement

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

artistGetRelatedArtists() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

artistGetTopAlbums() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

artistGetTopFans() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

artistGetTopTags() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

artistGetTopTracks() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

get(string $field) : string | false

Parameters

$field

string

Returns

stringfalse

Get current http client.

getHttpClient() : \Zend_Http_Client

Returns

\Zend_Http_Client

Retrieve Weekly album charts.

groupGetWeeklyAlbumChartList(integer $from = NULL, integer $to = NULL) : \SimpleXMLElement

Parameters

$from

integer

$to

integer

Returns

\SimpleXMLElement

Retrieve weekly Artist Charts

groupGetWeeklyArtistChartList(integer $from = NULL, integer $to = NULL) : \SimpleXMLElement

Parameters

$from

integer

$to

integer

Returns

\SimpleXMLElement

Get weekly chart list by current set group.

groupGetWeeklyChartList() : \SimpleXMLElement
see

Returns

\SimpleXMLElement

Retrieve Weekly Track Charts

groupGetWeeklyTrackChartList(integer $from = NULL, integer $to = NULL) : \SimpleXMLElement

Parameters

$from

integer

$to

integer

Returns

\SimpleXMLElement

Generic set action for a field in the parameters being used

set(string $field, string $value) : \Zend_Service_Audioscrobbler

Parameters

$field

string

name of field to set

$value

string

value to assign to the named field

Returns

\Zend_Service_AudioscrobblerProvides a fluent interface

Set Http Client

setHttpClient(\Zend_Http_Client $client) 

Parameters

$client

\Zend_Http_Client

Get top albums by current tag.

tagGetTopAlbums() : \SimpleXMLElement

Returns

\SimpleXMLElement

Get top artists by current tag.

tagGetTopArtists() : \SimpleXMLElement

Returns

\SimpleXMLElement

Get Top Tags.

tagGetTopTags() : \SimpleXMLElement

Returns

\SimpleXMLElement

Get Top Tracks by currently set tag.

tagGetTopTracks() : \SimpleXMLElement

Returns

\SimpleXMLElement

Get top fans of the current track.

trackGetTopFans() : \SimpleXMLElement

Returns

\SimpleXMLElement

Get top tags of the current track.

trackGetTopTags() : \SimpleXMLElement

Returns

\SimpleXMLElement

Utility function that retrieves this user's list of friends

userGetFriends() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

userGetNeighbours() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

userGetProfileInformation() : array

Returns

arraycontaining information

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

userGetRecentBannedTracks() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

userGetRecentLovedTracks() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

userGetRecentTracks() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

userGetTopAlbums() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

Utility function get this user's 50 most played artists

userGetTopArtists() : array

Returns

arraycontaining info

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

userGetTopTags() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

userGetTopTagsForAlbum() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

userGetTopTagsForArtist() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

userGetTopTagsForTrack() : \SimpleXMLElement

Returns

\SimpleXMLElementobject containing result set

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

userGetTopTracks() : \SimpleXML

Returns

\SimpleXMLobject containing resut set

Utility function that returns weekly album chart data for this user

userGetWeeklyAlbumChart(integer $from = NULL, integer $to = NULL) : \SimpleXMLElement

Parameters

$from

integer

optional UNIX timestamp for start of date range

$to

integer

optional UNIX timestamp for end of date range

Returns

\SimpleXMLElementobject containing result set

Utility function that returns weekly artist chart data for this user

userGetWeeklyArtistChart(integer $from = NULL, integer $to = NULL) : \SimpleXMLElement

Parameters

$from

integer

optional UNIX timestamp for start of date range

$to

integer

optional UNIX timestamp for end of date range

Returns

\SimpleXMLElementobject containing result set

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

userGetWeeklyChartList() : \SimpleXMLElement

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

Returns

\SimpleXMLElementobject containing result set

Utility function that returns weekly track chart data for this user

userGetWeeklyTrackChart(integer $from = NULL, integer $to = NULL) : \SimpleXMLElement

Parameters

$from

integer

optional UNIX timestamp for start of date range

$to

integer

optional UNIX timestamp for end of date range

Returns

\SimpleXMLElementobject containing result set

Protected method that queries REST service and returns SimpleXML response set

_getInfo(string $service, string $params = null) : \SimpleXMLElement
access protected

Parameters

$service

string

name of Audioscrobbler service file we're accessing

$params

string

parameters that we send to the service if needded

Exceptions

\Zend_Http_Client_Exception
\Zend_Service_Exception

Returns

\SimpleXMLElementresult set

Lazy load Http Client if none is instantiated yet.

lazyLoadHttpClient() : void

 Properties

 

Zend_Http_Client Object

$_client : \Zend_Http_Client

Default

access protected
 

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

$_error : array

Default

null
access protected
 

Array that contains parameters being used by the webservice

$_params : array

Default

access protected