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

# $Id: Entry.pm 1872 2005-08-12 04:28:42Z btrott $

package XML::Feed::Entry;
use strict;
use base qw( Class::ErrorHandler );

use Scalar::Util qw( blessed );

use Carp;

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

sub unwrap { $_[0]->{entry} }

sub new {
    my $class = shift;
    my($format) = @_;
    $format ||= 'Atom';
    my $format_class = 'XML::Feed::' . $format;
    eval "use $format_class";
    Carp::croak("Unsupported format $format: $@") if $@;
    my $entry = bless {}, join('::', __PACKAGE__, $format);
    $entry->init_empty or return $class->error($entry->errstr);
    $entry;
}

sub init_empty { 1 }

sub convert {
    my $entry = shift;
    my($format) = @_;
    my $new = __PACKAGE__->new($format);
    for my $field (qw( title link content summary category author id issued modified lat long )) {
        my $val = $entry->$field();
        next unless defined $val;
        next if blessed $val && $val->isa('XML::Feed::Content') && ! defined $val->body;
        $new->$field($val);
    }
    $new;
}

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

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 XML::Feed::Entry->new($format)

Creates a new I<XML::Feed::Entry> object in the format I<$format>, which
should be either I<RSS> or I<Atom>.

=head2 $entry->convert($format)

Converts the I<XML::Feed::Entry> object into the I<$format> format, and
returns the new object.

=head2 $entry->title([ $title ])

The title of the entry.

