.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "POE::Filter::XML::Node 3pm"
.TH POE::Filter::XML::Node 3pm "2014-05-10" "perl v5.18.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
POE::Filter::XML::Node \- A XML::LibXML::Element subclass that adds streaming semantics
.SH "VERSION"
.IX Header "VERSION"
version 1.140700
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use POE::Filter::XML::Node;
\&
\&    my $node = POE::Filter::XML::Node\->new(\*(Aqiq\*(Aq);
\&
\&    $node\->setAttributes(
\&        [\*(Aqto\*(Aq, \*(Aqfoo@other\*(Aq, 
\&        \*(Aqfrom\*(Aq, \*(Aqbar@other\*(Aq,
\&        \*(Aqtype\*(Aq, \*(Aqget\*(Aq]
\&    );
\&
\&    my $query = $node\->addNewChild(\*(Aqjabber:iq:foo\*(Aq, \*(Aqquery\*(Aq);
\&
\&    $query\->appendTextChild(\*(Aqfoo_tag\*(Aq, \*(Aqbar\*(Aq);
\&
\&    say $node\->toString();
\&
\&    \-\- 
\&
\&    (newlines and tabs for example only)
\&
\&    <iq to=\*(Aqfoo@other\*(Aq from=\*(Aqbar@other\*(Aq type=\*(Aqget\*(Aq>
\&        <query xmlns=\*(Aqjabber:iq:foo\*(Aq>
\&            <foo_tag>bar</foo_tag>
\&        </query>
\&    </iq>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Filter::XML::Node is a XML::LibXML::Element subclass that aims to provide
a few extra convenience methods and light integration into a streaming context.
.PP
This module can be used to create arbitrarily complex \s-1XML\s0 data structures that
know how to stringify themselves.
.SH "PUBLIC_ATTRIBUTES"
.IX Header "PUBLIC_ATTRIBUTES"
.SS "stream_[start|end]"
.IX Subsection "stream_[start|end]"
.Vb 1
\&    is: ro, isa: Bool, default: false
.Ve
.PP
These two attributes define behaviors to \fItoString()\fR for the node. In the case
of stream_start, this means dropping all children and merely leaving the tag
unterminated (eg. <start>). For stream_end, it will drop any children and treat
the tag like a terminator (eg. </end>).
.PP
Each attribute has a private writer ('_set_stream_[start|end]') if it necessary
to manipulate these attributes post construction.
.SH "PUBLIC_METHODS"
.IX Header "PUBLIC_METHODS"
.SS "override cloneNode"
.IX Subsection "override cloneNode"
.Vb 1
\&    (Bool $deep)
.Ve
.PP
cloneNode is overridden to carry forward the stream_[end|start] attributes
.SS "override toString"
.IX Subsection "override toString"
.Vb 1
\&    (Bool $formatted)
.Ve
.PP
toString was overridden to provide special stringification semantics for when
stream_start or stream_end are boolean true.
.SS "setAttributes"
.IX Subsection "setAttributes"
.Vb 1
\&    (ArrayRef $array_of_tuples)
.Ve
.PP
\&\fIsetAttributes()\fR accepts a single argument: an array reference. Basically you
pair up all the attributes you want to be into the node (ie. [attrib, value])
and this method will process them using \fIsetAttribute()\fR. This is just a 
convenience method.
.PP
If one of the attributes is 'xmlns', \fIsetNamespace()\fR will be called with the 
value used as the \f(CW$nsURI\fR argument, with no prefix, and not activated.
.PP
.Vb 8
\& eg. 
\& [\*(Aqxmlns\*(Aq, \*(Aqhttp://foo\*(Aq]
\&        |
\&        V
\& setNamespace($value, \*(Aq\*(Aq, 0)
\&        |
\&        V
\& <node xmlns="http://foo"/>
.Ve
.SS "getAttributes"
.IX Subsection "getAttributes"
.Vb 1
\&    returns (HashRef)
.Ve
.PP
This method returns all of the attribute nodes on the Element (filtering out 
namespace declarations) as a HashRef.
.ie n .SS "getFirstChildByTagName(Str $name)"
.el .SS "getFirstChildByTagName(Str \f(CW$name\fP)"
.IX Subsection "getFirstChildByTagName(Str $name)"
.Vb 1
\&    returns (Maybe[POE::Filter::XML::Node])
.Ve
.PP
This is a convenience method that basically does:
 (getChildrenByTagName($name))[0]
.SS "getChildrenHash"
.IX Subsection "getChildrenHash"
.Vb 1
\&    returns (HashRef)
.Ve
.PP
\&\fIgetChildrenHash()\fR returns a hash reference to all the children of that node.
Each key in the hash will be node name, and each value will be an array
reference with all of the children with that name.
.SH "AUTHOR"
.IX Header "AUTHOR"
Nicholas R. Perez <nperez@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2014 by Nicholas R. Perez <nperez@cpan.org>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.