SOAP::WSDL::Generator::PrefixResolver (3)

Leading comments

Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/SOAP::WSDL::Generator::PrefixResolver.3pm".)

NAME

SOAP::WSDL::Generator::PrefixResolver - prefixes for different classes

SYNOPSIS

If you want to create your custom prefix resolver:

 package MyPrefixResolver;
 use strict; use warnings;
 use base qw(SOAP::WSDL::Generator::PrefixResolver);

 sub resolve_prefix {
     my ($self, $type, $namespace, $node) = @_;
     # return something special
     return $self->SUPER::resolve_prefix($type, $namespace, $node);
 }

When generating code:

 use MyPrefixResolver;
 use SOAP::WSDL::Generator::XSD;
 my $generator = SOAP::WSDL::Generator::Template::XSD->new({
    prefix_resolver_class => 'MyPrefixResolver',
 });

DESCRIPTION

Prefix resolver class for 's code generator. You may subclass it to apply some custom prefix resolving logic.

Subclasses must implement the following methods:

*

resolve_prefix

 sub resolve_prefix {
    my ($self, $namespace, $node) = @_;
    # ...
 }

resolve_prefix is expected to return a (perl class) prefix. It is called with the following parameters:

 NAME       DESCRIPTION
 -----------------------------------------------------------------------------
 type       One of (server|interface|typemap|type|element|attribute)
 namespace  The targetNamespace of the node to generate a prefix for.
 node       The node to generate a prefix for

You usually just need type and namespace for prefix resolving. node is provided for rather funky setups, where you have to choose different prefixes based on type names or whatever.

Node may be of any of the following classes:

 SOAP::WSDL::Service
 SOAP::WSDL::XSD::Attribute
 SOAP::WSDL::XSD::Element
 SOAP::WSDL::XSD::Type

Note that both namespace and node may be undef - you should test for definedness before doing anything fancy with them.

If you want your prefixes to represent perl class hierarchies, they should end with '::'.

Example:

Imagine you're generating interfaces for the Acme Pet Shop. Acme Corp. has set up their datatypes to be global across all interfaces (and products), while elements are local to the product (the Pet Shop in the example). All elements are in the urn:Acme namespace.

In addition, there are types in the namespace urn:Acme:Goods, which should go into the same namespace as types, but be prefixed with 'Goods_'

You may want prefixes (roughly) like this:

 Interfaces:        Acme::Client::PetShop::
 Server:            Acme::Server::PetShop::
 Types:             Acme::Types::
 Types (Goods):     Acme::Types::Goods_
 Elements:          Acme::Elements::PetShop::
 Typemaps:          Acme::Typemaps::PetShop::

BUGS AND LIMITATIONS

You cannot suffix your types by some rule yet...

LICENSE AND COPYRIGHT

Copyright 2008 Martin Kutter.

This file is part of SOAP-WSDL. You may distribute/modify it under the same terms as perl itself

AUTHOR

Martin Kutter <martin.kutter fen-net.de>

REPOSITORY INFORMATION

 $Rev: 583 $
 $LastChangedBy: kutterma $
 $Id: $
 $HeadURL: $