.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "AnyEvent::XMPP::Node 3pm"
.TH AnyEvent::XMPP::Node 3pm "2012-01-23" "perl v5.14.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"
AnyEvent::XMPP::Node \- XML node tree helper for the parser.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&   use AnyEvent::XMPP::Node;
\&   ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represens a \s-1XML\s0 node. AnyEvent::XMPP should usually not
require messing with the parse tree, but sometimes it is neccessary.
.PP
If you experience any need for messing with these and feel AnyEvent::XMPP should
rather take care of it drop me a mail, feature request or most preferably a patch!
.PP
Every AnyEvent::XMPP::Node has a namespace, attributes, text and child nodes.
.PP
You can access these with the following methods:
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "\fBnew ($ns, \fB$el\fB, \f(BI$attrs\fB, \f(CB$parser\fB)\fR" 4
.el .IP "\fBnew ($ns, \f(CB$el\fB, \f(CB$attrs\fB, \f(CB$parser\fB)\fR" 4
.IX Item "new ($ns, $el, $attrs, $parser)"
Creates a new AnyEvent::XMPP::Node object with the node tag name \f(CW$el\fR in the
namespace \s-1URI\s0 \f(CW$ns\fR and the attributes \f(CW$attrs\fR. The \f(CW$parser\fR must be
the instance of \f(CW\*(C`AnyEvent::XMPP::Parser\*(C'\fR which generated this node.
.IP "\fBname\fR" 4
.IX Item "name"
The tag name of this node.
.IP "\fBnamespace\fR" 4
.IX Item "namespace"
Returns the namespace \s-1URI\s0 of this node.
.ie n .IP "\fBeq ($namespace_or_alias, \fB$name\fB) or eq ($node)\fR" 4
.el .IP "\fBeq ($namespace_or_alias, \f(CB$name\fB) or eq ($node)\fR" 4
.IX Item "eq ($namespace_or_alias, $name) or eq ($node)"
Returns true whether the current element matches the tag name \f(CW$name\fR
in the namespaces pointed at by \f(CW$namespace_or_alias\fR.
.Sp
You can either pass an alias that was defined in AnyEvent::XMPP::Namespaces
or pass an namespace \s-1URI\s0 in \f(CW$namespace_or_alias\fR. If no alias with the name
\&\f(CW$namespace_or_alias\fR was found in AnyEvent::XMPP::Namespaces it will be
interpreted as namespace \s-1URI\s0.
.Sp
The first argument to eq can also be another AnyEvent::XMPP::Node instance.
.IP "\fBeq_ns ($namespace_or_alias) or eq_ns ($node)\fR" 4
.IX Item "eq_ns ($namespace_or_alias) or eq_ns ($node)"
This method return true if the namespace of this instance of AnyEvent::XMPP::Node
matches the namespace described by \f(CW$namespace_or_alias\fR or the
namespace of the \f(CW$node\fR which has to be another AnyEvent::XMPP::Node instance.
.Sp
See \f(CW\*(C`eq\*(C'\fR for the meaning of \f(CW$namespace_or_alias\fR.
.IP "\fBattr ($name)\fR" 4
.IX Item "attr ($name)"
Returns the contents of the \f(CW$name\fR attribute.
.IP "\fBadd_node ($node)\fR" 4
.IX Item "add_node ($node)"
Adds a sub-node to the current node.
.IP "\fBnodes\fR" 4
.IX Item "nodes"
Returns a list of sub nodes.
.IP "\fBadd_text ($string)\fR" 4
.IX Item "add_text ($string)"
Adds character data to the current node.
.IP "\fBtext\fR" 4
.IX Item "text"
Returns the text for this node.
.IP "\fBfind_all (@path)\fR" 4
.IX Item "find_all (@path)"
This method does a recursive descent through the sub-nodes and
fetches all nodes that match the last element of \f(CW@path\fR.
.Sp
The elements of \f(CW@path\fR consist of a array reference to an array with
two elements: the namespace key known by the \f(CW$parser\fR and the tagname
we search for.
.IP "\fBwrite_on ($writer)\fR" 4
.IX Item "write_on ($writer)"
This writes the current node out to the AnyEvent::XMPP::Writer object in \f(CW$writer\fR.
.IP "\fBas_string ()\fR" 4
.IX Item "as_string ()"
This method returns the original character representation of this \s-1XML\s0 element
(and it's children nodes). Please note that the string is a unicode string,
meaning: to get octets use:
.Sp
.Vb 1
\&   my $octets = encode (\*(AqUTF\-8\*(Aq, $node\->as_string);
.Ve
.Sp
Now you can roll stunts like this:
.Sp
.Vb 2
\&   my $libxml = XML::LibXML\->new;
\&   my $doc    = $libxml\->parse_string (encode (\*(AqUTF\-8\*(Aq, $node\->as_string ()));
.Ve
.Sp
(You can use your favorite \s-1XML\s0 parser :)
.IP "\fBappend_raw ($string)\fR" 4
.IX Item "append_raw ($string)"
This method is called by the parser to store original strings of this element.
.IP "\fBto_sax_events ($handler)\fR" 4
.IX Item "to_sax_events ($handler)"
This method takes anything that can receive \s-1SAX\s0 events.
See also XML::GDOME::SAX::Builder or XML::Handler::BuildDOM
or XML::LibXML::SAX::Builder.
.Sp
With this you can convert this node to any \s-1DOM\s0 level 2 structure you want:
.Sp
.Vb 4
\&   my $builder = XML::LibXML::SAX::Builder\->new;
\&   $node\->to_sax_events ($builder);
\&   my $dom = $builder\->result;
\&   print "Canonized: " . $dom\->toStringC14N . "\en";
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Robin Redeker, \f(CW\*(C`<elmex at ta\-sa.org>\*(C'\fR, \s-1JID:\s0 \f(CW\*(C`<elmex at jabber.org>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2007, 2008 Robin Redeker, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.