Yuriy Ustushenko > XML-Hash-XS-0.21 > XML::Hash::XS

Download:
XML-Hash-XS-0.21.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.21   Source   Latest Release: XML-Hash-XS-0.26

NAME ^

XML::Hash::XS - Simple and fast hash to XML conversion

SYNOPSIS ^

    use XML::Hash::XS;

    my $xmlstr = hash2xml \%hash;
    hash2xml \%hash, output => $FH;

Or OOP way:

    use XML::Hash::XS qw();

    my $conv = XML::Hash::XS->new([<options>])
    my $xmlstr = $conv->hash2xml(\%hash, [<options>]);

DESCRIPTION ^

This module implements simple hash to XML converter written in C using libxml2 library.

FUNCTIONS ^

hash2xml $hash, [ %options ]

$hash is reference to hash

    hash2xml
        {
            node1 => 'value1',
            node2 => [ 'value21', { node22 => 'value22' } ],
            node3 => \'value3',
            node4 => sub { return 'value4' },
            node5 => sub { return { node51 => 'value51' } },
        },
        canonical => 1,
        indent    => 2,
    ;

will convert to:

    <?xml version="1.0" encoding="utf-8"?>
    <root>
      <node1>value1</node1>
      <node2>value21</node2>
      <node2>
        <node22>value22</node22>
      </node2>
      <node3>value3</node3>
      <node4>value4</node4>
      <node5>
        <node51>value51</node51>
      </node5>
    </root>

and (use_attr=1):

    hash2xml
        {
            node1 => 'value1',
            node2 => [ 'value21', { node22 => 'value22' } ],
            node3 => \'value3',
            node4 => sub { return 'value4' },
            node5 => sub { return { node51 => 'value51' } },
        },
        use_attr  => 1,
        canonical => 1,
        indent    => 2,
    ;

will convert to:

    <?xml version="1.0" encoding="utf-8"?>
    <root node1="value1" node3="value3" node4="value4">
      <node2>value21</node2>
      <node2 node22="value22"/>
      <node5 node51="value51"/>
    </root>

Compose benchmark:

                    Rate    Hash Hash::LX Simple Hash::XS(LX) Hash::XS Hash::XS(OOP)
    Hash          34.6/s      --     -10%   -38%         -99%     -99%          -99%
    Hash::LX      38.5/s     11%       --   -31%         -98%     -99%          -99%
    Simple        56.0/s     62%      46%     --         -98%     -98%          -98%
    Hash::XS(LX)  2381/s   6781%    6088%  4152%           --     -33%          -36%
    Hash::XS      3571/s  10221%    9182%  6279%          50%       --           -4%
    Hash::XS(OOP) 3704/s  10604%    9526%  6515%          56%       4%            --

Benchmark was done on http://search.cpan.org/uploads.rdf

OPTIONS ^

doc [ => 0 ]

if doc is '1', then returned value is XML::LibXML::Document.

root [ = 'root' ]

Root node name.

version [ = '1.0' ]

XML document version

encoding [ = 'utf-8' ]

XML output encoding

indent [ = 0 ]

if indent great than "0", XML output should be indented according to its hierarchic structure. This value determines the number of spaces.

if indent is "0", XML output will all be on one line.

output [ = undef ]

XML output method

if output is undefined, XML document dumped into string.

if output is FH, XML document writes directly to a filehandle or a stream.

canonical [ = 0 ]

if canonical is "1", converter will be write hashes sorted by key.

if canonical is "0", order of the element will be pseudo-randomly.

use_attr [ = 0 ]

if use_attr is "1", converter will be use the attributes.

if use_attr is "0", converter will be use tags only.

content [ = undef ]

if defined that the key name for the text content(used only if use_attr=1).

xml_decl [ = 1 ]

if xml_decl is "1", output will start with the XML declaration '<?xml version="1.0" encoding="utf-8"?>'.

if xml_decl is "0", XML declaration will not be output.

content [ = undef ]

if defined this options spicify a key name for storing text

method [ = 'NATIVE' ]

experimental support the conversion methods other libraries

if method is 'LX' then conversion result is the same as using XML::Hash::LX library

Note: for 'LX' method following options are available: encoding attr text trim cdata comm

AUTHOR ^

Yuriy Ustushenko, <<yoreek@yahoo.com>>

COPYRIGHT AND LICENSE ^

Copyright (C) 2013 Yuriy Ustushenko

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

syntax highlighting: