Nilson Santos Figueiredo Júnior > WebService-Audioscrobbler > WebService::Audioscrobbler::Base

Download:
WebService-Audioscrobbler-0.07.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 0.07   Source  

NAME ^

WebService::Audioscrobbler::Base - An object-oriented interface to the Audioscrobbler WebService API

SYNOPSIS ^

This module implements the base class for all other WebService::Audioscrobbler modules.

    package WebService::Audioscrobbler::Subclass;
    use base 'WebService::Audioscrobbler::Base';

    ...

    my $self = WebService::Audioscrobbler::Subclass->new;
    
    # retrieves tracks
    my @tracks = $self->tracks;

    # retrieves tags
    my @tags = $self->tags;

    # retrieves arbitrary XML data as a hashref, using XML::Simple
    my $data = $self->fetch_data('resource.xml');

METHODS ^

tracks

Retrieves the tracks related to the current resource as available on Audioscrobbler's database.

Returns either a list of tracks or a reference to an array of tracks when called in list context or scalar context, respectively. The tracks are returned as WebService::Audioscrobbler::Track objects by default.

tags

Retrieves the tags related to the current resource as available on Audioscrobbler's database.

Returns either a list of tags or a reference to an array of tags when called in list context or scalar context, respectively. The tags are returned as WebService::Audioscrobbler::Tag objects by default.

artists

Retrieves the artists related to the current resource as available on Audioscrobbler's database.

Returns either a list of artists or a reference to an array of artists when called in list context or scalar context, respectively. The tags are returned as WebService::Audioscrobbler::Artist objects by default.

fetch_data($postfix)

This method retrieves arbitrary data from this resource using the specified $postfix. This is accomplished by calling the fetch method of this object's data fetcher object (usually an instance of WebService::Audioscrobbler::DataFetcher).

resource_path

This method must be overriden by classes which inherit from Base. It should return the relative resource URL which will be used for fetching it from Audioscrobbler.

uri_builder

Helps classes which inherit from WebService::Audioscrobbler::Base to build URI objects. Mainly used for keeping resource_path code cleaner in those classes.

croak

Shortcut for Carp::croak which can be called as a method.

AUTHOR ^

Nilson Santos Figueiredo Júnior, <nilsonsfj at cpan.org>

COPYRIGHT & LICENSE ^

Copyright 2006-2007 Nilson Santos Figueiredo Júnior, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: