NAME¶
XML::Atom::Categories - Atom Category Document object
SYNOPSIS¶
use XML::Atom::Service;
my $category = XML::Atom::Category->new;
$category->term('joke');
$category->scheme('http://example.org/extra-cats/');
my $categories = XML::Atom::Categories->new;
$categories->add_category($category);
my $xml = $categories->as_xml;
# Get a list of the category elements.
my @category = $categories->category;
DESCRIPTION¶
Category Documents contain lists of categories described using the
"atom:category" element from the Atom Syndication Format [RFC4287].
The Category Document is defined in "The Atom Publishing Protocol,"
IETF Internet-Draft.
METHODS¶
XML::Atom::Categories->new([ $stream ])¶
Creates a new Category 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::Categories 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 Category Document.
- •
- Scalar
This is treated as the name of a file containing the Category Document
XML.
- •
- Filehandle
This is treated as an open filehandle from which the Category Document XML
can be read.
- •
- URI object
This is treated as a URI, and the Category Document XML will be retrieved
from the URI.
$categories->categoryk([ $category ])¶
If called in scalar context, returns an XML::Atom::Category object corresponding
to the first "app:category" element found in the Category Document.
If called in list context, returns a list of XML::Atom::Category objects
corresponding to all of the "app:category" elements found in the
Service Document.
$service->add_category($category)¶
Adds the category $category, which must be an XML::Atom::Category object, to the
Service Document as a new "app:category" element. For example:
my $category = XML::Atom::Category->new;
$category->term('joke');
$categories->add_category($category);
$categories->fixed¶
$categories->scheme¶
$categories->href¶
$categories->element_name¶
$categories->element_ns¶
SEE ALSO¶
XML::Atom XML::Atom::Service Atompub
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.