lib/XML/Feed/Entry.pm

   1 # $Id: Entry.pm,v 1.1.1.1 2004/05/29 17:29:56 btrott Exp $
   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
  50 instead of an offsite URI referenced in the entry.
  51
  52 =head2 $entry->content
  53
  54 The full entry body, or as much as is available in the feed.
  55
  56 In RSS feeds, this method will look first for
  57 I<http://purl.org/rss/1.0/modules/content/#encoded> and
  58 I<http://www.w3.org/1999/xhtml#body> elements, then fall back to a
  59 I<E<lt>descriptionE<gt>> element.
  60
  61 =head2 $entry->summary
  62
  63 A short summary of the entry. Possibly.
  64
  65 Since RSS feeds do not have the idea of a summary separate from the entry
  66 body, this may return the same value as the I<$entry-E<gt>content> method.
  67 But it won't always, even with RSS feeds. For example, a number of RSS feeds
  68 use an element like I<http://purl.org/rss/1.0/modules/content/#encoded>
  69 for the entry body and put an excerpt in the I<E<lt>descriptionE<gt>> element;
  70 in those cases, this method will return the excerpt.
  71
  72 =head2 $entry->category
  73
  74 The category in which the entry was posted.
  75
  76 =head2 $entry->author
  77
  78 The name or email address of the person who posted the entry.
  79
  80 =head2 $entry->id
  81
  82 The unique ID of the entry.
  83
  84 =head2 $entry->issued
  85
  86 A I<DateTime> object representing the date and time at which the entry
  87 was posted.
  88
  89 =head2 $entry->modified
  90
  91 A I<DateTime> object representing the last-modified date of the entry.
  92
  93 =head1 AUTHOR & COPYRIGHT
  94
  95 Please see the I<XML::Feed> manpage for author, copyright, and license
  96 information.
  97
  98 =cut