Service/Audioscrobbler.php

Show:

inherited

Classes
- \Zend_Service_Audioscrobbler

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: Audioscrobbler
Version: $Id$

\Zend_Service_Audioscrobbler
jump to top

Package: Zend_Service\Audioscrobbler

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_Http_Client $_client

Zend_Http_Client Object

Details

Type: \Zend_Http_Client
Access: protected

array $_error = null

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

Default valuenullDetails

Type: array
Access: protected

array $_params

Array that contains parameters being used by the webservice

Details

Type: array
Access: protected

Methods

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

Call Intercept for set($name, $field)

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
\Zend_Service_Audioscrobbler

__construct() : void

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

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

Saves the provided error information to this instance

Parameters

Name	Type	Description
$errno	integer
$errstr	string
$errfile	string
$errline	integer
$errcontext	array

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

Protected method that queries REST service and returns SimpleXML response set

Parameters

Name	Type	Description
$service	string	name of Audioscrobbler service file we're accessing
$params	string	parameters that we send to the service if needded

Returns

Type	Description
\SimpleXMLElement	result set

Throws

Exception	Description
\Zend_Http_Client_Exception
\Zend_Service_Exception

Details

Access: protected

albumGetInfo() : \SimpleXMLElement

Get information about an album

Returns

Type	Description
\SimpleXMLElement

artistGetRelatedArtists() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

artistGetTopAlbums() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

artistGetTopFans() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

artistGetTopTags() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

artistGetTopTracks() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

get(string $field) : string | false

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

Parameters

Name	Type	Description
$field	string

Returns

Type	Description
string \| false

getHttpClient() : \Zend_Http_Client

Get current http client.

Returns

Type	Description
\Zend_Http_Client

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

Retrieve Weekly album charts.

Parameters

Name	Type	Description
$from	int
$to	int

Returns

Type	Description
\SimpleXMLElement

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

Retrieve weekly Artist Charts

Parameters

Name	Type	Description
$from	int
$to	int

Returns

Type	Description
\SimpleXMLElement

groupGetWeeklyChartList() : \SimpleXMLElement

Get weekly chart list by current set group.

Returns

Type	Description
\SimpleXMLElement

Details

See

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

Retrieve Weekly Track Charts

Parameters

Name	Type	Description
$from	int
$to	int

Returns

Type	Description
\SimpleXMLElement

lazyLoadHttpClient() : void

Lazy load Http Client if none is instantiated yet.

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

Generic set action for a field in the parameters being used

Parameters

Name	Type	Description
$field	string	name of field to set
$value	string	value to assign to the named field

Returns

Type	Description
\Zend_Service_Audioscrobbler	Provides a fluent interface

setHttpClient(\Zend_Http_Client $client) : void

Set Http Client

Parameters

Name	Type	Description
$client	\Zend_Http_Client

tagGetTopAlbums() : \SimpleXMLElement

Get top albums by current tag.

Returns

Type	Description
\SimpleXMLElement

tagGetTopArtists() : \SimpleXMLElement

Get top artists by current tag.

Returns

Type	Description
\SimpleXMLElement

tagGetTopTags() : \SimpleXMLElement

Get Top Tags.

Returns

Type	Description
\SimpleXMLElement

tagGetTopTracks() : \SimpleXMLElement

Get Top Tracks by currently set tag.

Returns

Type	Description
\SimpleXMLElement

trackGetTopFans() : \SimpleXMLElement

Get top fans of the current track.

Returns

Type	Description
\SimpleXMLElement

trackGetTopTags() : \SimpleXMLElement

Get top tags of the current track.

Returns

Type	Description
\SimpleXMLElement

userGetFriends() : \SimpleXMLElement

Utility function that retrieves this user's list of friends

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetNeighbours() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetProfileInformation() : array

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

Returns

Type	Description
array	containing information

userGetRecentBannedTracks() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetRecentLovedTracks() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetRecentTracks() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetTopAlbums() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetTopArtists() : array

Utility function get this user's 50 most played artists

Returns

Type	Description
array	containing info

userGetTopTags() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetTopTagsForAlbum() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetTopTagsForArtist() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetTopTagsForTrack() : \SimpleXMLElement

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

userGetTopTracks() : \SimpleXML

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

Returns

Type	Description
\SimpleXML	object containing resut set

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

Utility function that returns weekly album chart data for this user

Parameters

Name	Type	Description
$from	integer	optional UNIX timestamp for start of date range
$to	integer	optional UNIX timestamp for end of date range

Returns

Type	Description
\SimpleXMLElement	object containing result set

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

Utility function that returns weekly artist chart data for this user

Parameters

Name	Type	Description
$from	integer	optional UNIX timestamp for start of date range
$to	integer	optional UNIX timestamp for end of date range

Returns

Type	Description
\SimpleXMLElement	object containing result set

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

Returns

Type	Description
\SimpleXMLElement	object containing result set

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

Utility function that returns weekly track chart data for this user

Parameters

Name	Type	Description
$from	integer	optional UNIX timestamp for start of date range
$to	integer	optional UNIX timestamp for end of date range

Returns

Type	Description
\SimpleXMLElement	object containing result set

Service/Audioscrobbler.php

\Zend_Service_Audioscrobblerjump to top

Properties

Methods

\Zend_Service_Audioscrobbler
jump to top