Wiki::Toolkit::Plugin::RSS::Reader(3pm)

Usage

    use Wiki::Toolkit::Plugin::RSS::Reader;
    my $rss = Wiki::Toolkit::Plugin::RSS::Reader->new(
      url   => 'http://example.com/feed.rss'
    );
    my @items = $rss->retrieve;

Overview

Use this Wiki::Toolkit plugin to retrieve an RSS feed from a given URL so that you can include it in a wiki node.

Usage

This is a plugin for Wiki::Toolkit, a toolkit for building wikis; therefore please consult the documentation for Wiki::Toolkit for relevant information. This module can, however, be used standalone if you wish.

Methods

"new"

    my $rss = Wiki::Toolkit::Plugin::RSS::Reader->new([options]);

Create a new RSS reader. Valid options are "url" or "file" (a path to an RSS file); only one can be specified.

"retrieve"

    my @items = $rss->retrieve;

"retrieve" will return an array of hashes, one for each item in the RSS feed. The hashes contain three items, "title", "link", and "description".

If the URL or file you specified cannot be retrieved/read, "retrieve" will return undef rather than blowing up and surprising the person reading your wiki. If you want, you can specify "debug" to be 1 in the options to "new", which will cause the module to croak instead of failing silently.

Legal

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

Releases

10 releases since Debian 4.0 (Etch); the text changed 5 times.