Timothy Appnel > XML-Atom-Syndication > XML::Atom::Syndication::Entry

Download:
XML-Atom-Syndication-0.942.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  3
View/Report Bugs
Source  

NAME ^

XML::Atom::Syndication::Entry - class representing an Atom entry

SYNOPSIS ^

    use XML::Atom::Syndication::Entry;
    use XML::Atom::Syndication::Text;
    use XML::Atom::Syndication::Content;
    
    # create an entry
    my $entry = XML::Atom::Syndication::Entry->new;
    my $title = XML::Atom::Syndication::Text->new(Name=>'title');
    $title->body('First Post');
    $entry->title($title);
    my $content = XML::Atom::Syndication::Content->new('Post Body');
    $entry->content($content);
    print $entry->as_xml;
    
    my $e = XML::Atom::Syndication::Entry->new('entry.atom');
    print $e->title->body."\n";

DESCRIPTION ^

XML::Atom::Syndication::Entry element represents an individual Atom entry that acts as a container for metadata and data associated with the entry. This element can appear as a child of a feed element represented by XML::Atom::Syndication::Feed, or it can appear as the document (i.e., top-level) element of a standalone Atom Entry Document.

METHODS ^

XML::Atom::Syndication::Entry is a subclass of XML::Atom::Syndication::Object (via XML::Atom::Syndication:::Thing) that it inherits numerous methods from. You should already be familiar with this base class before proceeding.

Class->new(%params)

In addition to the keys recognized by its superclass (XML::Atom::Syndication::Object) this class recognizes a Stream element. The value of this element can be a SCALAR or FILEHANDLE (GLOB) to a valid Atom document. The Stream element takes precedence over the standard Elem element.

inner_atom($atom_markup_string)

This is a convenience method for quickly setting the child Atom elements of the entry with a string. The string must also be well-formed XML. This method will replaces any existing child elements. All elements are presumed to be in the same Atom namespace as the entry object.

This method is similar to the innerHTML property found in JavaScript.

author

Indicates the author of the entry.

This accessor returns a XML::Atom::Syndication::Person object. This element can be set using a string and hash reference or by passing in an object. See Working with Object Setters in XML::Atom::Syndication::Object for more detail.

category

Conveys information about a category associated with an entry.

This accessor returns a XML::Atom::Syndication::Category object. This element can be set using a string and hash reference or by passing in an object. See Working with Object Setters in XML::Atom::Syndication::Object for more detail.

content

Contains or links to the content of the entry.

This accessor returns a XML::Atom::Syndication::Content object. This element can be set using a string and hash reference or by passing in an object. See Working with Object Setters in XML::Atom::Syndication::Object for more detail.

contributor

Indicates a person or other entity who contributed to the entry.

This accessor returns a XML::Atom::Syndication::Person object. This element can be set using a string and hash reference or by passing in an object. See Working with Object Setters in XML::Atom::Syndication::Object for more detail.

id

A permanent, universally unique identifier for an entry or feed.

This accessor returns a string. You can set this attribute by passing in an optional string.

link

Defines a reference from an entry to a Web resource.

This accessor returns a XML::Atom::Syndication::Link object. This element can be set using a string and hash reference or by passing in an object. See Working with Object Setters in XML::Atom::Syndication::Object for more detail.

published

A date indicating an instance in time associated with an event early in the life of the entry.

This accessor returns a string. You can set this attribute by passing in an optional string. Dates values MUST conform to the "date-time" production in [RFC3339].

rights

Conveys information about rights held in and over an entry or feed.

This accessor returns a XML::Atom::Syndication::Text object. This element can be set using a string and hash reference or by passing in an object. See Working with Object Setters in XML::Atom::Syndication::Object for more detail.

source

Contains meta data describing the original source of the entry.

This accessor returns a XML::Atom::Syndication::Source object. This element can be set using a string and hash reference or by passing in an object. See Working with Object Setters in XML::Atom::Syndication::Object for more detail.

summary

Conveys a short summary, abstract, or excerpt of an entry.

This accessor returns a XML::Atom::Syndication::Text object. This element can be set using a string and hash reference or by passing in an object. See Working with Object Setters in XML::Atom::Syndication::Object for more detail.

title

Conveys a human-readable title for an entry.

This accessor returns a XML::Atom::Syndication::Text object. This element can be set using a string and hash reference or by passing in an object. See Working with Object Setters in XML::Atom::Syndication::Object for more detail.

updated

The most recent instance in time when an entry or feed was modified in a way the publisher considers significant.

This accessor returns a string. You can set this attribute by passing in an optional string. Dates values MUST conform to the "date-time" production in [RFC3339].

DEPRECATED

copyright

This element was renamed rights in version 1.0 of the format.

created

This element was removed from version 1.0 of the format.

issued

This element was renamed published in version 1.0 of the format.

modified

This element was renamed updated in version 1.0 of the format.

AUTHOR & COPYRIGHT ^

Please see the XML::Atom::Syndication manpage for author, copyright, and license information.

syntax highlighting: