DESCRIPTION

XML::TreePP module parses an XML document and expands it for a hash tree. This generates an XML document from a hash tree as the opposite way around. This is a pure Perl implementation and requires no modules depended. This can also fetch and parse an XML document from remote web server like the XMLHttpRequest object does at JavaScript language.

The special node name of #text is used because this elements has attribute(s) in addition to the text node. See also "text_node_key" option.

METHODS

new

This constructor method returns a new XML::TreePP object with %options.

$tpp = XML::TreePP->new( %options );

set

This method sets a option value for option_name. If $option_value is not defined, its option is deleted.

$tpp->set( option_name => $option_value );

See OPTIONS section below for details.

get

This method returns a current option value for option_name.

$tpp->get( 'option_name' );

parse

This method reads an XML document by string and returns a hash tree converted. The first argument is a scalar or a reference to a scalar.

$tree = $tpp->parse( $source );

parsefile

This method reads an XML document by file and returns a hash tree converted. The first argument is a filename.

$tree = $tpp->parsefile( $file );

parsehttp

This method receives an XML document from a remote server via HTTP and returns a hash tree converted.

$tree = $tpp->parsehttp( $method, $url, $body, $head );

$method is a method of HTTP connection: GET/POST/PUT/DELETE $url is an URI of an XML file. $body is a request body when you use POST method. $head is a request headers as a hash ref. LWP::UserAgent module or HTTP::Lite module is required to fetch a file.

In array context, This method returns also raw XML document received and HTTP response's status code.

write

This method parses a hash tree and returns an XML document as a string.

$source = $tpp->write( $tree, $encode );

$tree is a reference to a hash tree.

writefile

This method parses a hash tree and writes an XML document into a file.

$tpp->writefile( $file, $tree, $encode );

$file is a filename to create. $tree is a reference to a hash tree.

OPTIONS FOR PARSING XML

This module accepts option parameters following:

force_array

This option allows you to specify a list of element names which should always be forced into an array representation.

$tpp->set( force_array => [ 'rdf:li', 'item', '-xmlns' ] );

The default value is null, it means that context of the elements will determine to make array or to keep it scalar or hash. Note that the special wildcard name '*' means all elements.

force_hash

This option allows you to specify a list of element names which should always be forced into an hash representation.

$tpp->set( force_hash => [ 'item', 'image' ] );

The default value is null, it means that context of the elements will determine to make hash or to keep it scalar as a text node. See also "text_node_key" option below. Note that the special wildcard name '*' means all elements.

cdata_scalar_ref

This option allows you to convert a cdata section into a reference for scalar on parsing an XML document.

$tpp->set( cdata_scalar_ref => 1 );

The default value is false, it means that each cdata section is converted into a scalar.

user_agent

This option allows you to specify a HTTP_USER_AGENT string which is used by parsehttp() method.

$tpp->set( user_agent => 'Mozilla/4.0 (compatible; ...)' );

The default string is 'XML-TreePP/#.##', where '#.##' is substituted with the version number of this library.

A hash for <child> element above is blessed to MyElement::child class.

xml_deref

This option dereferences the numeric character references, like &#xEB;, &#28450;, etc., in an XML document when this value is true.

$tpp->set( xml_deref => 1 );

Note that, for security reasons and your convenient, this module dereferences the predefined character entity references, &amp;, &lt;, &gt;, &apos; and &quot;, and the numeric character references up to U+007F without xml_deref per default.

require_xml_decl

This option requires XML declaration at the top of XML document to parse.

$tpp->set( require_xml_decl => 1 );

This will die when <?xml .../?> declration not found.

OPTIONS FOR WRITING XML

first_out

This option allows you to specify a list of element/attribute names which should always appears at first on output XML document.

$tpp->set( first_out => [ 'link', 'title', '-type' ] );

The default value is null, it means alphabetical order is used.

last_out

This option allows you to specify a list of element/attribute names which should always appears at last on output XML document.

$tpp->set( last_out => [ 'items', 'item', 'entry' ] );

indent

This makes the output more human readable by indenting appropriately.

$tpp->set( indent => 2 );

This doesn't strictly follow the XML specification but does looks nice.

xml_decl

This module inserts an XML declaration on top of the XML document generated per default. This option forces to change it to another or just remove it.

$tpp->set( xml_decl => '' );

output_encoding

This option allows you to specify a encoding of the XML document generated by write/writefile methods.

$tpp->set( output_encoding => 'UTF-8' );

On Perl 5.8.0 and later, you can select it from every encodings supported by Encode.pm. On Perl 5.6.x and before with Jcode.pm, you can use Shift_JIS, EUC-JP, ISO-2022-JP and UTF-8. The default value is UTF-8 which is recommended encoding.

empty_element_tag_end

$tpp->set( empty_element_tag_end => '>' );

Set characters which close empty tag. The default value is ' />'.

OPTIONS FOR BOTH

utf8_flag

This makes utf8 flag on for every element's value parsed and makes it on for the XML document generated as well.

$tpp->set( utf8_flag => 1 );

Perl 5.8.1 or later is required to use this.

attr_prefix

This option allows you to specify a prefix character(s) which is inserted before each attribute names.

$tpp->set( attr_prefix => '@' );

The default character is '-'. Or set '@' to access attribute values like E4X, ECMAScript for XML. Zero-length prefix '' is available as well, it means no prefix is added.

text_node_key

This option allows you to specify a hash key for text nodes.

$tpp->set( text_node_key => '#text' );

The default key is #text.

ignore_error

This module calls Carp::croak function on an error per default. This option makes all errors ignored and just returns.

$tpp->set( ignore_error => 1 );

use_ixhash

This option keeps the order for each element appeared in XML. Tie::IxHash module is required.

$tpp->set( use_ixhash => 1 );

This makes parsing performance slow. (about 100% slower than default)

AUTHOR

Yusuke Kawasaki, http://www.kawa.net/

COPYRIGHT

The following copyright notice applies to all the files provided in this distribution, including binary files, unless explicitly noted otherwise.

Copyright 2006-2010 Yusuke Kawasaki

LICENSE

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

Module Install Instructions

To install XML::TreePP, simply copy and paste either of the commands in to your terminal