/ 
ZConf-RSS-0.0.0
River stage zero No dependents
/ ZConf::RSS

NAME

ZConf::RSS - ZConf backed RSS fetching.

VERSION

Version 0.0.0

SYNOPSIS

use ZConf::RSS;

my $zcrss = ZConf::RSS->new();
...

METHODES

new

This initializes it.

One arguement is taken and that is a hash value.

hash values

autoinit

If this is set to true, it will automatically call init the set and config. If this is set to false or not defined, besure to check '$zcw->{init}' to see if the config/module has been initiated or not.

If it is not specified, it will default to true.

set

This is the set to load initially.

zconf

If this key is defined, this hash will be passed to ZConf->new().

my $zcrss=ZConf::RSS->new();
if($zcrss->{error}){
    print "Error!\n";
}

composeFromFeed

This takes a specified feed name and composes string based on it.

composeFromObj

This takes the returned 'XML::FeedPP' object returned by 'getFeed' and composes a string out of it using the specified templates.

feedExists

This makes sure a specified template exists.

my $returned=$zcrss->feedExists('someFeed');
if($zcw->{error}){
    print "Error!\n";
}else{
    if($returned){
        print "It exists.\n";
    }
}

getFeed

This creates a 'XML::FeedPP' object based on a feed.

getFeedArgs

This fetches the arguements for the feed.

my %args=$zcrss->getFeedArgs('someFeed');
if($zcrss->{error}){
    print "Error!\n";
}

getFeedAsTemplatedString

This fetches a feed, processes it using the specified templates and returns a string.

my $string=$zcrss->getFeedAsTemplatedString('someFeed');

getSet

This gets what the current set is.

my $set=$zcrss->getSet;
if($zcrss->{error}){
    print "Error!\n";
}

getTemplate

This returns a template as a string.

my $template=$zcrss->getTemplate('some/template');
if ($zcrss->{error}) {
    print "Error!\n";
}

init

This initializes it or a new set.

If the specified set already exists, it will be reset.

One arguement is required and it is the name of the set. If it is not defined, ZConf will use the default one.

#creates a new set named foo
$zcw->init('foo');
if($zcrss->{error}){
    print "Error!\n";
}

#creates a new set with ZConf choosing it's name
$zcrss->init();
if($zcrss->{error}){
    print "Error!\n";
}

listFeeds

This lists the available feeds.

my @feeds=$zcrss->listFeeds();
if($zcrss->{error}){
    print "Error!\n";
}

listSets

This lists the available sets.

my @sets=$zcrss->listSets;
if($zcrss->{error}){
    print "Error!";
}

listTemplates

This gets a list of available templates.

my @templates=$zcrss->listTemplates;
if($zcrss->{error}){
    print "Error!\n";
}

readSet

This reads a specific set. If the set specified is undef, the default set is read.

#read the default set
$zcrss->readSet();
if($zcrss->{error}){
    print "Error!\n";
}

#read the set 'someSet'
$zcrss->readSet('someSet');
if($zcrss->{error}){
    print "Error!\n";
}

setFeed

hash args

feed

This the feed to be added.

name

This is the name to use for it.

topTemplate

This is the name of the top template to use.

itemTemplate

This is the name of the template that will be used for each item.

bottomTemplate

This is the name of the bottom template to use.

setTemplate

This sets a specified template to the given value.

$zcrss->setTemplate($templateName, $template);
if ($zcw->{error}) {
    print "Error!\n";
}

templateExists

This makes sure a specified template exists.

my $returned=$zcrss->templateExists('someTemplate');
if($zcw->{error}){
    print "Error!\n";
}else{
    if($returned){
        print "It exists.\n";
    }
}

errorblank

This blanks the error storage and is only meant for internal usage.

It does the following.

$self->{error}=undef;
$self->{errorString}="";

TEMPLATE VARIABLES

The templating system used is 'Text::NeatTemplate'. The varialbes are as below.

CHANNEL

ctitle

This is the title for the channel.

cdesc

This is the description for the channel.

cpubdate

This is the publication date for the channel.

ccopyright

This is the copyright info for the channel.

This is the link for the channel.

clang

This is the language for the channel.

cimage

This is the image for the channel.

ITEM

ititle

This is the title for a item.

idesc

This is the description for a item.

idescFTWL

This is the description for a item that has been has been formated with 'HTML::FormatText::WithLinks'

ipubdate

This is the date published for a item.

icat

This is the category for a item.

iauthor

This is the author for a item.

iguid

This is the item's guid element.

This is the link for a item.

DEFAULT TEMPLATES

defaultTop

Channel: {$ctitle}
Date: {$cpubdate}
Language: {$clang}
Copywright: {$ccopyright}
Link: {$clink}

{$cdesc}

defaultItem

--------------------------------------------------------------------------------
Title: {$ititle}
Date: {$ipubdate}
Author: {$iauthor}
Category: {$icat} 
Link: {$ilink}

{$idescFTWL}

defaultBottom

This one is blank by default.

ERROR CODES

1

Could not initialize ZConf.

2

ZConf error.

3

Missing required arguement.

4

Feed name can't match /\//.

5

Feed does not exist.

6

Feed not defined.

7

Failed to load feed.

AUTHOR

Zane C. Bowers, <vvelox at vvelox.net>

BUGS

Please report any bugs or feature requests to bug-zconf-rss at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=ZConf-RSS. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc ZConf::RSS

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2009 Zane C. Bowers, all rights reserved.

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