=head2 $entry->link([ $uri ])

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([ $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([ $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([ $category ])

The category in which the entry was posted.

=head2 $entry->author([ $author ])

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

=head2 $entry->id([ $id ])

The unique ID of the entry.

=head2 $entry->issued([ $issued ])

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

If present, I<$issued> should be a I<DateTime> object.

=head2 $entry->modified([ $modified ])

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

If present, I<$modified> should be a I<DateTime> object.

=head1 AUTHOR & COPYRIGHT

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

=cut
Commit	Line	Data
23103173	1	# $Id: Entry.pm 1872 2005-08-12 04:28:42Z btrott $
0d5e38d1	2
	3	package XML::Feed::Entry;
	4	use strict;
973e1f9e	5	use base qw( Class::ErrorHandler );
973e1f9e	6
566afdf5	7	use Scalar::Util qw( blessed );
566afdf5	8
973e1f9e	9	use Carp;
0d5e38d1	10
	11	sub wrap {
	12	my $class = shift;
	13	my($item) = @_;
	14	bless { entry => $item }, $class;
	15	}
	16
973e1f9e	17	sub unwrap { $_[0]->{entry} }
	18
	19	sub new {
	20	my $class = shift;
	21	my($format) = @_;
	22	$format \|\|= 'Atom';
	23	my $format_class = 'XML::Feed::' . $format;
	24	eval "use $format_class";
	25	Carp::croak("Unsupported format $format: $@") if $@;
	26	my $entry = bless {}, join('::', __PACKAGE__, $format);
	27	$entry->init_empty or return $class->error($entry->errstr);
	28	$entry;
	29	}
	30
	31	sub init_empty { 1 }
	32
	33	sub convert {
	34	my $entry = shift;
	35	my($format) = @_;
	36	my $new = __PACKAGE__->new($format);
9a36f82c	37	for my $field (qw( title link content summary category author id issued modified lat long )) {
23103173	38	my $val = $entry->$field();
23103173	39	next unless defined $val;
566afdf5	40	next if blessed $val && $val->isa('XML::Feed::Content') && ! defined $val->body;
23103173	41	$new->$field($val);
973e1f9e	42	}
	43	$new;
	44	}
	45
0d5e38d1	46	sub title;
	47	sub link;
	48	sub content;
	49	sub summary;
	50	sub category;
	51	sub author;
	52	sub id;
	53	sub issued;
	54	sub modified;
9a36f82c	55	sub lat;
9a36f82c	56	sub long;
0d5e38d1	57
	58	1;
	59	__END__
	60
	61	=head1 NAME
	62
	63	XML::Feed::Entry - Entry/item in a syndication feed
	64
	65	=head1 SYNOPSIS
	66
	67	## $feed is an XML::Feed object.
	68	for my $entry ($feed->entries) {
	69	print $entry->title, "\n", $entry->summary, "\n\n";
	70	}
	71
	72	=head1 DESCRIPTION
	73
	74	I<XML::Feed::Entry> represents an entry/item in an I<XML::Feed> syndication
	75	feed.
	76
	77	=head1 USAGE
	78
973e1f9e	79	=head2 XML::Feed::Entry->new($format)
	80
	81	Creates a new I<XML::Feed::Entry> object in the format I<$format>, which
	82	should be either I<RSS> or I<Atom>.
	83
	84	=head2 $entry->convert($format)
	85
	86	Converts the I<XML::Feed::Entry> object into the I<$format> format, and
	87	returns the new object.
	88
	89	=head2 $entry->title([ $title ])
0d5e38d1	90
	91	The title of the entry.
	92
973e1f9e	93	=head2 $entry->link([ $uri ])
0d5e38d1	94
0d5e38d1	95	The permalink of the entry, in most cases, except in cases where it points
fe71566d	96	instead to an offsite URI referenced in the entry.
0d5e38d1	97
973e1f9e	98	=head2 $entry->content([ $content ])
0d5e38d1	99
a749d9b9	100	Bn I<XML::Feed::Content> object representing the full entry body, or as
a749d9b9	101	much as is available in the feed.
0d5e38d1	102
	103	In RSS feeds, this method will look first for
	104	I<http://purl.org/rss/1.0/modules/content/#encoded> and
	105	I<http://www.w3.org/1999/xhtml#body> elements, then fall back to a
	106	I<E<lt>descriptionE<gt>> element.
	107
973e1f9e	108	=head2 $entry->summary([ $summary ])
0d5e38d1	109
a749d9b9	110	An I<XML::Feed::Content> object representing a short summary of the entry.
a749d9b9	111	Possibly.
0d5e38d1	112
0d5e38d1	113	Since RSS feeds do not have the idea of a summary separate from the entry
a749d9b9	114	body, this may not always be what you want. If the entry contains both a
	115	I<E<lt>descriptionE<gt>> element B<and> another element typically used for
	116	the full content of the entry--either I<http://www.w3.org/1999/xhtml/body>
	117	or I<http://purl.org/rss/1.0/modules/content/#encoded>--we treat that as
	118	the summary. Otherwise, we assume that there isn't a summary, and return
	119	an I<XML::Feed::Content> object with an empty string in the I<body>.
0d5e38d1	120
973e1f9e	121	=head2 $entry->category([ $category ])
0d5e38d1	122
	123	The category in which the entry was posted.
	124
973e1f9e	125	=head2 $entry->author([ $author ])
0d5e38d1	126
	127	The name or email address of the person who posted the entry.
	128
973e1f9e	129	=head2 $entry->id([ $id ])
0d5e38d1	130
	131	The unique ID of the entry.
	132
973e1f9e	133	=head2 $entry->issued([ $issued ])
0d5e38d1	134
	135	A I<DateTime> object representing the date and time at which the entry
	136	was posted.
	137
973e1f9e	138	If present, I<$issued> should be a I<DateTime> object.
	139
	140	=head2 $entry->modified([ $modified ])
0d5e38d1	141
	142	A I<DateTime> object representing the last-modified date of the entry.
	143
973e1f9e	144	If present, I<$modified> should be a I<DateTime> object.
973e1f9e	145
0d5e38d1	146	=head1 AUTHOR & COPYRIGHT
	147
	148	Please see the I<XML::Feed> manpage for author, copyright, and license
	149	information.
	150
	151	=cut