Nils Diewald > XML-Loy-0.26 > XML::Loy

Download:
XML-Loy-0.26.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.26   Source  

NAME ^

XML::Loy - Extensible XML Reader and Writer

SYNOPSIS ^

  use XML::Loy;

  # Create new document with root node
  my $xml = XML::Loy->new('env');

  # Add elements to the document
  my $header = $xml->add('header');

  # Nest elements
  $header->add('greetings')->add(title => 'Hello!');

  # Append elements with attributes and textual data
  $xml->add(body => { date => 'today' })->add(p => "That's all!");

  # Use CSS3 selectors for element traversal
  $xml->at('title')->attr(style => 'color: red');

  # Attach comments
  $xml->at('greetings')->comment('My Greeting');

  # Print with pretty indentation
  print $xml->to_pretty_xml;

  # <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  # <env>
  #   <header>
  #
  #       <!-- My Greeting -->
  #       <greetings>
  #         <title style="color: red">Hello!</title>
  #       </greetings>
  #     </header>
  #     <body date="today">
  #       <p>That&#39;s all!</p>
  #     </body>
  #   </env>

DESCRIPTION ^

XML::Loy allows for the simple creation of small serialized XML documents with various namespaces. It focuses on simplicity and extensibility, while giving you the full power of Mojo::DOM.

This module is an early release! There may be significant changes in the future.

METHODS ^

XML::Loy inherits all explicit methods from Mojo::DOM and implements the following new ones.

new

  my $xml = XML::Loy->new(<<'EOF');
  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <entry>
    <fun>Yeah!</fun>
  <entry>
  EOF

  $xml = XML::Loy->new('Document');
  $xml = XML::Loy->new(Document => { foo => 'bar' });
  my $xml_new = $xml->new(Document => {id => 'new'} => 'My Content');

Constructs a new XML::Loy document. Accepts either all parameters supported by Mojo::DOM or all parameters supported by add.

add

  my $xml = XML::Loy->new('Document');

  # Add an empty element
  $xml->add('Element');

  # Add elements with attributes
  my $elem = $xml->add(Element => { type => 'text/plain' });

  # Add nested elements with textual content
  $elem->add(Child => "I'm a child element");

  # Add elements with attributes, textual content, and a comment
  $xml->add(p => { id => 'id_4' }, 'Hello!', 'My Comment!');

  # Add elements with rules for pretty printing
  $xml->add(Data => { -type => 'armour' }, 'PdGzjvj..');

  # Add XML::Loy objects
  $elem = $xml->new(Element => 'Hello World!');
  $xml->add($elem);

Adds a new element to a XML::Loy document, either as another XML::Loy object or newly defined. Returns the root node of the added XML::Loy document.

Parameters to define elements are a tag name, followed by an optional hash reference including all attributes of the XML element, an optional textual content, and an optional comment on the element (if the comment should be introduced to an empty element, text content has to be undef).

For giving directives for rendering element content with pretty printing, a special -type attribute can be defined:

set

  my $xml = XML::Loy->new('Document');
  $xml->set(Element => { id => 5 });

  # Overwrite
  $xml->set(Element => { id => 6 });

Adds a new element as a child to the node only once. Accepts all parameters as defined in add.

If one or more elements with the same tag name are already children of the requesting node, the old elements will be deleted and comments will be merged if possible.

comment

  $node = $node->comment('Resource Descriptor');

Prepends a comment to the current node. If a node already has a comment, comments will be merged.

extension

  # Add extensions
  my $xml = $xml->extension('Fun', 'XML::Loy::Atom', -HostMeta);

  # Further additions
  $xml->extension(-Atom::Threading);

  my @extensions = $xml->extension;

Adds or returns an array of extensions. When adding, returns the document. When getting, returns the array of associated extensions.

The extensions are associated to the document, they are not associated to the object. That means, you can't add extensions to documents without a root node.

With this package the following extensions are bundled: Atom, Atom-Threading, ActivityStreams, GeoRSS, OStatus, XRD, and HostMeta. If an extension has a leading minus symbol, it is assumed to be located in the XML::Loy namespace, making XML::Loy::Atom and -Atom equivalent.

See Extensions for further information.

Note: The return value of the extension method is experimental and may change without warnings.

as

  my $xml = XML::Loy->new('<XRD><Subject>akron</Subject></XRD>');
  my $xrd = $xml->as(-XRD, -HostMeta);

  $xrd->alias('acct:akron@sojolicio.us');

  print $xrd->to_pretty_xml;

  # <XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"
  #      xmlns:hm="http://host-meta.net/xrd/1.0"
  #      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  #   <Subject>akron</Subject>
  #   <Alias>acct:akron@sojolicio.us</Alias>
  # </XRD>

