View on
MetaCPAN
Aaron Straup Cope > Net-Flickr-Simile-0.1 > Net::Flickr::Simile::Exhbit

Download:
Net-Flickr-Simile-0.1.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

Net::Flickr::Simile::Exhbit - OOP for generating Simile Exhibit files using the Flickr API

SYNOPSIS ^

 use Getopt::Std;
 use Config::Simple;
 use Net::Flickr::Simile::Exhibit;

 my %opts = ();
 getopts('c:j:h:t:', \%opts);

 my $cfg = Config::Simple->new($opts{'c'});

 my %args = ('exhibit_json' => $opts{'j'},
             'exhibit_html' => $opts{'h'},
             'tags' => $opts{'t'});

 my $fl = Net::Flickr::Simile::Exhibit->new($cfg);
 $fl->search(\%args);
 
 # So then you might do :
 # perl ./myscript -c /my/flickr.cfg -h ./mystuff.html -j ./mystuff.js -t kittens

DESCRIPTION ^

OOP for generating Simile Exhibit files using the Flickr API.

OPTIONS ^

Options are passed to Net::Flickr::Backup using a Config::Simple object or a valid Config::Simple config file. Options are grouped by "block".

flick

reporting

PACKAGE METHODS ^

__PACKAGE__->new($cfg)

Where $cfg is either a valid Config::Simple object or the path to a file that can be parsed by Config::Simple.

Returns a Net::Flickr::Simile::Exhbit object.

OBJECT METHODS YOU SHOULD CARE ABOUT ^

Net::Flickr::Simile::Exhibit subclasses Net::Flickr::Simile and Net::Flickr::API so all of those methods are available to your object. The following methods are also defined.

$obj->getRecentPhotos(\%args)

Valid arguments are anything you would (need to) pass to the flickr.photos.search API method and :

The user_id bound to the Flickr Auth token defined in the object's config file will automatically be added to the method arguments and used to scope the query.

Returns true or false.

$obj->search(\%args)

Valid arguments are anything you would (need to) pass to the flickr.photos.search API method and :

Returns true or false.

$obj->getContactsPhotos(\%args)

Valid arguments are anything you would (need to) pass to the flickr.photos.getContactsPhotos API method and :

Returns true or false.

$obj->getContactsPublicPhotos(\%args)

Valid arguments are anything you would (need to) pass to the flickr.photos.getContactsPublicPhotos API method and :

Returns true or false.

OBJECT METHODS YOU MAY CARE ABOUT ^

$obj->rspToExhibitJson($rsp)

Where $rsp is the return value of a call to Net::Flickr::API-api_call>.

Returns a JSON string representing the data in $rsp suitable for including with a Simile Exhibit document.

$obj->writeExhbitFiles(\%paths, $rsp)

Returns true or false.

$obj->writeExhibitJson($path, $rsp)

Returns true or false

$obj->writeExhibitHtml($path, $rsp)

Returns true or false

VERSION ^

0.1

AUTHOR ^

Aaron Straup Cope <ascope@cpan.org>

NOTES ^

EXAMPLES ^

http://aaronland.info/perl/net/flickr/simile/exhibit.html

http://aaronland.info/perl/net/flickr/simile/exhibit.js

SEE ALSO ^

Net::Flickr::API

http://simile.mit.edu/exhibit/

BUGS ^

Please report all bugs via http://rt.cpan.org/

LICENSE ^

Copyright (c) 2007 Aaron Straup Cope. All Rights Reserved.

This is free software. You may redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: