NAME

WWW::Noss::FeedConfig - Class for storing feed configurations

USAGE

use WWW::Noss::FeedConfig;

my $feed = WWW::Noss::FeedConfig->new(
    name => 'feed',
    feed => 'https://feed.xml',
    path => 'feed.xml',
);

DESCRIPTION

WWW::Noss::FeedConfig is a module that provides a class for storing noss feed configurations. This is a private module, please consult the noss manual for user documentation.

METHODS

Not all methods are documented here, as this class is derived from the WWW::Noss::BaseConfig module. Consult its documentation for additional methods.

$feed = WWW::Noss::FeedConfig->new(%param)

Returns a blessed WWW::Noss::FeedConfig object based on the parameters provided in the %param hash.

The following are valid fields for the %param hash. The name, feed, and path fields are the only required fields.

name

The name of feed. Can only only contain alphanumeric and underscore characters.

feed

The feed URL.

path

Path to the location to store the feed.

etag

Path to store the feed's etag.

groups

Array ref of WWW::Noss::GroupConfig groups that the feed is a part of.

default

WWW::Noss::GroupConfig object representing the default feed group.

The following fields from WWW::Noss::BaseConfig are also available:

limit

respect_skip

include_title

exclude_title

include_content

exclude_content

include_tags

exclude_tags

autoread

default_update

hidden

$name = $feed->name()

$feed->set_name($name)

Getter/setter for the feed's name attribute.

$url = $feed->feed()

$feed->set_feed($url)

Getter/setter for the feed's feed attribute.

\@groups = $feed->groups()

$feed->set_groups(\@groups)

Getter/setter for the feed's groups attribute. Do note that modifying the groups attribute does not affect the feed's configuration like it does during initialization.

$ok = $feed->has_group($group)

Returns true if $feed is a part of the group $group.

$path = $feed->path()

$feed->set_path($path)

Getter/setter for the feed's path attribute.

$etag = $feed->etag()

$feed->set_etag($etag)

Getter/setter for the feed's etag attribute.

AUTHOR

Written by Samuel Young, <samyoung12788@gmail.com>.

This project's source can be found on its Codeberg page. Comments and pull requests are welcome!

COPYRIGHT

Copyright (C) 2025 Samuel Young

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

SEE ALSO

WWW::Noss::BaseConfig, WWW::Noss::GroupConfig, noss