/ 
XML-Atom-Service-0.14.0
River stage one • 1 direct dependent • 3 total dependents
/ XML::Atom::Service

NAME

XML::Atom::Service - Atom Service Document object

SYNOPSIS

use XML::Atom::Service;

# use the new namespace, instead of old one 'http://purl.org/atom/app#'
#$XML::Atom::Service::DefaultNamespace = 'http://www.w3.org/2007/app';

my $categories = XML::Atom::Categories->new;
$categories->href('http://example.com/cats/forMain.cats');
$categories->add_category($category);

my $collection = XML::Atom::Collection->new;
$collection->href('http://example.org/reilly/main');
$collection->title('My Blog Entries');
$collection->add_accept('application/atom+xml;type=entry');
$collection->add_categories($categories);

my $workspace = XML::Atom::Workspace->new;
$workspace->title('Main Site');
$workspace->add_collection($collection);

my $service = XML::Atom::Service->new;
$service->add_workspace($workspace);

my $xml = $service->as_xml;

## Get lists of the workspace, collection, and categories elements.
my @workspace = $service->workspace;
my @collection = $workspace[0]->collection;
my @categories = $collection[0]->categories;


## Some elements introduced by the Atom Publishing Protocol are 
## imported into XML::Atom .
use XML::Atom::Entry;

my $entry = XML::Atom::Entry->new;

## <app:edited>2007-01-01T00:00:00Z</app:edited>
$entry->edited('2007-01-01T00:00:00Z');

## <app:control><app:draft>yes</app:draft></app:control>
my $control = XML::Atom::Control->new;
$control->draft('yes');
$entry->control($control);

## <atom:content src="..."/>
my $content = XML::Atom::Content->new( Version => 1.0 );
$content->src('http://example.com/foo.png');
$content->type('image/png');
$entry->content($content);

DESCRIPTION

For authoring to commence, a client needs to first discover the capabilities and locations of the available collections. Service Documents are designed to support this discovery process. They describe the location and capabilities of one or more Collection.

The Service Document is defined in "The Atom Publishing Protocol," IETF Internet-Draft.

METHODS

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

Creates a new Service Document 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::Service object. On failure, returns undef.

$stream can be any one of the following:

  • Reference to a scalar

    This is treated as the XML body of the feed.

  • Scalar

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

  • Filehandle

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

  • URI object

    This is treated as a URI, and the Service Document XML will be retrieved from the URI.

$service->workspace

If called in scalar context, returns an XML::Atom::Workspace object corresponding to the first <workspace> element found in the Service Document.

If called in list context, returns a list of XML::Atom::Workspace objects corresponding to all of the <workspace> elements found in the Service Document.

$service->add_workspace($workspace)

Adds the workspace $workspace, which must be an XML::Atom::Workspace object, to the Service Document as a new <workspace> element. For example:

my $workspace = XML::Atom::Workspace->new;
$workspace->title('Foo Bar');
$service->add_workspace($workspace);

$service->element_name

$service->element_ns

METHODS of XML::Atom

Some elements are introduced by the Atom Publishing Protocol, and they are imported into XML::Atom .

$entry->control([ $control ])

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

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

my $control = XML::Atom::Control->new;
$control->draft('yes');
$entry->control($control);

$entry->edited

$content->src

USING NEW NAMESPACE

By default, XML::Atom::Service and other classes (Workspace, Collection and Categories) will create entities using old namespace, 'http://purl.org/atom/app#'. In order to use the new namespace, you can set namespace by setting $XML::Atom::Service::DefaultNamespace global variable like:

use XML::Atom::Service;
$XML::Atom::Service::DefaultNamespace = 'http://www.w3.org/2007/app';

SEE ALSO

XML::Atom Atompub::Client Atompub::Server

AUTHOR

Takeru INOUE, <takeru.inoue _ gmail.com>

LICENCE AND COPYRIGHT

Copyright (c) 2007, Takeru INOUE <takeru.inoue _ gmail.com>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.