Sam Crawley > PRANG > PRANG::Graph::Meta::Attr

Download:
PRANG-0.17.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.17   Source  

NAME ^

PRANG::Graph::Meta::Attr - metaclass metarole for XML attributes

SYNOPSIS ^

 package My::XML::Language::Node;

 use Moose;
 use PRANG::Graph;

 has_attr 'someattr' =>
    is => "rw",
    isa => $str_subtype,
    predicate => "has_someattr",
    ;

DESCRIPTION ^

When defining a class, you mark attributes which correspond to XML attributes. To do this in a way that the PRANG marshalling machinery can use when converting to XML and back, make the attributes have this metaclass.

You could do this in principle with:

 has 'someattr' =>
    traits => ['PRANG::Attr'],
    ...

But PRANG::Graph exports a convenient shorthand for you to use.

If you like, you can also set the xmlns and xml_name attribute property, to override the default behaviour, which is to assume that the XML attribute name matches the Moose attribute name, and that the XML namespace of the attribute is empty. Note if you specify the xmlns for an attribute, it must have that namespace set, or it is not the same attribute.

If you set the xml_required property, then it is an error for the property not to be set when parsing or emitting.

Setting the xmlns attribute to * will allow any XML namespace to be set for that attribute. In this case, you should also set the xmlns_attr property, which should refer to another attribute which will record which XML namespace URI was passed in. This introduces a potential ambiguity; the same attribute may be passed in multiple times, with different XML namespaces.

You can also set xml_isa, which currently if set will not check the type constraint against the input on marshall in. In the future it will specify the type constraint to apply at marshall in time, instead of waiting for the constructor to apply one.

SEE ALSO ^

PRANG::Graph::Meta::Class, PRANG::Graph::Meta::Element

AUTHOR AND LICENCE ^

Development commissioned by NZ Registry Services, and carried out by Catalyst IT - http://www.catalyst.net.nz/

Copyright 2009, 2010, NZ Registry Services. This module is licensed under the Artistic License v2.0, which permits relicensing under other Free Software licenses.

syntax highlighting: