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

# $Id$

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::' . $format;
    eval "use $format_class";
    Carp::croak("Unsupported format $format: $@") if $@;
    my $entry = bless {}, join('::', __PACKAGE__, "Format", $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;
sub format;
sub tags { shift->category(@_) }
sub enclosure;

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

The url base 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.

Returns a list of categories if called in array context or the first
category if called in scalar context.

B<WARNING> It's possible this API might change to have an 
I<add_category> instead.

=head2 $entry->tags([ $tag ])

A synonym for I<category>;

=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.

=head2 $entry->wrap

Take an entry in its native format and turn it into an I<XML::Feed::Entry> object.

=head2 $entry->unwrap

Take an I<XML::Feed::Entry> object and turn it into its native format.

=head1 AUTHOR & COPYRIGHT

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

=cut
Commit	Line	Data
3353d70c	1	# $Id$
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';
729cd7a8	23	my $format_class = 'XML::Feed::Format::' . $format;
973e1f9e	24	eval "use $format_class";
973e1f9e	25	Carp::croak("Unsupported format $format: $@") if $@;
729cd7a8	26	my $entry = bless {}, join('::', __PACKAGE__, "Format", $format);
973e1f9e	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;
3bdbab6f	57	sub format;
a0cca2a4	58	sub tags { shift->category(@_) }
12a4079f	59	sub enclosure;
0d5e38d1	60
	61	1;
	62	__END__
	63
	64	=head1 NAME
	65
	66	XML::Feed::Entry - Entry/item in a syndication feed
	67
	68	=head1 SYNOPSIS
	69
	70	## $feed is an XML::Feed object.
	71	for my $entry ($feed->entries) {
	72	print $entry->title, "\n", $entry->summary, "\n\n";
	73	}
	74
	75	=head1 DESCRIPTION
	76
	77	I<XML::Feed::Entry> represents an entry/item in an I<XML::Feed> syndication
	78	feed.
	79
	80	=head1 USAGE
	81
973e1f9e	82	=head2 XML::Feed::Entry->new($format)
	83
	84	Creates a new I<XML::Feed::Entry> object in the format I<$format>, which
	85	should be either I<RSS> or I<Atom>.
	86
	87	=head2 $entry->convert($format)
	88
	89	Converts the I<XML::Feed::Entry> object into the I<$format> format, and
	90	returns the new object.
	91
	92	=head2 $entry->title([ $title ])
0d5e38d1	93
	94	The title of the entry.
	95
5383a560	96	=head2 $entry->base([ $base ])
	97
	98	The url base of the entry.
	99
973e1f9e	100	=head2 $entry->link([ $uri ])
0d5e38d1	101
0d5e38d1	102	The permalink of the entry, in most cases, except in cases where it points
fe71566d	103	instead to an offsite URI referenced in the entry.
0d5e38d1	104
973e1f9e	105	=head2 $entry->content([ $content ])
0d5e38d1	106
a749d9b9	107	Bn I<XML::Feed::Content> object representing the full entry body, or as
a749d9b9	108	much as is available in the feed.
0d5e38d1	109
	110	In RSS feeds, this method will look first for
	111	I<http://purl.org/rss/1.0/modules/content/#encoded> and
	112	I<http://www.w3.org/1999/xhtml#body> elements, then fall back to a
	113	I<E<lt>descriptionE<gt>> element.
	114
973e1f9e	115	=head2 $entry->summary([ $summary ])
0d5e38d1	116
a749d9b9	117	An I<XML::Feed::Content> object representing a short summary of the entry.
a749d9b9	118	Possibly.
0d5e38d1	119
0d5e38d1	120	Since RSS feeds do not have the idea of a summary separate from the entry
a749d9b9	121	body, this may not always be what you want. If the entry contains both a
	122	I<E<lt>descriptionE<gt>> element B<and> another element typically used for
	123	the full content of the entry--either I<http://www.w3.org/1999/xhtml/body>
	124	or I<http://purl.org/rss/1.0/modules/content/#encoded>--we treat that as
	125	the summary. Otherwise, we assume that there isn't a summary, and return
	126	an I<XML::Feed::Content> object with an empty string in the I<body>.
0d5e38d1	127
973e1f9e	128	=head2 $entry->category([ $category ])
0d5e38d1	129
	130	The category in which the entry was posted.
	131
a0cca2a4	132	Returns a list of categories if called in array context or the first
	133	category if called in scalar context.
	134
a759e13e	135	B<WARNING> It's possible this API might change to have an
	136	I<add_category> instead.
	137
a0cca2a4	138	=head2 $entry->tags([ $tag ])
	139
	140	A synonym for I<category>;
	141
973e1f9e	142	=head2 $entry->author([ $author ])
0d5e38d1	143
	144	The name or email address of the person who posted the entry.
	145
973e1f9e	146	=head2 $entry->id([ $id ])
0d5e38d1	147
	148	The unique ID of the entry.
	149
973e1f9e	150	=head2 $entry->issued([ $issued ])
0d5e38d1	151
	152	A I<DateTime> object representing the date and time at which the entry
	153	was posted.
	154
973e1f9e	155	If present, I<$issued> should be a I<DateTime> object.
	156
	157	=head2 $entry->modified([ $modified ])
0d5e38d1	158
	159	A I<DateTime> object representing the last-modified date of the entry.
	160
973e1f9e	161	If present, I<$modified> should be a I<DateTime> object.
973e1f9e	162
8c30ad3d	163	=head2 $entry->wrap
	164
	165	Take an entry in its native format and turn it into an I<XML::Feed::Entry> object.
	166
	167	=head2 $entry->unwrap
	168
	169	Take an I<XML::Feed::Entry> object and turn it into its native format.
	170
0d5e38d1	171	=head1 AUTHOR & COPYRIGHT
	172
	173	Please see the I<XML::Feed> manpage for author, copyright, and license
	174	information.
	175
	176	=cut