NAME

XML::RSS::Parser::Feed -- a specialized XML::RSS::Parser::Element object that is used as the root element of a parsed RSS feed.

DESCRIPTION

XML::RSS::Parser::Feed is a subclass of XML::RSS::Parser::Element with a few additional methods to streamline working with a parse tree. This object is used as the root element in the parse tree.

METHODS

XML::RSS::Parser::Feed->new

Constructor. Returns a XML::RSS::Parser::Feed object.

$feed->rss_namespace_uri

A utility method for determining the namespace the RSS elements are in if at all. This is important since different RSS namespaces are in use. Returns the default namespace if it is defined otherwise it hunts for it based on a list of common namespace URIs. Return a null string if a namespace cannot be determined or was not defined at all in the feed.

$feed->item_count

Returns an integer representing the number of item elements in the feed.

INHERITED METHODS

The Feed object inherits from XML::RSS::Parser::Element. Since a Feed object is always the root object of a parse tree a number of methods have been overridden accordingly. See the XML::RSS::Parser::Element documentation for more detail on methods not listed here.

$feed->root

Overridden method that returns a reference to itself.

$feed->parent

$feed->attribute

$feed->attributes

Overridden methods that always returns undef.

$feed->name

Overridden method that always returns 'rss'.

$feed->value

Overridden method that always returns an empty string.

$feed->value_append

Does nothing.

$feed->query

$feed->xpath

Pass through to Element methods.

ALIAS METHODS

$feed->channel

Returns a reference to the channel element object.

$feed->items

Returns an array of reference to item elements object.

$feed->image

Returns a reference to the image object if one exists.

SEE ALSO

XML::RSS::Parser, XML::RSS::Parser::Element, XML::SimpleObject

LICENSE

The software is released under the Artistic License. The terms of the Artistic License are described at http://www.perl.com/language/misc/Artistic.html.

AUTHOR & COPYRIGHT

Except where otherwise noted, XML::RSS::Parser::Feed is Copyright 2003-4, Timothy Appnel, cpan@timaoutloud.org. All rights reserved.