NAME

XML::Atom::Syndication::Source - class representing an Atom source element

DESCRIPTION

If an atom:entry is copied from one feed into another feed, then the source atom:feed's metadata (all child elements of atom:feed other than the atom:entry elements) MAY be preserved within the copied entry by adding an atom:source child element, if it is not already present in the entry, and including some or all of the source feed's Metadata elements as the atom:source element's children. Such metadata SHOULD be preserved if the source atom:feed contains any of the child elements atom:author, atom:contributor, atom:rights, or atom:category and those child elements are not present in the source atom:entry.

The atom:source element is designed to allow the aggregation of entries from different feeds while retaining information about an entry's source feed. For this reason, Atom Processors which are performing such aggregation SHOULD include at least the required feed-level Metadata elements (atom:id, atom:title, and atom:updated) in the atom:source element.

Essentially the source element contains any or all of the elements that can be found in a feed element except for atom:published and atom entry elements.

METHODS

XML::Atom::Syndication::Source is a subclass of XML::Atom::Syndication:::Thing that it inherits numerous methods from. You should already be familar with its base class before proceeding.

STREAM NOT SUPPORTED IN NEW

The source element is not to be the root of a document like the feed element therefore the Stream parameter is purposfully ignored if passed in with the new method.

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.

XML::Atom::Syndication::Source supports the same element accesors as XML::Atom::Syndication::Feed except for atom:published.

AUTHOR & COPYRIGHT

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