xml::atom::entry(3pm) [debian man page]

XML::Atom::Entry(3pm)					User Contributed Perl Documentation				     XML::Atom::Entry(3pm)

NAME

       XML::Atom::Entry - Atom entry

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([ $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.

   $entry->content([ $content ])
       Returns the content of the entry. If $content is given, sets the content of the entry. Automatically handles all necessary escaping.

   $entry->author([ $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);

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

   $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);

   $entry->get($ns, $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');

   $entry->getlist($ns, $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.

perl v5.12.4							    2009-04-24						     XML::Atom::Entry(3pm)

Check Out this Related Man Page

XML::Atom::Client(3pm)					User Contributed Perl Documentation				    XML::Atom::Client(3pm)

NAME

       XML::Atom::Client - A client for the Atom API

SYNOPSIS

	   use XML::Atom::Client;
	   use XML::Atom::Entry;
	   my $api = XML::Atom::Client->new;
	   $api->username('Melody');
	   $api->password('Nelson');

	   my $entry = XML::Atom::Entry->new;
	   $entry->title('New Post');
	   $entry->content('Content of my post.');
	   my $EditURI = $api->createEntry($PostURI, $entry);

	   my $feed = $api->getFeed($FeedURI);
	   my @entries = $feed->entries;

	   my $entry = $api->getEntry($EditURI);

DESCRIPTION

       XML::Atom::Client implements a client for the Atom API described at http://bitworking.org/projects/atom/draft-gregorio-09.html, with the
       authentication scheme described at http://www.intertwingly.net/wiki/pie/DifferentlyAbledClients.

       NOTE: the API, and particularly the authentication scheme, are still in flux.

USAGE

   XML::Atom::Client->new(%param)
   $api->use_soap([ 0 | 1 ])
       XML::Atom::Client supports both the REST and SOAP-wrapper versions of the Atom API. By default, the REST version of the API will be used,
       but you can turn on the SOAP wrapper--for example, if you need to connect to a server that supports only the SOAP wrapper--by calling
       use_soap with a value of 1:

	   $api->use_soap(1);

       If called without arguments, returns the current value of the flag.

   $api->username([ $username ])
       If called with an argument, sets the username for login to $username.

       Returns the current username that will be used when logging in to the Atom server.

   $api->password([ $password ])
       If called with an argument, sets the password for login to $password.

       Returns the current password that will be used when logging in to the Atom server.

   $api->createEntry($PostURI, $entry)
       Creates a new entry.

       $entry must be an XML::Atom::Entry object.

   $api->getEntry($EditURI)
       Retrieves the entry with the given URL $EditURI.

       Returns an XML::Atom::Entry object.

   $api->updateEntry($EditURI, $entry)
       Updates the entry at URL $EditURI with the entry $entry, which must be an XML::Atom::Entry object.

       Returns true on success, false otherwise.

   $api->deleteEntry($EditURI)
       Deletes the entry at URL $EditURI.

   $api->getFeed($FeedURI)
       Retrieves the feed at $FeedURI.

       Returns an XML::Atom::Feed object representing the feed returned from the server.

   ERROR HANDLING
       Methods return "undef" on error, and the error message can be retrieved using the errstr method.

AUTHOR &; COPYRIGHT
       Please see the XML::Atom manpage for author, copyright, and license information.

perl v5.12.4							    2011-09-27						    XML::Atom::Client(3pm)

Linux and UNIX Man Pages

xml::atom::entry(3pm) [debian man page]

Check Out this Related Man Page