XML::LibXML::NodeList

Section: User Contributed Perl Documentation (3)
Updated: 2003-11-07
Index Return to Main Contents
 

NAME

XML::LibXML::NodeList - a list of XML document nodes  

DESCRIPTION

An XML::LibXML::NodeList object contains an ordered list of nodes, as detailed by the W3C DOM documentation of Node Lists.  

SYNOPSIS

  my $results = $dom->findnodes('//somepath');
  foreach my $context ($results->get_nodelist) {
    my $newresults = $context->findnodes('./other/element');
    ...
  }

 

API

 

new()

You will almost never have to create a new NodeSet object, as it is all done for you by XPath.  

get_nodelist()

Returns a list of nodes, the contents of the node list, as a perl list.  

string_value()

Returns the string-value of the first node in the list. See the XPath specification for what ``string-value'' means.  

to_literal()

Returns the concatenation of all the string-values of all the nodes in the list.  

get_node($pos)

Returns the node at $pos. The node position in XPath is based at 1, not 0.  

size()

Returns the number of nodes in the NodeSet.  

pop()

Equivalent to perl's pop function.  

push(@nodes)

Equivalent to perl's push function.  

append($nodelist)

Given a nodelist, appends the list of nodes in $nodelist to the end of the current list.  

shift()

Equivalent to perl's shift function.  

unshift(@nodes)

Equivalent to perl's unshift function.  

prepend($nodeset)

Given a nodelist, prepends the list of nodes in $nodelist to the front of the current list.  

iterator()

Will return a new nodelist iterator for the current nodelist. A nodelist iterator is usefull if more complex nodelist processing is needed.


 

Index

NAME
DESCRIPTION
SYNOPSIS
API
new()
get_nodelist()
string_value()
to_literal()
get_node($pos)
size()
pop()
push(@nodes)
append($nodelist)
shift()
unshift(@nodes)
prepend($nodeset)
iterator()

linux.jgfs.net manual pages