.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 >0, 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 .\" ======================================================================== .\" .IX Title "AnyEvent::XMPP::Node 3" .TH AnyEvent::XMPP::Node 3 2024-07-13 "perl v5.38.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 XML 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, \fR\fB$el\fR\fB, \fR\fB$attrs\fR\fB, \fR\fB$parser\fR\fB)\fR" 4 .el .IP "\fBnew ($ns, \fR\f(CB$el\fR\fB, \fR\f(CB$attrs\fR\fB, \fR\f(CB$parser\fR\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 URI \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 URI of this node. .ie n .IP "\fBeq ($namespace_or_alias, \fR\fB$name\fR\fB) or eq ($node)\fR" 4 .el .IP "\fBeq ($namespace_or_alias, \fR\f(CB$name\fR\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 URI 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 URI. .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 XML 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 XML 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 SAX 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 DOM 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`\*(C'\fR, JID: \f(CW\*(C`\*(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.