1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
|
# $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 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);
}
for my $field (qw( category )) {
my @val = $entry->$field();
next unless @val;
$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 L<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 ])
An L<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
L<http://purl.org/rss/1.0/modules/content/#encoded> and
L<http://www.w3.org/1999/xhtml#body> elements, then fall back to a
I<E<lt>descriptionE<gt>> element.
=head2 $entry->summary([ $summary ])
An L<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 L<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 L<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 (alias) 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
|