[catagits/XML-Feed.git] / lib / XML / Feed / Entry.pm

# $Id: Entry.pm 942 2004-12-31 23:01:21Z btrott $

package XML::Feed::Entry;
use strict;

sub wrap {
    my $class = shift;
    my($item) = @_;
    bless { entry => $item }, $class;
}

sub title;
sub link;
sub content;
sub summary;
sub category;
sub author;
sub id;
sub issued;
sub modified;

1;
__END__

=head1 NAME

XML::Feed::Entry - Entry/item in a syndication feed

=head1 SYNOPSIS

    ## $feed is an XML::Feed object.
    for my $entry ($feed->entries) {
        print $entry->title, "\n", $entry->summary, "\n\n";
    }

=head1 DESCRIPTION

I<XML::Feed::Entry> represents an entry/item in an I<XML::Feed> syndication
feed.

=head1 USAGE

=head2 $entry->title

The title of the entry.

=head2 $entry->link

The permalink of the entry, in most cases, except in cases where it points
instead to an offsite URI referenced in the entry.

=head2 $entry->content

Bn I<XML::Feed::Content> object representing the full entry body, or as
much as is available in the feed.

In RSS feeds, this method will look first for
I<http://purl.org/rss/1.0/modules/content/#encoded> and
I<http://www.w3.org/1999/xhtml#body> elements, then fall back to a
I<E<lt>descriptionE<gt>> element.

=head2 $entry->summary

An I<XML::Feed::Content> object representing a short summary of the entry.
Possibly.

Since RSS feeds do not have the idea of a summary separate from the entry
body, this may not always be what you want. If the entry contains both a
I<E<lt>descriptionE<gt>> element B<and> another element typically used for
the full content of the entry--either I<http://www.w3.org/1999/xhtml/body>
or I<http://purl.org/rss/1.0/modules/content/#encoded>--we treat that as
the summary. Otherwise, we assume that there isn't a summary, and return
an I<XML::Feed::Content> object with an empty string in the I<body>.

=head2 $entry->category

The category in which the entry was posted.

=head2 $entry->author

The name or email address of the person who posted the entry.

=head2 $entry->id

The unique ID of the entry.

=head2 $entry->issued

A I<DateTime> object representing the date and time at which the entry
was posted.

=head2 $entry->modified

A I<DateTime> object representing the last-modified date of the entry.

=head1 AUTHOR & COPYRIGHT

Please see the I<XML::Feed> manpage for author, copyright, and license
information.

=cut
Commit	Line	Data
fe71566d	1	# $Id: Entry.pm 942 2004-12-31 23:01:21Z btrott $
0d5e38d1	2
	3	package XML::Feed::Entry;
	4	use strict;
	5
	6	sub wrap {
	7	my $class = shift;
	8	my($item) = @_;
	9	bless { entry => $item }, $class;
	10	}
	11
	12	sub title;
	13	sub link;
	14	sub content;
	15	sub summary;
	16	sub category;
	17	sub author;
	18	sub id;
	19	sub issued;
	20	sub modified;
	21
	22	1;
	23	__END__
	24
	25	=head1 NAME
	26
	27	XML::Feed::Entry - Entry/item in a syndication feed
	28
	29	=head1 SYNOPSIS
	30
	31	## $feed is an XML::Feed object.
	32	for my $entry ($feed->entries) {
	33	print $entry->title, "\n", $entry->summary, "\n\n";
	34	}
	35
	36	=head1 DESCRIPTION
	37
	38	I<XML::Feed::Entry> represents an entry/item in an I<XML::Feed> syndication
	39	feed.
	40
	41	=head1 USAGE
	42
	43	=head2 $entry->title
	44
	45	The title of the entry.
	46
	47	=head2 $entry->link
	48
	49	The permalink of the entry, in most cases, except in cases where it points
fe71566d	50	instead to an offsite URI referenced in the entry.
0d5e38d1	51
	52	=head2 $entry->content
	53
a749d9b9	54	Bn I<XML::Feed::Content> object representing the full entry body, or as
a749d9b9	55	much as is available in the feed.
0d5e38d1	56
	57	In RSS feeds, this method will look first for
	58	I<http://purl.org/rss/1.0/modules/content/#encoded> and
	59	I<http://www.w3.org/1999/xhtml#body> elements, then fall back to a
	60	I<E<lt>descriptionE<gt>> element.
	61
	62	=head2 $entry->summary
	63
a749d9b9	64	An I<XML::Feed::Content> object representing a short summary of the entry.
a749d9b9	65	Possibly.
0d5e38d1	66
0d5e38d1	67	Since RSS feeds do not have the idea of a summary separate from the entry
a749d9b9	68	body, this may not always be what you want. If the entry contains both a
	69	I<E<lt>descriptionE<gt>> element B<and> another element typically used for
	70	the full content of the entry--either I<http://www.w3.org/1999/xhtml/body>
	71	or I<http://purl.org/rss/1.0/modules/content/#encoded>--we treat that as
	72	the summary. Otherwise, we assume that there isn't a summary, and return
	73	an I<XML::Feed::Content> object with an empty string in the I<body>.
0d5e38d1	74
	75	=head2 $entry->category
	76
	77	The category in which the entry was posted.
	78
	79	=head2 $entry->author
	80
	81	The name or email address of the person who posted the entry.
	82
	83	=head2 $entry->id
	84
	85	The unique ID of the entry.
	86
	87	=head2 $entry->issued
	88
	89	A I<DateTime> object representing the date and time at which the entry
	90	was posted.
	91
	92	=head2 $entry->modified
	93
	94	A I<DateTime> object representing the last-modified date of the entry.
	95
	96	=head1 AUTHOR & COPYRIGHT
	97
	98	Please see the I<XML::Feed> manpage for author, copyright, and license
	99	information.
	100
	101	=cut