NAME

WWW::Noss::BaseConfig - Base class for feed configuration classes

USAGE

use parent 'WWW::Noss::BaseConfig';

DESCRIPTION

WWW::Noss::BaseConfig is a class that implements the base functionality for the WWW::Noss::FeedConfig and WWW::Noss::GroupConfig modules. This is a private module, please consult the noss manual for user documentation.

METHODS

$conf = WWW::Noss::BaseConfig->new(%param)

Default constructor for WWW::Noss::BaseConfig. Parameters are supplied via the %param hash.

The following are valid fields for %param:

limit

Post limit. Should be an integar that is greater than 0, or undef for no limit.

respect_skip

Boolean determining whether the skipHours and skipDays fields in RSS feeds should be respected.

include_title

Array ref of regexes that post titles must match in order to not be filtered out.

exclude_title

Array ref of regexes that post titles must NOT match in order to not be filtered out.

include_content

Array ref of regexes that a post's content must match in order to not be filtered out.

exclude_content

Array ref of regexes that a post's content must NOT match in order to not be filtered out.

include_tags

Array ref of tags that a post must have in order to not be filtered out.

exclude_tags

Array ref of tags that a post must NOT have in order to not be filtered out.

autoread

Boolean determining whether new posts will automatically be marked as read or not.

default_update

Boolean determining whether a feed should be included in a default update or not.

hidden

Boolean determining whether a feed should be omitted from the list command's default listing.

$limit = $conf->limit()

$conf->set_limit($limit)

Getter/setter for the limit attribute.

$respect = $conf->respect_skip()

$conf->set_respect_skip($respect)

Getter/setter for the respect_skip attribute.

\@inc = $conf->include_title()

$conf->set_include_title(\@inc)

\@exc = $conf->exclude_title()

$conf->set_exclude_title(\@exc)

Getter/setters for the include_title and exclude_title attributes.

\@inc = $conf->include_content()

$conf->set_include_content(\@inc)

\@exc = $conf->exclude_content()

$conf->set_exclude_content(\@exc)

Getter/setters for the include_content and exclude_content attributes.

\@inc = $conf->include_tags()

$conf->set_include_tags(\@inc)

\@exc = $conf->exclude_tags()

$conf->set_exclude_tags(\@exc)

Getter/setters for the include_tags and exclude_tags attributes.

$autoread = $conf->autoread()

$conf->set_autoread($autoread)

Getter/setter for the autoread attribute.

$default = $conf->default_update()

$conf->set_default_update($default)

Getter/setter for the default_update attribute.

$hidden = $conf->hidden()

$conf->set_hidden($hidden)

Getter/setter for the hidden attribute.

$ok = $conf->title_ok($title)

$ok = $conf->content_ok($content)

$ok = $conf->tags_ok(\@tags)

Methods returning a boolean of whether the given title/content/tags are acceptable according to their respective include and exclude attributes.

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::FeedConfig, WWW::Noss::GroupConfig, noss