NAME

XML::Atom::Syndication::Feed - class representing an Atom feed

DESCRIPTION

METHODS

XML::Atom::Syndication::Feed is a subclass of XML::Atom::Syndication:::Thing that it inherits numerous methods from in addition to implementing some of its own. You should already be familar with those that class and its base class XML::Atom::Syndication::Object before proceeding.

The methods specific to this class are as follows:

language

Accessor to the xml:lang attribute. See [W3C.REC-xml-20040204], Section 2.12 for more on the use of this attribute.

$feed->generator_uri($uri)

$feed->generator_version($version)

$feed->add_entry($entry)

Appends a XML::Atom::Syndication::Entry object to the feed. The new entry is placed at the end of all other entries.

$feed->insert_entry($entry)

Inserts a XML::Atom::Syndication::Entry object before all other entries in the feed.

$feed->entries

Returns an ordered ARRAY of XML::Atom::Syndication::Entry objects representing the feed's entries.

ELEMENT ACCESSORS

The following known Atom elements can be accessed through objects of this class. See ELEMENT ACCESSORS in XML::Atom::Syndication::Object for more detail.

generator

Identifies the agent used to generate a feed for debugging and other purposes. See the section below on accessing the generator URI and version.

icon

An IRI reference [RFC3987] which identifies an image which provides iconic visual identification for a feed.

id

A permanent, universally unique identifier for an entry or feed.

published

A date indicating an instance in time associated with an event early in the life of the entry. Dates values MUST conform to the "date-time" production in [RFC3339].

rights

Conveys information about rights held in and over an entry or feed.

subtitle

Conveys a human-readable description or subtitle of a feed.

summary

Conveys a short summary, abstract, or excerpt of an entry.

title

Conveys a human-readable title for an entry or feed.

updated

The most recent instance in time when an entry or feed was modified in a way the publisher considers significant. Dates values MUST conform to the "date-time" production in [RFC3339].

ACCESSING THE GENERATOR URI AND VERSION

The generator element is currently implemented as a standard element accessor. This is fin if all you want is the human-readable label however the uri and version attributes that may be present cannot be accessed through this means. If you do need access to these attributes use the node_list utility method to retreive the underlying generator element and then get/set the attribute. For instance...

my($g) = nodelist($feed,$feed->ns,'generator');
$g->attributes->{uri};                 # get uri attribute
$g->attributes->{version} = '1.0';     # set version attribute

AUTHOR & COPYRIGHT

Please see the XML::Atom::Syndication manpage for author, copyright, and license information.