GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  XML::ATOM::ENTRY (3)

.ds Aq ’

NAME

XML::Atom::Entry - Atom entry

CONTENTS

SYNOPSIS



    use XML::Atom::Entry;
    my $entry = XML::Atom::Entry->new;
    $entry->title(My Post);
    $entry->content(The content of my post.);
    my $xml = $entry->as_xml;
    my $dc = XML::Atom::Namespace->new(dc => http://purl.org/dc/elements/1.1/);
    $entry->set($dc, subject, Food & Drink);



USAGE

XML::Atom::Entry->new([ CW$stream ])

Creates a new entry object, and if $stream is supplied, fills it with the data specified by $stream.

Automatically handles autodiscovery if $stream is a URI (see below).

Returns the new XML::Atom::Entry object. On failure, returns undef.

$stream can be any one of the following:
o Reference to a scalar

This is treated as the XML body of the entry.

o Scalar

This is treated as the name of a file containing the entry XML.

o Filehandle

This is treated as an open filehandle from which the entry XML can be read.

CW$entry->content([ CW$content ])

Returns the content of the entry. If $content is given, sets the content of the entry. Automatically handles all necessary escaping.

CW$entry->author([ CW$author ])

Returns an XML::Atom::Person object representing the author of the entry, or undef if there is no author information present.

If $author is supplied, it should be an XML::Atom::Person object representing the author. For example:



    my $author = XML::Atom::Person->new;
    $author->name(Foo Bar);
    $author->email(foo@bar.com);
    $entry->author($author);



CW$entry->link

If called in scalar context, returns an XML::Atom::Link object corresponding to the first <link> tag found in the entry.

If called in list context, returns a list of XML::Atom::Link objects corresponding to all of the <link> tags found in the entry.

CW$entry->add_link($link)

Adds the link $link, which must be an XML::Atom::Link object, to the entry as a new <link> tag. For example:



    my $link = XML::Atom::Link->new;
    $link->type(text/html);
    $link->rel(alternate);
    $link->href(http://www.example.com/2003/12/post.html);
    $entry->add_link($link);



CW$entry->get($ns, CW$element)

Given an XML::Atom::Namespace element $ns and an element name $element, retrieves the value for the element in that namespace.

This is useful for retrieving the value of elements not in the main Atom namespace, like categories. For example:



    my $dc = XML::Atom::Namespace->new(dc => http://purl.org/dc/elements/1.1/);
    my $subj = $entry->get($dc, subject);



CW$entry->getlist($ns, CW$element)

Just like $entry->get, but if there are multiple instances of the element $element in the namespace $ns, returns all of them. get will return only the first.

AUTHOR & COPYRIGHT

Please see the XML::Atom manpage for author, copyright, and license information.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 XML::ATOM::ENTRY (3) 2009-04-24

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.