See METHODS in XML::Compile
See Constructors in XML::Compile
Option | Defined in | Default |
---|---|---|
allow_undeclared | <false> | |
any_element | 'ATTEMPT' | |
block_namespace | XML::Compile::Schema | [] |
hook | XML::Compile::Schema |
|
hooks | XML::Compile::Schema | [] |
ignore_unused_tags | XML::Compile::Schema | <false> |
key_rewrite | XML::Compile::Schema | [] |
opts_readers | [] | |
opts_rw | [] | |
opts_writers | [] | |
parser_options | XML::Compile | <many> |
prefixes | <smart> | |
schema_dirs | XML::Compile |
|
typemap | {} | |
xsi_type | {} |
[1.01] add global xsi_type declarations. Returns the xsiType set. The ARRAY or LIST contains pairs, just like the HASH.
The value component can be 'AUTO' to automatically detect the xsi:type
extensions. This does only work for complex types.
Whether it is permitted to create readers and writers which are not declared cleanly.
[as method since 0.99] How to process ANY elements, see also new(any_element).
Reader: ATTEMPT
will convert all any elements, applying the reader for
each element found. When an element is not found in a schema, it will
be included as XML::LibXML::Element node.
[0.93] Reader: With SLOPPY
, first automatic typed conversion is
attempted. But is the type is not known, XML::LibXML::Simple subroutine XMLin
is called to the resque.
[0.98] Add global knowledge on typemaps. Returns the typemap.
The cache layer on top of XML::Compile::Schema adds smart use of prefixes. Of course, smartness comes with a small performance cost, but the code gets much cleaner.
[1.03] Register NAMESPACE -if not yet defined- with prefix name BASE. When that prefix name is already in use for some other namespace, BASE followed by a number are attempted (starting with 01). The prefix is returned.
When the BASE already ends on a number, that number will get counted.
my $prefix = $schema->addNicePrefix('call', $myns); # $prefix now can be call, call01, call02 etc
The X::C logic does auto-detect prefix/namespaces combinations from the XML, but does not search extensively for namespace declarations. Also, sometimes the same namespace is used with different prefixes. Sometimes, the same prefix is used for different namesapces. To complete the list, or control the actual prefix being used, you explicitly declare combinations.
The best way to add prefixes is via new(prefixes), which will give
your names preference over the names found in the schema's which get loaded.
For instance, use < ::WSDL->new(prefixes =
[ $prefix => $ns ] >>
[0.995] Returns the HASH with prefix to name-space translations. You should not modify the returned HASH: new PAIRS of prefix to namespace relations can be passed as arguments.
[0.14] If a name-space appears for the second time, then the new prefix will be recognized by findName(), but not used in the output. When the prefix already exists for a different namespace, then an error will be casted.
[0.90] You may also provide an ARRAY of pairs or a HASH.
[0.993] Take all the prefixes defined in the $node, and XML::LibXML::Element. This is not recursive: only on those defined at the top $node.
Lookup a prefix definition. This returns a HASH with namespace info.
Lookup the preferred prefix for the $uri.
Translate the fully qualified $type into a prefixed version. Will produce undef if the namespace is unknown.
[0.993] When your $type is not in packed form, you can specify a namespace and $local type name as separate arguments.
print $schema->prefixed($type) || $type; print $schema->prefixed($ns, $local);
Return prefixes table. The $params are deprecated since [0.995], see addPrefixes().
The name of this module refers to its power to administer compiled XML encoders (writers) and decoders (readers). This means that your program only need to pass on a ::Cache object (for instance a XML::Compile::WSDL11, not a CODE reference for each compiled translator.
[0.99] You may provide global compile options with new(opts_rw),
opts_readers
and opts_writers
, but also later using this method.
Compile all the declared readers and writers with the default 'RW'). You may also select to pre-compile only the READERS or only the WRITERS. The selection can be limited further by specifying a $ns.
By default, the processors are only compiled when used. This method is especially useful in a daemon process, where preparations can take as much time as they want to... and running should be as fast as possible.
Returns the reader CODE for the $type or $name (see findName()). %options are only permitted if new(allow_undeclared) is true, and the same as the previous call to this method.
The reader will be compiled the first time that it is used, and that same CODE reference will be returned each next request for the same $type. Call compileAll() to have all readers compiled by force.
Option | Default |
---|---|
is_type | <false> |
my $schema = XML::Compile::Cache->new(\@xsd, prefixes => [ gml => $GML_NAMESPACE ] ); my $data = $schema->reader('gml:members')->($xml); my $getmem = $schema->reader('gml:members'); my $data = $getmem->($xml);
Returns the writer CODE for the $type or $name (see findName()). OPTIONS are only permitted if new(allow_undeclared) is true, and the same as the previous call to this method.
The writer will be compiled the first time that it is used, and that same CODE reference will be returned each next request for the same type.
Option | Default |
---|---|
is_type | <false> |
my $xml = $cache->writer('gml:members')->($doc, $data); my $doc = XML::LibXML::Document->new('1.0', 'UTF-8'); my $wr = $cache->writer('gml:members'); my $xml = $wr->($doc, $data); $doc->setDocumentElement($xml); print $doc->toString(1);
Register that the indicated $type (or ARRAY of them) may be used, and needs to be translated with the %options (either specified as ARRAY or PAIRS). Specify whether it may get used as READER, WRITER, or both (RW). If the READER and WRITER need different options, then you need to declare them separately; in that case you cannot use RW.
The $type should be understood by findName(), so may be prefixed.
$cache->declare(READER => 'pref:count', sloppy_integers => 1) ->declare(RW => '{myns}mylocal'); $cache->declare(WRITER => [ 'xsd:int', '{http://}aap' ]);
Translate the $name specification into a schema defined full type.
The $name can be a full type (like '{namespace}localname', usually
created with XML::Compile::Util::pack_type()) or a prefixed type
(like 'myns:localname', where myns
is defined via new(prefixes)
or prefixes()).
When the form is 'myns:' (so without local name), the namespace uri is returned.
$schema->addPrefixes(pre => 'http://namespace'); my $type = $schema->findName('pre:name'); print $type; # {http://namespace}name my $ns = $schema->findName('pre:'); print $ns; # http://namespace my $type = $schema->findName('{somens}name'); print $type; # {somens}name [a no-op]
Option | Default |
---|---|
show_declared | <true> |