Convert an XML::Loy based object to another object. Accepts the base class and optionally a list of extensions. This only changes the namespace of the base class - extensions will stay intact.

See Extensions for further information.

Note: This method is experimental and may change without warnings!

mime

  print $xml->mime;

The mime type associated with the object class. See Extensions for further information.

namespace

  my $xml = XML::Loy->new('doc');
  $xml->namespace('http://sojolicio.us/ns/global');
  $xml->namespace(fun => 'http://sojolicio.us/ns/fun');
  $xml->add('fun:test' => { foo => 'bar' }, 'Works!');
  print $xml->namespace;

  print $xml->to_pretty_xml;

  # <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  # <doc xmlns="http://sojolicio.us/global"
  #      xmlns:fun="http://sojolicio.us/fun">
  #   <fun:test foo="bar">Works!</fun:test>
  # </doc>

Returns the namespace of the node or adds namespace information to the node's root. When adding, the first parameter gives the prefix, the second one the namespace. The prefix parameter is optional. Namespaces are always added to the document's root, that means, they have to be unique in the scope of the whole document.

to_pretty_xml

  print $xml->to_pretty_xml;
  print $xml->to_pretty_xml(2);

Returns a stringified, pretty printed XML document. Optionally accepts a numerical parameter, defining the start of indentation (defaults to 0).

EXTENSIONS ^

  package Fun;
  use XML::Loy with => (
    prefix    => 'fun',
    namespace => 'http://sojolicio.us/ns/fun',
    mime      => 'application/fun+xml'
  );

  # Add new methods to the object
  sub add_happy {
    my $self = shift;
    my $word = shift;

    my $cool = $self->add('-Cool');
    my $cry  = uc($word) . '!!! \o/ ';
    $cool->add(Happy => {foo => 'bar'}, $cry);
  };

XML::Loy allows for inheritance and thus provides two ways of extending the functionality: By using a derived class as a base class or by extending a base class with the extension method.

With this package the following extensions are bundled: Atom, Atom-Threading, ActivityStreams, GeoRSS, OStatus, XRD, and HostMeta.

For the purpose of extension, three attributes can be set when XML::Loy is used (introduced with the keyword with).

You can use derived objects in your application as you would do with any other object class.

  package main;
  use Fun;
  my $obj = Fun->new('Fun');
  $obj->add_happy('Yeah!');
  print $obj->to_pretty_xml;

  # <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  # <Fun xmlns="http://sojolicio.us/ns/fun">
  #   <Cool>
  #     <Happy foo="bar">YEAH!!!! \o/ </Happy>
  #   </Cool>
  # </Fun>

The defined namespace is introduced as the document's namespace. The prefix is not in use for derived classes.

Without any changes to the class, you can use this module as an extension to another XML::Loy based document as well.

  use XML::Loy;

  my $obj = XML::Loy->new('object');

  # Use XML::Loy based class 'Fun'
  $obj->extension('Fun');

  # Use methods provided by the base class or any extension
  $obj->add_happy('Yeah!');

  # Print with pretty indentation
  print $obj->to_pretty_xml;

  # <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  # <object xmlns:fun="http://sojolicio.us/ns/fun">
  #   <Cool>
  #     <fun:Happy foo="bar">YEAH!!!! \o/ </fun:Happy>
  #   </Cool>
  # </object>

The defined namespace of Fun is introduced with the prefix fun. The prefix is prepended to all elements added by the add and set methods in the extension class. To prevent this prefixing, prepend the element name with a - (like with <-Cool /> in the example above).

Derived classes are always strict and utf8, use warnings and import all features of Perl 5.10.

DEPENDENCIES ^

Mojolicious, Test::Warn (for testing).

CAVEATS ^

XML::Loy focuses on the comfortable handling of small documents of serialized data and the ease of extensibility. It is - as well as the underlying parser - written in pure perl and not intended to be the fastest thing out there (although I believe there's plenty of space for optimization). That said - it may not suit all your needs, but there are loads of excellent XML libraries out there, you can give a try then. Just to name a few: For fast parsing of huge documents, try XML::Twig. For validation and the availability of lots of tools from the XML world, try XML::LibXML. For simple deserialization, try XML::Bare and XML::Fast. For similar scope, but without dependencies aside the core, try XML::MyXML.

AVAILABILITY ^

  https://github.com/Akron/XML-Loy

COPYRIGHT AND LICENSE ^

Copyright (C) 2011-2014, Nils Diewald.

This program is free software, you can redistribute it and/or modify it under the same terms as Perl.

syntax highlighting: