Michael Stepanov > WebService-Bloglines-Blogroll-0.02 > WebService::Bloglines::Blogroll

Download:
WebService-Bloglines-Blogroll-0.02.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.02   Source  

NAME ^

WebService::Bloglines::Blogroll - Perl extension to get a blogroll from Bloglines.com.

SYNOPSIS ^

  use WebService::Bloglines::Blogroll;
  
  my $bloglines = new WebService::Bloglines::Blogroll(user_name => 'some valid name');

  $bloglines->retrieve_blogroll();

  #
  # Get blogroll as hash reference which contains a following data structure:
  # 
  #     {
  #     folder_name => [ { item_title => 'title', item_url => 'url' }, ... ],
  #             . . .
  #     }                               
  my $blogroll_hash = $bloglines->blogroll_hashref;

  #
  # Also, you can retrieve a list of item for specific folder
  #
  my $blogroll_hash = $bloglines->blogroll_hashref('folder_name');

  #
  # Get blogroll as string contained html code where each folder name surrounded
  # by <h2> tags and list of folder's items put into unordered list (<ul>). 
  # You can easy to embed the blogroll into your design using CSS.
  my $blogroll_html = $blog->blogroll_html;

DESCRIPTION ^

Bloglines is the most of famous and handy online tool for agregate and read RSS feeds. WebService::Bloglines::Blogroll is a simple Perl class which can be used to retrieve your blogroll from Bloglines, process it and display it on your personal page.

CONSTRUCTOR

new()

To retrieve a blogroll from Bloglines it's necessarily to specify an user name of owner of blogroll:

        new WebService::Bloglines::Blogroll(user_name => 'some_name');

or

        new WebService::Bloglines::Blogroll(user_name => 'some_name', folder => 'some folder');

OBJECT'S PROPERTIES

user_name

User name for Bloglines

        new WebService::Bloglines::Blogroll(user_name => 'some_name');

or

        $bloglines->user_name('some name');
folder

A specific folder from Bloglines

        new WebService::Bloglines::Blogroll(user_name => 'some_name', folder => 'some folder');

or

        $bloglines->user_name('some name');     
page

Contains an original page received from Bloglines

http_proxy

Contains a proxy http proxy. (By default, it's got from environment)

OBJECT'S METHODS

retrieve_blogroll()

Get a blogroll from Bloglines according to specified parametes:

        my $bloglines = new WebService::Bloglines::Blogroll(user_name => 'name1');
        $bloglines->retrieve_blogroll();
        my $list = $bloglines->get_blogroll_hash();

        . . .

        $bloglines->user_name('name2');
        $bloglines->retrieve_blogroll();
        my $list2 = $bloglines->get_blogroll_hash();
get_blogroll_as_html()

Returns a blogroll as HTML:

        my $html = $bloglines->get_blogroll_as_html();
get_blogroll_hash()

Returns a blogroll as hash:

        my $all_items = $bloglines->get_blogroll_hash();

or for specified folder

        my $folder_items = $bloglines->get_blogroll_hash('some folder');
get_list_folders()

Returns a list of all folders in the Bloglines blogroll

        my $folders = $bloglines->get_list_folders();

EXPORT

None by default.

SEE ALSO ^

WebService::Bloglines

AUTHOR ^

Michael stepanov, <stepanov.michael@gmail.com>

COPYRIGHT AND LICENSE ^

Copyright (C) 2005 by Michael Stepanov

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: