API Documentation

Service/Audioscrobbler.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
subpackage
Audioscrobbler
version
$Id: Audioscrobbler.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Service_Audioscrobbler

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Service_Audioscrobbler
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
subpackage
Audioscrobbler
Properties
$_client
$_params
$_error
Methods
__construct
setHttpClient
getHttpClient
lazyLoadHttpClient
get
set
_getInfo
userGetProfileInformation
userGetTopArtists
userGetTopAlbums
userGetTopTracks
userGetTopTags
userGetTopTagsForArtist
userGetTopTagsForAlbum
userGetTopTagsForTrack
userGetFriends
userGetNeighbours
userGetRecentTracks
userGetRecentBannedTracks
userGetRecentLovedTracks
userGetWeeklyChartList
userGetWeeklyAlbumChart
userGetWeeklyArtistChart
userGetWeeklyTrackChart
artistGetRelatedArtists
artistGetTopFans
artistGetTopTracks
artistGetTopAlbums
artistGetTopTags
albumGetInfo
trackGetTopFans
trackGetTopTags
tagGetTopTags
tagGetTopAlbums
tagGetTopArtists
tagGetTopTracks
groupGetWeeklyChartList
groupGetWeeklyArtistChartList
groupGetWeeklyTrackChartList
groupGetWeeklyAlbumChartList
_errorHandler
__call

Description

Properties

$_client
jump to class

Zend_Http_Client $_client = ''

Zend_Http_Client Object

Details

$_client
Zend_Http_Client
visibility
protected
default
final
false
static
false
access
protected

$_error
jump to class

array $_error = 'null'

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

Details

$_error
array
visibility
protected
default
null
final
false
static
false
access
protected

$_params
jump to class

array $_params = ''

Array that contains parameters being used by the webservice

Details

$_params
array
visibility
protected
default
final
false
static
false
access
protected

Methods

__call
jump to class

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

Call Intercept for set($name, $field)

Arguments
$method
string
$args
array
Output
Zend_Service_Audioscrobbler
Details
visibility
public
final
false
static
false

__construct
jump to class

__construct( ) :

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

Details
visibility
public
final
false
static
false

_errorHandler
jump to class

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

Saves the provided error information to this instance

Arguments
$errno
integer
$errstr
string
$errfile
string
$errline
integer
$errcontext
array
Details
visibility
protected
final
false
static
false

_getInfo
jump to class

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

Protected method that queries REST service and returns SimpleXML response set

Arguments
$service
string
name of Audioscrobbler service file we're accessing
$params
string
parameters that we send to the service if needded
Output
SimpleXMLElement
result set
Details
visibility
protected
final
false
static
false
access
protected
throws
throws

albumGetInfo
jump to class

albumGetInfo( ) : SimpleXMLElement

Get information about an album

Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

artistGetRelatedArtists
jump to class

artistGetRelatedArtists( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

artistGetTopAlbums
jump to class

artistGetTopAlbums( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

artistGetTopFans
jump to class

artistGetTopFans( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

artistGetTopTags
jump to class

artistGetTopTags( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

artistGetTopTracks
jump to class

artistGetTopTracks( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

get
jump to class

get( string $field ) : string|false

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

Arguments
$field
string
Output
string|false
Details
visibility
public
final
false
static
false

getHttpClient
jump to class

getHttpClient( ) : Zend_Http_Client

Get current http client.

Output
Zend_Http_Client
Details
visibility
public
final
false
static
false

groupGetWeeklyAlbumChartList
jump to class

groupGetWeeklyAlbumChartList( int $from = NULL, int $to = NULL ) : SimpleXMLElement

Retrieve Weekly album charts.

Arguments
$from
int
$to
int
Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

groupGetWeeklyArtistChartList
jump to class

groupGetWeeklyArtistChartList( int $from = NULL, int $to = NULL ) : SimpleXMLElement

Retrieve weekly Artist Charts

Arguments
$from
int
$to
int
Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

groupGetWeeklyChartList
jump to class

groupGetWeeklyChartList( ) : SimpleXMLElement

Get weekly chart list by current set group.

Output
SimpleXMLElement
Details
visibility
public
final
false
static
false
see
set()

groupGetWeeklyTrackChartList
jump to class

groupGetWeeklyTrackChartList( int $from = NULL, int $to = NULL ) : SimpleXMLElement

Retrieve Weekly Track Charts

Arguments
$from
int
$to
int
Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

lazyLoadHttpClient
jump to class

lazyLoadHttpClient( ) : void

Lazy load Http Client if none is instantiated yet.

Details
visibility
protected
final
false
static
false

set
jump to class

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

Generic set action for a field in the parameters being used

Arguments
$field
string
name of field to set
$value
string
value to assign to the named field
Output
Zend_Service_Audioscrobbler
Provides a fluent interface
Details
visibility
public
final
false
static
false

setHttpClient
jump to class

setHttpClient( Zend_Http_Client $client ) :

Set Http Client

Arguments
$client
Zend_Http_Client
Details
visibility
public
final
false
static
false

tagGetTopAlbums
jump to class

tagGetTopAlbums( ) : SimpleXMLElement

Get top albums by current tag.

Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

tagGetTopArtists
jump to class

tagGetTopArtists( ) : SimpleXMLElement

Get top artists by current tag.

Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

tagGetTopTags
jump to class

tagGetTopTags( ) : SimpleXMLElement

Get Top Tags.

Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

tagGetTopTracks
jump to class

tagGetTopTracks( ) : SimpleXMLElement

Get Top Tracks by currently set tag.

Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

trackGetTopFans
jump to class

trackGetTopFans( ) : SimpleXMLElement

Get top fans of the current track.

Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

trackGetTopTags
jump to class

trackGetTopTags( ) : SimpleXMLElement

Get top tags of the current track.

Output
SimpleXMLElement
Details
visibility
public
final
false
static
false

userGetFriends
jump to class

userGetFriends( ) : SimpleXMLElement

Utility function that retrieves this user's list of friends

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetNeighbours
jump to class

userGetNeighbours( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetProfileInformation
jump to class

userGetProfileInformation( ) : array

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

Output
array
containing information
Details
visibility
public
final
false
static
false

userGetRecentBannedTracks
jump to class

userGetRecentBannedTracks( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetRecentLovedTracks
jump to class

userGetRecentLovedTracks( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetRecentTracks
jump to class

userGetRecentTracks( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetTopAlbums
jump to class

userGetTopAlbums( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetTopArtists
jump to class

userGetTopArtists( ) : array

Utility function get this user's 50 most played artists

Output
array
containing info
Details
visibility
public
final
false
static
false

userGetTopTags
jump to class

userGetTopTags( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetTopTagsForAlbum
jump to class

userGetTopTagsForAlbum( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetTopTagsForArtist
jump to class

userGetTopTagsForArtist( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetTopTagsForTrack
jump to class

userGetTopTagsForTrack( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetTopTracks
jump to class

userGetTopTracks( ) : SimpleXML

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

Output
SimpleXML
object containing resut set
Details
visibility
public
final
false
static
false

userGetWeeklyAlbumChart
jump to class

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

Utility function that returns weekly album chart data for this user

Arguments
$from
integer
optional UNIX timestamp for start of date range
$to
integer
optional UNIX timestamp for end of date range
Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetWeeklyArtistChart
jump to class

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

Utility function that returns weekly artist chart data for this user

Arguments
$from
integer
optional UNIX timestamp for start of date range
$to
integer
optional UNIX timestamp for end of date range
Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetWeeklyChartList
jump to class

userGetWeeklyChartList( ) : SimpleXMLElement

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

Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false

userGetWeeklyTrackChart
jump to class

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

Utility function that returns weekly track chart data for this user

Arguments
$from
integer
optional UNIX timestamp for start of date range
$to
integer
optional UNIX timestamp for end of date range
Output
SimpleXMLElement
object containing result set
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.