.\" -*- 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 "XML::Stream::Node 3" .TH XML::Stream::Node 3 2023-07-25 "perl v5.38.0" "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 XML::Stream::Node \- Functions to make building and parsing the tree easier to work with. .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& Just a collection of functions that do not need to be in memory if you \&choose one of the other methods of data storage. \& \& This creates a hierarchy of Perl objects and provides various methods \&to manipulate the structure of the tree. It is much like the C library \&libxml. .Ve .SH FORMAT .IX Header "FORMAT" The result of parsing: .PP .Vb 1 \& Hello thereHowdydo .Ve .PP would be: .PP .Vb 10 \& [ tag: foo \& att: {} \& children: [ tag: head \& att: {id=>"a"} \& children: [ tag: "_\|_xmlstream_\|_:node:cdata" \& children: "Hello " \& ] \& [ tag: em \& children: [ tag: "_\|_xmlstream_\|_:node:cdata" \& children: "there" \& ] \& ] \& ] \& [ tag: bar \& children: [ tag: "_\|_xmlstream_\|_:node:cdata" \& children: "Howdy " \& ] \& [ tag: ref \& ] \& ] \& [ tag: "_\|_xmlstream_\|_:node:cdata" \& children: "do" \& ] \& ] .Ve .SH METHODS .IX Header "METHODS" .Vb 3 \& new() \- creates a new node. If you specify tag, then the root \& new(tag) tag is set. If you specify data, then cdata is added \& new(tag,cdata) to the node as well. Returns the created node. \& \& get_tag() \- returns the root tag of the node. \& \& set_tag(tag) \- set the root tag of the node to tag. \& \& add_child(node) \- adds the specified node as a child to the current \& add_child(tag) node, or creates a new node with the specified tag \& add_child(tag,cdata) as the root node. Returns the node added. \& \& remove_child(node) \- removes the child node from the current node. \& \& remove_cdata() \- removes all of the cdata children from the current node. \& \& add_cdata(string) \- adds the string as cdata onto the current nodes \& child list. \& \& get_cdata() \- returns all of the cdata children concatenated together \& into one string. \& \& get_attrib(attrib) \- returns the value of the attrib if it is valid, \& or returns undef is attrib is not a real \& attribute. \& \& put_attrib(hash) \- for each key/value pair specified, create an \& attribute in the node. \& \& remove_attrib(attrib) \- remove the specified attribute from the node. \& \& add_raw_xml(string,[string,...]) \- directly add a string into the XML \& packet as the last child, with no \& translation. \& \& get_raw_xml() \- return all of the XML in a single string, undef if there \& is no raw XML to include. \& \& remove_raw_xml() \- remove all raw XML strings. \& \& children() \- return all of the children of the node in a list. \& \& attrib() \- returns a hash containing all of the attributes on this \& node. \& \& copy() \- return a recursive copy of the node. \& \& XPath(path) \- run XML::Stream::XPath on this node. \& \& XPathCheck(path) \- run XML::Stream::XPath on this node and return 1 or 0 \& to see if it matches or not. \& \& GetXML() \- return the node in XML string form. .Ve .SH AUTHOR .IX Header "AUTHOR" By Ryan Eatmon in June 2002 for http://jabber.org/ .PP Currently maintained by Darian Anthony Patrick. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 1998\-2004 Jabber Software Foundation http://jabber.org/ .PP This module licensed under the LGPL, version 2.1.