The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
OpenGuides-0.81
River stage zero No dependents
++
/ OpenGuides::Feed
set_feed_name_and_url_params Overrides the default feed name and default feed http equivalent url. Useful on custom feeds, where the defaults are incorrect.
   $feed->set_feed_name_and_url("Search Results", "search=pub");
   $feed->build_mini_feed_for_nodes("rss", @search_results);
make_feed

Produce one of the standard feeds, in the requested format.

my $feed_contents = feeds->make_feed( feed_type => 'rss', feed_listing => 'recent_changes' );

Passes additional arguments through to the underlying Wiki::Toolkit::Feed

build_feed_for_nodes

For the given feed type, build a feed from the supplied list of nodes. Will figure out the feed timestamp from the newest node, and output a last modified header based on this.

my @nodes = $wiki->fetch_me_nodes_I_like(); my $feed_contents = $feed->build_feed_for_nodes("rss", @nodes);

build_mini_feed_for_nodes

For the given feed type, build a mini feed (name and distance) from the supplied list of nodes. Will figure out the feed timestamp from the newest node, and output a last modified header based on this.

my @nodes = $wiki->search_near_here(); my $feed_contents = $feed->build_mini_feed_for_nodes("rss", @nodes);

render_feed_for_nodes

Normally internal method to perform the appropriate building of a feed based on a list of nodes.

default_content_type

For the given feed type, return the default content type for that feed.

my $content_type = $feed->default_content_type("rss");

fetch_maker

For the given feed type, identify and return the maker routine for feeds of that type.

my $maker = $feed->fetch_maker("rss"); my $feed_contents = maker->node_all_versions(%options);

Will always return something of type Wiki::Toolkit::Feed::Listing

NAME

OpenGuides::Feed - generate data feeds for OpenGuides in various formats.

DESCRIPTION

Produces RSS 1.0 and Atom 1.0 feeds for OpenGuides. Distributed and installed as part of the OpenGuides project, not intended for independent installation. This documentation is probably only useful to OpenGuides developers.

SYNOPSIS

    use Wiki::Toolkit;
    use OpenGuides::Config;
    use OpenGuides::Feed;

    my $wiki = Wiki::Toolkit->new( ... );
    my $config = OpenGuides::Config->new( file => "wiki.conf" );
    my $feed = OpenGuides::Feed->new( wiki       => $wiki,
                                      config     => $config,
                                      og_version => '1.0', );

    # Ten most recent changes in RSS format.
    my %args = ( items     => 10,
                 feed_type => 'rss',
                 also_return_timestamp => 1 );
    my ($feed_output,$feed_timestamp) = $feed->make_feed( %args );

    print "Content-Type: application/rdf+xml\n";
    print "Last-Modified: " . $feed_timestamp . "\n\n";
    print $feed_output;

METHODS

new
    my $feed = OpenGuides::Feed->new( wiki       => $wiki,
                                      config     => $config,
                                      og_version => '1.0', );

wiki must be a Wiki::Toolkit object and config must be an OpenGuides::Config object. Both of these arguments are mandatory. og_version is an optional argument specifying the version of OpenGuides for inclusion in the feed.

rss_maker

Returns a raw Wiki::Toolkit::Feed::RSS object created with the values you invoked this module with.

atom_maker

Returns a raw Wiki::Toolkit::Feed::Atom object created with the values you invoked this module with.

make_feed
    # Ten most recent changes in RSS format.
    my %args = ( items     => 10,
                 feed_type => 'rss',
                 also_return_timestamp => 1 );
    my ($feed_output,$feed_timestamp) = $rdf_writer->make_feed( %args );

    print "Content-Type: application/rdf+xml\n";
    print "Last-Modified: " . $feed_timestamp . "\n\n";
    print $feed_output;
    print $rdf_writer->make_feed( %args );


    # All the changes made by bob in the past week, ignoring minor edits, in Atom.
    $args{days}               = 7;
    $args{ignore_minor_edits  = 1;
    $args{filter_on_metadata} => { username => "bob" };
    $args{also_return_timestamp} => 1;

    my ($feed_output,$feed_timestamp) = $rdf_writer->make_feed( %args );
    print "Content-Type: application/atom+xml\n";
    print "Last-Modified: " . $feed_timestamp . "\n\n";
    print $feed_output;
feed_timestamp

Instead of calling this, you should instead pass in the 'also_return_timestamp' option. You will then get back the feed timestamp, along with the feed output.

This method will be removed in future, and currently will only return meaningful values if your arguments relate to recent changes.

    print "Last-Modified: " . $feed->feed_timestamp( %args ) . "\n\n";

Returns the timestamp of something in POSIX::strftime style ("Tue, 29 Feb 2000 12:34:56 GMT"). Takes the same arguments as make_recentchanges_rss(). You will most likely need this to print a Last-Modified HTTP header so user-agents can determine whether they need to reload the feed or not.

SEE ALSO

AUTHOR

The OpenGuides Project (openguides-dev@lists.openguides.org)

COPYRIGHT

Copyright (C) 2003-2012 The OpenGuides Project. All Rights Reserved.

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

CREDITS

Written by Earle Martin, based on the original OpenGuides::RDF by Kake Pugh.