/ 
SOAP-Data-Builder-0.8
River stage one • 3 direct dependents • 4 total dependents
/ SOAP::Data::Builder

NAME

SOAP::Data::Builder - A wrapper simplifying SOAP::Data and SOAP::Serialiser

DESCRIPTION

This Module provides a quick and easy way to build complex SOAP data
and header structures for use with SOAP::Lite.

It primarily provides a wrapper around SOAP::Serializer and SOAP::Data
(or SOAP::Header) enabling you to generate complex XML within your SOAP
request or response.

SYNOPSIS

use SOAP::Lite ( +trace => 'all', maptype => {} );

use SOAP::Data::Builder;

# create new Builder object
my $soap_data_builder = SOAP::Data::Builder->new();

#<eb:MessageHeader eb:version="2.0" SOAP:mustUnderstand="1">
$soap_data_builder->add_elem(name => 'eb:MessageHeader',
                           header=>1,
                             attributes => {"eb:version"=>"2.0", "SOAP::mustUnderstand"=>"1"});

#   <eb:From>
#        <eb:PartyId>uri:example.com</eb:PartyId>
#        <eb:Role>http://rosettanet.org/roles/Buyer</eb:Role>
#   </eb:From>
my $from = $soap_data_builder->add_elem(name=>'eb:From',
                             parent=>$soap_data_builder->get_elem('eb:MessageHeader'));

$soap_data_builder->add_elem(name=>'eb:PartyId',
                             parent=>$from,
                             value=>'uri:example.com');

$from->add_elem(name=>'eb:Role', value=>'http://path.to/roles/foo');

#   <eb:DuplicateElimination/>
$soap_data_builder->add_elem(name=>'eb:DuplicateElimination', parent=>$soap_data_builder->get_elem('eb:MessageHeader'));


# fetch Data
my $data =  SOAP::Data->name('SOAP:ENV' =>
                           \SOAP::Data->value( $soap_data_builder->to_soap_data )
                            );

# serialise Data using SOAP::Serializer
my $serialized_xml = SOAP::Serializer->autotype(0)->serialize( $data );

# serialise Data using wrapper
my $wrapper_serialised_xml = $soap_data_builder->serialise();

# make SOAP request with data

my $foo  = SOAP::Lite
    -> uri('http://www.liverez.com/SoapDemo')
    -> proxy('http://www.liverez.com/soap.pl')
    -> getTest( $soap_data_builder->to_soap_data )
    -> result;

METHODS

new(autotype=>0)

Constructor method for this class, it instantiates and returns the Builder object, taking named options as parameters

my $builder = SOAP::Data::Builder->new( autotype=>0 ); # new object with no autotyping

supported options are :

* autotype which switches on/off SOAP::Serializers autotype setting

* readable which switches on/off SOAP::Serialixer readable setting

serialise()

Wrapper for SOAP::Serializer (sic), serialises the contents of the Builder object and returns the XML as a string

# serialise Data using wrapper my $wrapper_serialised_xml = $soap_data_builder->serialise();

This method does not accept any arguments

NOTE: serialise is spelt properly using the King's English

autotype()

returns whether the object currently uses autotype when serialising

readable()

returns whether the object currently uses readable when serialising

to_soap_data()

returns the contents of the object as a list of SOAP::Data and/or SOAP::Header objects

NOTE: make sure you call this in array context!

add_elem

This method adds an element to the structure, either to the root list or a specified element.

optional parameters are : parent, value, attributes, header, isMethod

parent should be an element 'add_elem(parent=>$parent_element, .. );'

or the full name of an element 'add_elem(parent=>'name/of/parent', .. );'

value should be a string,

attributes should be a hashref : { 'ns:foo'=> bar, .. }

header should be 1 or 0 specifying whether the element should be built using SOAP::Data or SOAP::Header

returns the added element

my $bar_elem = $builder->add_elem(name=>'bar', value=>$foo->{bar}, parent=>$foo);

would produce SOAP::Data representing an XML fragment like '<foo><bar>..</bar></foo>'

get_elem('ns:elementName')

returns an element (which is an internal data structure rather than an object)

returns the first element with the name passed as an argument, sub elements can be referred to as 'grandparent/parent/element'

This structure is passed to other object methods and may change in behaviour, type or structure without warning as the class is developed

EXPORT

None.

SEE ALSO

perl

SOAP::Lite

AUTHOR

Aaron Trevena, <teejay@droogs.org>

COPYRIGHT AND LICENSE

Copyright (C) 2003 Surrey Technlogies, Ltd Copyright (C) 2004 by Aaron Trevena

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