Class: Nokogiri::XML::Node

### Home Classes Methods

### In Files

- lib/nokogiri/xml/node.rb
- lib/nokogiri/xml/node/save_options.rb
- ext/nokogiri/html_document.c

### Parent

Object

### Namespace

- CLASS Nokogiri::XML::Node::SaveOptions

### Methods

- ::new
- #%
- #/
- #<<
- #<=>
- #==
- #>
- #[]
- #[]=
- #accept
- #add_child
- #add_namespace
- #add_namespace_definition
- #add_next_sibling
- #add_previous_sibling
- #after
- #ancestors
- #at
- #at_css
- #at_xpath
- #attr
- #attribute
- #attribute_nodes
- #attribute_with_ns
- #attributes
- #before
- #blank?
- #canonicalize
- #cdata?
- #child
- #children
- #children=
- #clone
- #comment?
- #content
- #content=
- #create_external_subset
- #create_internal_subset
- #css
- #css_path
- #decorate!
- #default_namespace=
- #delete
- #description
- #do_xinclude
- #document
- #dup
- #each
- #elem?
- #element?
- #element_children
- #elements
- #encode_special_chars
- #external_subset
- #first_element_child
- #fragment
- #fragment?
- #get_attribute
- #has_attribute?
- #html?
- #inner_html
- #inner_html=
- #inner_text
- #internal_subset
- #key?
- #keys
- #last_element_child
- #line
- #matches?
- #name
- #name=
- #namespace
- #namespace=
- #namespace_definitions
- #namespace_scopes
- #namespaced_key?
- #namespaces
- #native_content=
- #next
- #next_element
- #next_sibling
- #node_name
- #node_name=
- #node_type
- #parent
- #parent=
- #parse
- #path
- #pointer_id
- #previous
- #previous=
- #previous_element
- #previous_sibling
- #read_only?
- #remove
- #remove_attribute
- #replace
- #search
- #serialize
- #set_attribute
- #swap
- #text
- #text?
- #to_html
- #to_s
- #to_str
- #to_xhtml
- #to_xml
- #traverse
- #type
- #unlink
- #values
- #write_html_to
- #write_to
- #write_xhtml_to
- #write_xml_to
- #xml?
- #xpath

### Included Modules

- Nokogiri::XML::PP::Node
- Enumerable

### Files

- CHANGELOG.ja.rdoc
- CHANGELOG.rdoc
- C_CODING_STYLE.rdoc
- Manifest.txt
- README.ja.rdoc
- README.rdoc

### Class/Module Index

Quicksearch

- Nokogiri
- Nokogiri::CSS
- Nokogiri::CSS::Node
- Nokogiri::CSS::Parser
- Nokogiri::CSS::SyntaxError
- Nokogiri::CSS::Tokenizer
- Nokogiri::CSS::Tokenizer::ScanError
- Nokogiri::Decorators
- Nokogiri::Decorators::Slop
- Nokogiri::EncodingHandler
- Nokogiri::HTML
- Nokogiri::HTML::Builder
- Nokogiri::HTML::Document
- Nokogiri::HTML::Document::EncodingReader
- Nokogiri::HTML::Document::EncodingReader::JumpSAXHandler
- Nokogiri::HTML::DocumentFragment
- Nokogiri::HTML::ElementDescription
- Nokogiri::HTML::EntityDescription
- Nokogiri::HTML::EntityLookup
- Nokogiri::HTML::SAX
- Nokogiri::HTML::SAX::Parser
- Nokogiri::HTML::SAX::ParserContext
- Nokogiri::HTML::SAX::PushParser
- Nokogiri::SyntaxError
- Nokogiri::XML
- Nokogiri::XML::Attr
- Nokogiri::XML::AttributeDecl
- Nokogiri::XML::Builder
- Nokogiri::XML::CDATA
- Nokogiri::XML::CharacterData
- Nokogiri::XML::Comment
- Nokogiri::XML::DTD
- Nokogiri::XML::Document
- Nokogiri::XML::DocumentFragment
- Nokogiri::XML::Element
- Nokogiri::XML::ElementContent
- Nokogiri::XML::ElementDecl
- Nokogiri::XML::EntityDecl
- Nokogiri::XML::EntityReference
- Nokogiri::XML::Namespace
- Nokogiri::XML::Node
- Nokogiri::XML::Node::SaveOptions
- Nokogiri::XML::NodeSet
- Nokogiri::XML::Notation
- Nokogiri::XML::PP
- Nokogiri::XML::PP::CharacterData
- Nokogiri::XML::PP::Node
- Nokogiri::XML::ParseOptions
- Nokogiri::XML::ProcessingInstruction
- Nokogiri::XML::Reader
- Nokogiri::XML::RelaxNG
- Nokogiri::XML::SAX
- Nokogiri::XML::SAX::Document
- Nokogiri::XML::SAX::Parser
- Nokogiri::XML::SAX::Parser::Attribute
- Nokogiri::XML::SAX::ParserContext
- Nokogiri::XML::SAX::PushParser
- Nokogiri::XML::Schema
- Nokogiri::XML::SyntaxError
- Nokogiri::XML::Text
- Nokogiri::XML::XPath
- Nokogiri::XML::XPath::SyntaxError
- Nokogiri::XML::XPathContext
- Nokogiri::XSLT
- Nokogiri::XSLT::Stylesheet
- XSD
- XSD::XMLParser
- XSD::XMLParser::Nokogiri
- Object

No matching classes.

# Nokogiri::XML::Node

Nokogiri::XML::Node is your window to the fun filled world of dealing with XML and HTML tags. A Nokogiri::XML::Node may be treated similarly to a hash with regard to attributes. For example (from irb):

    irb(main):004:0> node
    => <a href="#foo" id="link">link</a>
    irb(main):005:0> node['href']
    => "#foo"
    irb(main):006:0> node.keys
    => ["href", "id"]
    irb(main):007:0> node.values
    => ["#foo", "link"]
    irb(main):008:0> node['class'] = 'green'
    => "green"
    irb(main):009:0> node
    => <a href="#foo" id="link" class="green">link</a>
    irb(main):010:0>

See Nokogiri::XML::Node#[] and Nokogiri::XML#[]= for more information.

Nokogiri::XML::Node also has methods that let you move around your tree. For navigating your tree, see:

- Nokogiri::XML::Node#parent

- Nokogiri::XML::Node#children

- Nokogiri::XML::Node#next

- Nokogiri::XML::Node#previous

You may search this node’s subtree using Node#xpath and Node#css

### Constants

ATTRIBUTE_DECL

  Attribute declaration type

ATTRIBUTE_NODE

  Attribute node type

CDATA_SECTION_NODE

  CDATA node type, see Nokogiri::XML::Node#cdata?

COMMENT_NODE

  Comment node type, see Nokogiri::XML::Node#comment?

DOCB_DOCUMENT_NODE

  DOCB document node type

DOCUMENT_FRAG_NODE

  Document fragment node type

DOCUMENT_NODE

  Document node type, see Nokogiri::XML::Node#xml?

DOCUMENT_TYPE_NODE

  Document type node type

DTD_NODE

  DTD node type

ELEMENT_DECL

  Element declaration type

ELEMENT_NODE

  Element node type, see Nokogiri::XML::Node#element?

ENTITY_DECL

  Entity declaration type

ENTITY_NODE

  Entity node type

ENTITY_REF_NODE

  Entity reference node type

HTML_DOCUMENT_NODE

  HTML document node type, see Nokogiri::XML::Node#html?

NAMESPACE_DECL

  Namespace declaration type

NOTATION_NODE

  Notation node type

PI_NODE

  PI node type

TEXT_NODE

  Text node type, see Nokogiri::XML::Node#text?

XINCLUDE_END

  XInclude end type

XINCLUDE_START

  XInclude start type

### Public Class Methods

new(name, document) click to toggle source

Create a new node with `name` sharing GC lifecycle with `document`

    static VALUE new(int argc, VALUE *argv, VALUE klass)
    {
      xmlDocPtr doc;
      xmlNodePtr node;
      VALUE name;
      VALUE document;
      VALUE rest;
      VALUE rb_node;

      rb_scan_args(argc, argv, "2*", &name, &document, &rest);

      Data_Get_Struct(document, xmlDoc, doc);

      node = xmlNewNode(NULL, (xmlChar *)StringValuePtr(name));
      node->doc = doc->doc;
      nokogiri_root_node(node);

      rb_node = Nokogiri_wrap_xml_node(
          klass == cNokogiriXmlNode ? (VALUE)NULL : klass,
          node
      );
      rb_obj_call_init(rb_node, argc, argv);

      if(rb_block_given_p()) rb_yield(rb_node);

      return rb_node;
    }

### Public Instance Methods

%(path, ns = document.root ? document.root.namespaces : {}) click to toggle source
Alias for: at
/(*paths) click to toggle source
Alias for: search
<<(node_or_tags) click to toggle source

Add `node_or_tags` as a child of this Node. `node_or_tags` can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.

Returns self, to support chaining of calls (e.g., root << child1 << child2)

Also see related method `add_child`.

    # File lib/nokogiri/xml/node.rb, line 287
    def << node_or_tags
      add_child node_or_tags
      self
    end

<=>(other) click to toggle source

Compare two Node objects with respect to their Document. Nodes from different documents cannot be compared.

    # File lib/nokogiri/xml/node.rb, line 831
    def <=> other
      return nil unless other.is_a?(Nokogiri::XML::Node)
      return nil unless document == other.document
      compare other
    end

==(other) click to toggle source

Test to see if this Node is equal to `other`

    # File lib/nokogiri/xml/node.rb, line 696
    def == other
      return false unless other
      return false unless other.respond_to?(:pointer_id)
      pointer_id == other.pointer_id
    end

>(selector) click to toggle source

Search this node’s immediate children using CSS selector `selector`

    # File lib/nokogiri/xml/node.rb, line 219
    def > selector
      ns = document.root.namespaces
      xpath CSS.xpath_for(selector, :prefix => "./", :ns => ns).first
    end

[](name) click to toggle source

Get the attribute value for the attribute `name`

    # File lib/nokogiri/xml/node.rb, line 253
    def [] name
      get(name.to_s)
    end

Also aliased as: get_attribute, attr
[]=(name, value) click to toggle source

Set the attribute value for the attribute `name` to `value`

    # File lib/nokogiri/xml/node.rb, line 259
    def []= name, value
      set name.to_s, value.to_s
    end

Also aliased as: set_attribute
accept(visitor) click to toggle source

Accept a visitor. This method calls “visit” on `visitor` with self.

    # File lib/nokogiri/xml/node.rb, line 690
    def accept visitor
      visitor.visit(self)
    end

add_child(node_or_tags) click to toggle source

Add `node_or_tags` as a child of this Node. `node_or_tags` can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.

Returns the reparented node (if `node_or_tags` is a Node), or NodeSet (if `node_or_tags` is a DocumentFragment, NodeSet, or string).

Also see related method +<<+.

    # File lib/nokogiri/xml/node.rb, line 270
    def add_child node_or_tags
      node_or_tags = coerce(node_or_tags)
      if node_or_tags.is_a?(XML::NodeSet)
        node_or_tags.each { |n| add_child_node_and_reparent_attrs n }
      else
        add_child_node_and_reparent_attrs node_or_tags
      end
      node_or_tags
    end

add_namespace(p1, p2) click to toggle source
Alias for: add_namespace_definition
add_namespace_definition(prefix, href) click to toggle source

Adds a namespace definition with `prefix` using `href` value. The result is as if parsed XML for this node had included an attribute ‘xmlns:prefix=value’. A default namespace for this node (“xmlns=”) can be added by passing ‘nil’ for prefix. Namespaces added this way will not show up in attributes, but they will be included as an xmlns attribute when the node is serialized to XML.

    static VALUE add_namespace_definition(VALUE self, VALUE prefix, VALUE href)
    {
      xmlNodePtr node, namespacee;
      xmlNsPtr ns;

      Data_Get_Struct(self, xmlNode, node);
      namespacee = node ;

      ns = xmlSearchNs(
          node->doc,
          node,
          (const xmlChar *)(NIL_P(prefix) ? NULL : StringValuePtr(prefix))
      );

      if(!ns) {
        if (node->type != XML_ELEMENT_NODE) {
          namespacee = node->parent;
        }
        ns = xmlNewNs(
            namespacee,
            (const xmlChar *)StringValuePtr(href),
            (const xmlChar *)(NIL_P(prefix) ? NULL : StringValuePtr(prefix))
        );
      }

      if (!ns) return Qnil ;

      if(NIL_P(prefix) || node != namespacee) xmlSetNs(node, ns);

      return Nokogiri_wrap_xml_namespace(node->doc, ns);
    }

Also aliased as: add_namespace
add_next_sibling(node_or_tags) click to toggle source

Insert `node_or_tags` after this Node (as a sibling). `node_or_tags` can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.

Returns the reparented node (if `node_or_tags` is a Node), or NodeSet (if `node_or_tags` is a DocumentFragment, NodeSet, or string).

Also see related method `after`.

    # File lib/nokogiri/xml/node.rb, line 311
    def add_next_sibling node_or_tags
      raise ArgumentError.new("A document may not have multiple root nodes.") if parent.is_a?(XML::Document)

      add_sibling :next, node_or_tags
    end

add_previous_sibling(node_or_tags) click to toggle source

Insert `node_or_tags` before this Node (as a sibling). `node_or_tags` can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.

Returns the reparented node (if `node_or_tags` is a Node), or NodeSet (if `node_or_tags` is a DocumentFragment, NodeSet, or string).

Also see related method `before`.

    # File lib/nokogiri/xml/node.rb, line 298
    def add_previous_sibling node_or_tags
      raise ArgumentError.new("A document may not have multiple root nodes.") if parent.is_a?(XML::Document) && !node_or_tags.is_a?(XML::ProcessingInstruction)

      add_sibling :previous, node_or_tags
    end

Also aliased as: previous=
after(node_or_tags) click to toggle source

Insert `node_or_tags` after this node (as a sibling). `node_or_tags` can be a Nokogiri::XML::Node, a Nokogiri::XML::DocumentFragment, or a string containing markup.

Returns self, to support chaining of calls.

Also see related method `add_next_sibling`.

    # File lib/nokogiri/xml/node.rb, line 336
    def after node_or_tags
      add_next_sibling node_or_tags
      self
    end

ancestors(selector = nil) click to toggle source

Get a list of ancestor Node for this Node. If `selector` is given, the ancestors must match `selector`

    # File lib/nokogiri/xml/node.rb, line 631
    def ancestors selector = nil
      return NodeSet.new(document) unless respond_to?(:parent)
      return NodeSet.new(document) unless parent

      parents = [parent]

      while parents.last.respond_to?(:parent)
        break unless ctx_parent = parents.last.parent
        parents << ctx_parent
      end

      return NodeSet.new(document, parents) unless selector

      root = parents.last

      NodeSet.new(document, parents.find_all { |parent|
        root.search(selector).include?(parent)
      })
    end

at(path, ns = document.root ? document.root.namespaces : {}) click to toggle source

Search for the first occurrence of `path`.

Returns nil if nothing is found, otherwise a Node.

    # File lib/nokogiri/xml/node.rb, line 228
    def at path, ns = document.root ? document.root.namespaces : {}
      search(path, ns).first
    end

Also aliased as: %
at_css(*rules) click to toggle source

Search this node for the first occurrence of CSS `rules`. Equivalent to `css(rules).first` See Node#css for more information.

    # File lib/nokogiri/xml/node.rb, line 247
    def at_css *rules
      css(*rules).first
    end

at_xpath(*paths) click to toggle source

Search this node for the first occurrence of XPath `paths`. Equivalent to `xpath(paths).first` See Node#xpath for more information.

    # File lib/nokogiri/xml/node.rb, line 238
    def at_xpath *paths
      xpath(*paths).first
    end

attr(name) click to toggle source
Alias for: []
attribute(name) click to toggle source

Get the attribute node with `name`

    static VALUE attr(VALUE self, VALUE name)
    {
      xmlNodePtr node;
      xmlAttrPtr prop;
      Data_Get_Struct(self, xmlNode, node);
      prop = xmlHasProp(node, (xmlChar *)StringValuePtr(name));

      if(! prop) return Qnil;
      return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)prop);
    }

attribute_nodes() click to toggle source

returns a list containing the Node attributes.

    static VALUE attribute_nodes(VALUE self)
    {
        /* this code in the mode of xmlHasProp() */
        xmlNodePtr node;
        VALUE attr;

        Data_Get_Struct(self, xmlNode, node);

        attr = rb_ary_new();
        Nokogiri_xml_node_properties(node, attr);

        return attr ;
    }

attribute_with_ns(name, namespace) click to toggle source

Get the attribute node with `name` and `namespace`

    static VALUE attribute_with_ns(VALUE self, VALUE name, VALUE namespace)
    {
      xmlNodePtr node;
      xmlAttrPtr prop;
      Data_Get_Struct(self, xmlNode, node);
      prop = xmlHasNsProp(node, (xmlChar *)StringValuePtr(name),
          NIL_P(namespace) ? NULL : (xmlChar *)StringValuePtr(namespace));

      if(! prop) return Qnil;
      return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)prop);
    }

attributes() click to toggle source

Returns a hash containing the node’s attributes. The key is the attribute name without any namespace, the value is a Nokogiri::XML::Attr representing the attribute. If you need to distinguish attributes with the same name, with different namespaces use attribute_nodes instead.

    # File lib/nokogiri/xml/node.rb, line 442
    def attributes
      Hash[attribute_nodes.map { |node|
        [node.node_name, node]
      }]
    end

before(node_or_tags) click to toggle source

Insert `node_or_tags` before this node (as a sibling). `node_or_tags` can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.

Returns self, to support chaining of calls.

Also see related method `add_previous_sibling`.

    # File lib/nokogiri/xml/node.rb, line 324
    def before node_or_tags
      add_previous_sibling node_or_tags
      self
    end

blank? click to toggle source

Is this node blank?

    static VALUE blank_eh(VALUE self)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);
      return (1 == xmlIsBlankNode(node)) ? Qtrue : Qfalse ;
    }

canonicalize(mode=XML::XML_C14N_1_0,inclusive_namespaces=nil,with_comments=false) click to toggle source

    # File lib/nokogiri/xml/node.rb, line 851
    def canonicalize(mode=XML::XML_C14N_1_0,inclusive_namespaces=nil,with_comments=false)
      c14n_root = self
      document.canonicalize(mode, inclusive_namespaces, with_comments) do |node, parent|
        tn = node.is_a?(XML::Node) ? node : parent
        tn == c14n_root || tn.ancestors.include?(c14n_root)
      end
    end

cdata?() click to toggle source

Returns true if this is a CDATA

    # File lib/nokogiri/xml/node.rb, line 564
    def cdata?
      type == CDATA_SECTION_NODE
    end

child click to toggle source

Returns the child node

    static VALUE child(VALUE self)
    {
      xmlNodePtr node, child;
      Data_Get_Struct(self, xmlNode, node);

      child = node->children;
      if(!child) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, child);
    }

children click to toggle source

Get the list of children for this node as a NodeSet

    static VALUE children(VALUE self)
    {
      xmlNodePtr node;
      xmlNodePtr child;
      xmlNodeSetPtr set;
      VALUE document;
      VALUE node_set;

      Data_Get_Struct(self, xmlNode, node);

      child = node->children;
      set = xmlXPathNodeSetCreate(child);

      document = DOC_RUBY_OBJECT(node->doc);

      if(!child) return Nokogiri_wrap_xml_node_set(set, document);

      child = child->next;
      while(NULL != child) {
        xmlXPathNodeSetAddUnique(set, child);
        child = child->next;
      }

      node_set = Nokogiri_wrap_xml_node_set(set, document);

      return node_set;
    }

children=(node_or_tags) click to toggle source

Set the inner html for this Node `node_or_tags` `node_or_tags` can be a Nokogiri::XML::Node, a Nokogiri::XML::DocumentFragment, or a string containing markup.

Returns the reparented node (if `node_or_tags` is a Node), or NodeSet (if `node_or_tags` is a DocumentFragment, NodeSet, or string).

Also see related method `inner_html=`

    # File lib/nokogiri/xml/node.rb, line 360
    def children= node_or_tags
      node_or_tags = coerce(node_or_tags)
      children.unlink
      if node_or_tags.is_a?(XML::NodeSet)
        node_or_tags.each { |n| add_child_node_and_reparent_attrs n }
      else
        add_child_node_and_reparent_attrs node_or_tags
      end
      node_or_tags
    end

clone(p1 = v1) click to toggle source
Alias for: dup
comment?() click to toggle source

Returns true if this is a Comment

    # File lib/nokogiri/xml/node.rb, line 559
    def comment?
      type == COMMENT_NODE
    end

content click to toggle source

Returns the content for this Node

    static VALUE get_content(VALUE self)
    {
      xmlNodePtr node;
      xmlChar * content;

      Data_Get_Struct(self, xmlNode, node);

      content = xmlNodeGetContent(node);
      if(content) {
        VALUE rval = NOKOGIRI_STR_NEW2(content);
        xmlFree(content);
        return rval;
      }
      return Qnil;
    }

Also aliased as: text, inner_text
content=(string) click to toggle source

Set the Node’s content to a Text node containing `string`. The string gets XML escaped, not interpreted as markup.

    # File lib/nokogiri/xml/node.rb, line 520
    def content= string
      self.native_content = encode_special_chars(string.to_s)
    end

create_external_subset(name, external_id, system_id) click to toggle source

Create an external subset

    static VALUE create_external_subset(VALUE self, VALUE name, VALUE external_id, VALUE system_id)
    {
      xmlNodePtr node;
      xmlDocPtr doc;
      xmlDtdPtr dtd;

      Data_Get_Struct(self, xmlNode, node);

      doc = node->doc;

      if(doc->extSubset)
        rb_raise(rb_eRuntimeError, "Document already has an external subset");

      dtd = xmlNewDtd(
          doc,
          NIL_P(name)        ? NULL : (const xmlChar *)StringValuePtr(name),
          NIL_P(external_id) ? NULL : (const xmlChar *)StringValuePtr(external_id),
          NIL_P(system_id)   ? NULL : (const xmlChar *)StringValuePtr(system_id)
      );

      if(!dtd) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)dtd);
    }

create_internal_subset(name, external_id, system_id) click to toggle source

Create the internal subset of a document.

    doc.create_internal_subset("chapter", "-//OASIS//DTD DocBook XML//EN", "chapter.dtd")
    # => <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML//EN" "chapter.dtd">

    doc.create_internal_subset("chapter", nil, "chapter.dtd")
    # => <!DOCTYPE chapter SYSTEM "chapter.dtd">

    static VALUE create_internal_subset(VALUE self, VALUE name, VALUE external_id, VALUE system_id)
    {
      xmlNodePtr node;
      xmlDocPtr doc;
      xmlDtdPtr dtd;

      Data_Get_Struct(self, xmlNode, node);

      doc = node->doc;

      if(xmlGetIntSubset(doc))
        rb_raise(rb_eRuntimeError, "Document already has an internal subset");

      dtd = xmlCreateIntSubset(
          doc,
          NIL_P(name)        ? NULL : (const xmlChar *)StringValuePtr(name),
          NIL_P(external_id) ? NULL : (const xmlChar *)StringValuePtr(external_id),
          NIL_P(system_id)   ? NULL : (const xmlChar *)StringValuePtr(system_id)
      );

      if(!dtd) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)dtd);
    }

css *rules, [namespace-bindings, custom-pseudo-class] click to toggle source

Search this node for CSS `rules`. `rules` must be one or more CSS selectors. For example:

    node.css('title')
    node.css('body h1.bold')
    node.css('div + p.green', 'div#one')

A hash of namespace bindings may be appended. For example:

    node.css('bike|tire', {'bike' => 'http://schwinn.com/'})

Custom CSS pseudo classes may also be defined. To define custom pseudo classes, create a class and implement the custom pseudo class you want defined. The first argument to the method will be the current matching NodeSet. Any other arguments are ones that you pass in. For example:

    node.css('title:regex("\w+")', Class.new {
      def regex node_set, regex
        node_set.find_all { |node| node['some_attribute'] =~ /#{regex}/ }
      end
    }.new)

Note that the CSS query string is case-sensitive with regards to your document type. That is, if you’re looking for “H1” in an HTML document, you’ll never find anything, since HTML tags will match only lowercase CSS queries. However, “H1” might be found in an XML document, where tags names are case-sensitive (e.g., “H1” is distinct from “h1”).

    # File lib/nokogiri/xml/node.rb, line 205
    def css *rules
      rules, handler, ns, binds = extract_params(rules)

      prefix = "#{implied_xpath_context}/"

      rules = rules.map { |rule|
        CSS.xpath_for(rule, :prefix => prefix, :ns => ns)
      }.flatten.uniq + [ns, handler, binds].compact

      xpath(*rules)
    end

css_path() click to toggle source

Get the path to this node as a CSS expression

    # File lib/nokogiri/xml/node.rb, line 622
    def css_path
      path.split(/\//).map { |part|
        part.length == 0 ? nil : part.gsub(/\[(\d+)\]/, ':nth-of-type(\1)')
      }.compact.join(' > ')
    end

decorate!() click to toggle source

Decorate this node with the decorators set up in this node’s Document

    # File lib/nokogiri/xml/node.rb, line 89
    def decorate!
      document.decorate(self)
    end

default_namespace=(url) click to toggle source

Adds a default namespace supplied as a string `url` href, to self. The consequence is as an xmlns attribute with supplied argument were present in parsed XML. A default namespace set with this method will now show up in attributes, but when this node is serialized to XML an “xmlns” attribute will appear. See also namespace and namespace=

    # File lib/nokogiri/xml/node.rb, line 657
    def default_namespace= url
      add_namespace_definition(nil, url)
    end

delete(name) click to toggle source
Alias for: remove_attribute
description() click to toggle source

Fetch the Nokogiri::HTML::ElementDescription for this node. Returns nil on XML documents and on unknown tags.

    # File lib/nokogiri/xml/node.rb, line 591
    def description
      return nil if document.xml?
      Nokogiri::HTML::ElementDescription[name]
    end

do_xinclude(options = XML::ParseOptions::DEFAULT_XML, &block) click to toggle source

Do xinclude substitution on the subtree below node. If given a block, a Nokogiri::XML::ParseOptions object initialized from `options`, will be passed to it, allowing more convenient modification of the parser options.

    # File lib/nokogiri/xml/node.rb, line 841
    def do_xinclude options = XML::ParseOptions::DEFAULT_XML, &block
      options = Nokogiri::XML::ParseOptions.new(options) if Fixnum === options

      # give options to user
      yield options if block_given?

      # call c extension
      process_xincludes(options.to_i)
    end

document click to toggle source

Get the document for this Node

    static VALUE document(VALUE self)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);
      return DOC_RUBY_OBJECT(node->doc);
    }

dup click to toggle source

Copy this node. An optional depth may be passed in, but it defaults to a deep copy. 0 is a shallow copy, 1 is a deep copy.

    static VALUE duplicate_node(int argc, VALUE *argv, VALUE self)
    {
      VALUE level;
      xmlNodePtr node, dup;

      if(rb_scan_args(argc, argv, "01", &level) == 0)
        level = INT2NUM((long)1);

      Data_Get_Struct(self, xmlNode, node);

      dup = xmlDocCopyNode(node, node->doc, (int)NUM2INT(level));
      if(dup == NULL) return Qnil;

      nokogiri_root_node(dup);

      return Nokogiri_wrap_xml_node(rb_obj_class(self), dup);
    }

Also aliased as: clone
each() click to toggle source

Iterate over each attribute name and value pair for this Node.

    # File lib/nokogiri/xml/node.rb, line 462
    def each
      attribute_nodes.each { |node|
        yield [node.node_name, node.value]
      }
    end

elem?() click to toggle source
Alias for: element?
element?() click to toggle source

Returns true if this is an Element node

    # File lib/nokogiri/xml/node.rb, line 604
    def element?
      type == ELEMENT_NODE
    end

Also aliased as: elem?
element_children click to toggle source

Get the list of children for this node as a NodeSet. All nodes will be element nodes.

Example:

    @doc.root.element_children.all? { |x| x.element? } # => true

    static VALUE element_children(VALUE self)
    {
      xmlNodePtr node;
      xmlNodePtr child;
      xmlNodeSetPtr set;
      VALUE document;
      VALUE node_set;

      Data_Get_Struct(self, xmlNode, node);

      child = xmlFirstElementChild(node);
      set = xmlXPathNodeSetCreate(child);

      document = DOC_RUBY_OBJECT(node->doc);

      if(!child) return Nokogiri_wrap_xml_node_set(set, document);

      child = xmlNextElementSibling(child);
      while(NULL != child) {
        xmlXPathNodeSetAddUnique(set, child);
        child = xmlNextElementSibling(child);
      }

      node_set = Nokogiri_wrap_xml_node_set(set, document);

      return node_set;
    }

Also aliased as: elements
elements() click to toggle source
Alias for: element_children
encode_special_chars(string) click to toggle source

Encode any special characters in `string`

    static VALUE encode_special_chars(VALUE self, VALUE string)
    {
      xmlNodePtr node;
      xmlChar *encoded;
      VALUE encoded_str;

      Data_Get_Struct(self, xmlNode, node);
      encoded = xmlEncodeSpecialChars(
          node->doc,
          (const xmlChar *)StringValuePtr(string)
      );

      encoded_str = NOKOGIRI_STR_NEW2(encoded);
      xmlFree(encoded);

      return encoded_str;
    }

external_subset click to toggle source

Get the external subset

    static VALUE external_subset(VALUE self)
    {
      xmlNodePtr node;
      xmlDocPtr doc;
      xmlDtdPtr dtd;

      Data_Get_Struct(self, xmlNode, node);

      if(!node->doc) return Qnil;

      doc = node->doc;
      dtd = doc->extSubset;

      if(!dtd) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)dtd);
    }

first_element_child click to toggle source

Returns the first child node of this node that is an element.

Example:

    @doc.root.first_element_child.element? # => true

    static VALUE first_element_child(VALUE self)
    {
      xmlNodePtr node, child;
      Data_Get_Struct(self, xmlNode, node);

      child = xmlFirstElementChild(node);
      if(!child) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, child);
    }

fragment(tags) click to toggle source

Create a DocumentFragment containing `tags` that is relative to this context node.

    # File lib/nokogiri/xml/node.rb, line 484
    def fragment tags
      type = document.html? ? Nokogiri::HTML : Nokogiri::XML
      type::DocumentFragment.new(document, tags, self)
    end

fragment?() click to toggle source

Returns true if this is a DocumentFragment

    # File lib/nokogiri/xml/node.rb, line 584
    def fragment?
      type == DOCUMENT_FRAG_NODE
    end

get_attribute(name) click to toggle source
Alias for: []
has_attribute?(p1) click to toggle source
Alias for: key?
html?() click to toggle source

Returns true if this is an HTML::Document node

    # File lib/nokogiri/xml/node.rb, line 574
    def html?
      type == HTML_DOCUMENT_NODE
    end

inner_html(*args) click to toggle source

Get the inner_html for this node’s Node#children

    # File lib/nokogiri/xml/node.rb, line 617
    def inner_html *args
      children.map { |x| x.to_html(*args) }.join
    end

inner_html=(node_or_tags) click to toggle source

Set the inner html for this Node to `node_or_tags` `node_or_tags` can be a Nokogiri::XML::Node, a Nokogiri::XML::DocumentFragment, or a string containing markup.

Returns self.

Also see related method `children=`

    # File lib/nokogiri/xml/node.rb, line 348
    def inner_html= node_or_tags
      self.children = node_or_tags
      self
    end

inner_text() click to toggle source
Alias for: content
internal_subset click to toggle source

Get the internal subset

    static VALUE internal_subset(VALUE self)
    {
      xmlNodePtr node;
      xmlDocPtr doc;
      xmlDtdPtr dtd;

      Data_Get_Struct(self, xmlNode, node);

      if(!node->doc) return Qnil;

      doc = node->doc;
      dtd = xmlGetIntSubset(doc);

      if(!dtd) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, (xmlNodePtr)dtd);
    }

key?(attribute) click to toggle source

Returns true if `attribute` is set

    static VALUE key_eh(VALUE self, VALUE attribute)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);
      if(xmlHasProp(node, (xmlChar *)StringValuePtr(attribute)))
        return Qtrue;
      return Qfalse;
    }

Also aliased as: has_attribute?
keys() click to toggle source

Get the attribute names for this Node.

    # File lib/nokogiri/xml/node.rb, line 456
    def keys
      attribute_nodes.map { |node| node.node_name }
    end

last_element_child click to toggle source

Returns the last child node of this node that is an element.

Example:

    @doc.root.last_element_child.element? # => true

    static VALUE last_element_child(VALUE self)
    {
      xmlNodePtr node, child;
      Data_Get_Struct(self, xmlNode, node);

      child = xmlLastElementChild(node);
      if(!child) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, child);
    }

line click to toggle source

Returns the line for this Node

    static VALUE line(VALUE self)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);

      return INT2NUM(xmlGetLineNo(node));
    }

matches?(selector) click to toggle source

Returns true if this Node matches `selector`

    # File lib/nokogiri/xml/node.rb, line 477
    def matches? selector
      ancestors.last.search(selector).include?(self)
    end

name() click to toggle source
Alias for: node_name
name=(p1) click to toggle source
Alias for: node_name=
namespace() click to toggle source

returns the default namespace set on this node (as with an “xmlns=” attribute), as a Namespace object.

    static VALUE namespace(VALUE self)
    {
      xmlNodePtr node ;
      Data_Get_Struct(self, xmlNode, node);

      if (node->ns)
        return Nokogiri_wrap_xml_namespace(node->doc, node->ns);

      return Qnil ;
    }

namespace=(ns) click to toggle source

Set the default namespace on this node (as would be defined with an “xmlns=” attribute in XML source), as a Namespace object `ns`. Note that a Namespace added this way will NOT be serialized as an xmlns attribute for this node. You probably want default_namespace= instead, or perhaps add_namespace_definition with a nil prefix argument.

    # File lib/nokogiri/xml/node.rb, line 668
    def namespace= ns
      return set_namespace(ns) unless ns

      unless Nokogiri::XML::Namespace === ns
        raise TypeError, "#{ns.class} can't be coerced into Nokogiri::XML::Namespace"
      end
      if ns.document != document
        raise ArgumentError, 'namespace must be declared on the same document'
      end

      set_namespace ns
    end

namespace_definitions() click to toggle source

returns namespaces defined on self element directly, as an array of Namespace objects. Includes both a default namespace (as in“xmlns=”), and prefixed namespaces (as in “xmlns:prefix=”).

    static VALUE namespace_definitions(VALUE self)
    {
      /* this code in the mode of xmlHasProp() */
      xmlNodePtr node ;
      VALUE list;
      xmlNsPtr ns;

      Data_Get_Struct(self, xmlNode, node);

      list = rb_ary_new();

      ns = node->nsDef;

      if(!ns) return list;

      while(NULL != ns) {
        rb_ary_push(list, Nokogiri_wrap_xml_namespace(node->doc, ns));
        ns = ns->next;
      }

      return list;
    }

namespace_scopes() click to toggle source

returns namespaces in scope for self – those defined on self element directly or any ancestor node – as an array of Namespace objects. Default namespaces (“xmlns=” style) for self are included in this array; Default namespaces for ancestors, however, are not. See also namespaces

    static VALUE namespace_scopes(VALUE self)
    {
      xmlNodePtr node ;
      VALUE list;
      xmlNsPtr *ns_list;
      int j;

      Data_Get_Struct(self, xmlNode, node);

      list = rb_ary_new();
      ns_list = xmlGetNsList(node->doc, node);

      if(!ns_list) return list;

      for (j = 0 ; ns_list[j] != NULL ; ++j) {
        rb_ary_push(list, Nokogiri_wrap_xml_namespace(node->doc, ns_list[j]));
      }

      xmlFree(ns_list);
      return list;
    }

namespaced_key?(attribute, namespace) click to toggle source

Returns true if `attribute` is set with `namespace`

    static VALUE namespaced_key_eh(VALUE self, VALUE attribute, VALUE namespace)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);
      if(xmlHasNsProp(node, (xmlChar *)StringValuePtr(attribute),
            NIL_P(namespace) ? NULL : (xmlChar *)StringValuePtr(namespace)))
        return Qtrue;
      return Qfalse;
    }

namespaces() click to toggle source

Returns a Hash of {prefix => value} for all namespaces on this node and its ancestors.

This method returns the same namespaces as namespace_scopes.

Returns namespaces in scope for self – those defined on self element directly or any ancestor node – as a Hash of attribute-name/value pairs. Note that the keys in this hash XML attributes that would be used to define this namespace, such as “xmlns:prefix”, not just the prefix. Default namespace set on self will be included with key “xmlns”. However, default namespaces set on ancestor will NOT be, even if self has no explicit default namespace.

    # File lib/nokogiri/xml/node.rb, line 545
    def namespaces
      Hash[namespace_scopes.map { |nd|
        key = ['xmlns', nd.prefix].compact.join(':')
        if RUBY_VERSION >= '1.9' && document.encoding
          begin
            key.force_encoding document.encoding
          rescue ArgumentError
          end
        end
        [key, nd.href]
      }]
    end

content= click to toggle source

Set the content for this Node

    static VALUE native_content(VALUE self, VALUE content)
    {
      xmlNodePtr node, child, next ;
      Data_Get_Struct(self, xmlNode, node);

      child = node->children;
      while (NULL != child) {
        next = child->next ;
        xmlUnlinkNode(child) ;
        nokogiri_root_node(child);
        child = next ;
      }

      xmlNodeSetContent(node, (xmlChar *)StringValuePtr(content));
      return content;
    }

next() click to toggle source
Alias for: next_sibling
next_element click to toggle source

Returns the next Nokogiri::XML::Element type sibling node.

    static VALUE next_element(VALUE self)
    {
      xmlNodePtr node, sibling;
      Data_Get_Struct(self, xmlNode, node);

      sibling = xmlNextElementSibling(node);
      if(!sibling) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, sibling);
    }

next_sibling click to toggle source

Returns the next sibling node

    static VALUE next_sibling(VALUE self)
    {
      xmlNodePtr node, sibling;
      Data_Get_Struct(self, xmlNode, node);

      sibling = node->next;
      if(!sibling) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, sibling) ;
    }

Also aliased as: next
name click to toggle source

Returns the name for this Node

    static VALUE get_name(VALUE self)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);
      if(node->name)
        return NOKOGIRI_STR_NEW2(node->name);
      return Qnil;
    }

Also aliased as: name
name=(new_name) click to toggle source

Set the name for this Node

    static VALUE set_name(VALUE self, VALUE new_name)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);
      xmlNodeSetName(node, (xmlChar*)StringValuePtr(new_name));
      return new_name;
    }

Also aliased as: name=
node_type click to toggle source

Get the type for this Node

    static VALUE node_type(VALUE self)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);
      return INT2NUM((long)node->type);
    }

Also aliased as: type
parent click to toggle source

Get the parent Node for this Node

    static VALUE get_parent(VALUE self)
    {
      xmlNodePtr node, parent;
      Data_Get_Struct(self, xmlNode, node);

      parent = node->parent;
      if(!parent) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, parent) ;
    }

parent=(parent_node) click to toggle source

Set the parent Node for this Node

    # File lib/nokogiri/xml/node.rb, line 526
    def parent= parent_node
      parent_node.add_child(self)
      parent_node
    end

parse(string_or_io, options = nil) click to toggle source

Parse `string_or_io` as a document fragment within the context of this node. Returns a XML::NodeSet containing the nodes parsed from `string_or_io`.

    # File lib/nokogiri/xml/node.rb, line 493
    def parse string_or_io, options = nil
      options ||= (document.html? ? ParseOptions::DEFAULT_HTML : ParseOptions::DEFAULT_XML)
      if Fixnum === options
        options = Nokogiri::XML::ParseOptions.new(options)
      end
      # Give the options to the user
      yield options if block_given?

      contents = string_or_io.respond_to?(:read) ?
        string_or_io.read :
        string_or_io

      return Nokogiri::XML::NodeSet.new(document) if contents.empty?

      ##
      # This is a horrible hack, but I don't care. See #313 for background.
      error_count = document.errors.length
      node_set = in_context(contents, options.to_i)
      if node_set.empty? and document.errors.length > error_count and options.recover?
        fragment = Nokogiri::HTML::DocumentFragment.parse contents
        node_set = fragment.children
      end
      node_set
    end

path click to toggle source

Returns the path associated with this Node

    static VALUE path(VALUE self)
    {
      xmlNodePtr node;
      xmlChar *path ;
      VALUE rval;

      Data_Get_Struct(self, xmlNode, node);

      path = xmlGetNodePath(node);
      rval = NOKOGIRI_STR_NEW2(path);
      xmlFree(path);
      return rval ;
    }

pointer_id click to toggle source

Get the internal pointer number

    static VALUE pointer_id(VALUE self)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);

      return INT2NUM((long)(node));
    }

previous() click to toggle source
Alias for: previous_sibling
previous=(node_or_tags) click to toggle source
Alias for: add_previous_sibling
previous_element click to toggle source

Returns the previous Nokogiri::XML::Element type sibling node.

    static VALUE previous_element(VALUE self)
    {
      xmlNodePtr node, sibling;
      Data_Get_Struct(self, xmlNode, node);

      /*
       *  note that we don't use xmlPreviousElementSibling here because it's buggy pre-2.7.7.
       */
      sibling = node->prev;
      if(!sibling) return Qnil;

      while(sibling && sibling->type != XML_ELEMENT_NODE)
        sibling = sibling->prev;

      return sibling ? Nokogiri_wrap_xml_node(Qnil, sibling) : Qnil ;
    }

previous_sibling click to toggle source

Returns the previous sibling node

    static VALUE previous_sibling(VALUE self)
    {
      xmlNodePtr node, sibling;
      Data_Get_Struct(self, xmlNode, node);

      sibling = node->prev;
      if(!sibling) return Qnil;

      return Nokogiri_wrap_xml_node(Qnil, sibling);
    }

Also aliased as: previous
read_only?() click to toggle source

Is this a read only node?

    # File lib/nokogiri/xml/node.rb, line 598
    def read_only?
      # According to gdome2, these are read-only node types
      [NOTATION_NODE, ENTITY_NODE, ENTITY_DECL].include?(type)
    end

remove() click to toggle source
Alias for: unlink
remove_attribute(name) click to toggle source

Remove the attribute named `name`

    # File lib/nokogiri/xml/node.rb, line 470
    def remove_attribute name
      attributes[name].remove if key? name
    end

Also aliased as: delete
replace(node_or_tags) click to toggle source

Replace this Node with `node_or_tags`. `node_or_tags` can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.

Returns the reparented node (if `node_or_tags` is a Node), or NodeSet (if `node_or_tags` is a DocumentFragment, NodeSet, or string).

Also see related method `swap`.

    # File lib/nokogiri/xml/node.rb, line 378
    def replace node_or_tags
      # We cannot replace a text node directly, otherwise libxml will return
      # an internal error at parser.c:13031, I don't know exactly why
      # libxml is trying to find a parent node that is an element or document
      # so I can't tell if this is bug in libxml or not. issue #775.
      if text?
        replacee = Nokogiri::XML::Node.new 'dummy', document
        add_previous_sibling_node replacee
        unlink
        return replacee.replace node_or_tags
      end

      node_or_tags = coerce(node_or_tags)

      if node_or_tags.is_a?(XML::NodeSet)
        node_or_tags.each { |n| add_previous_sibling n }
        unlink
      else
        replace_node node_or_tags
      end
      node_or_tags
    end

search(*paths) click to toggle source

Search this node for `paths`. `paths` can be XPath or CSS, and an optional hash of namespaces may be appended. See Node#xpath and Node#css.

    # File lib/nokogiri/xml/node.rb, line 97
    def search *paths
      # TODO use         paths, handler, ns, binds = extract_params(paths)
      ns = paths.last.is_a?(Hash) ? paths.pop :
        (document.root ? document.root.namespaces : {})

      prefix = "#{implied_xpath_context}/"

      xpath(*(paths.map { |path|
        path = path.to_s
        path =~ /^(\.\/|\/|\.\.|\.$)/ ? path : CSS.xpath_for(
          path,
          :prefix => prefix,
          :ns     => ns
        )
      }.flatten.uniq) + [ns])
    end

Also aliased as: /
serialize(*args, &block) click to toggle source

Serialize Node using `options`. Save options can also be set using a block. See SaveOptions.

These two statements are equivalent:

    node.serialize(:encoding => 'UTF-8', :save_with => FORMAT | AS_XML)

or

    node.serialize(:encoding => 'UTF-8') do |config|
      config.format.as_xml
    end

    # File lib/nokogiri/xml/node.rb, line 716
    def serialize *args, &block
      options = args.first.is_a?(Hash) ? args.shift : {
        :encoding   => args[0],
        :save_with  => args[1]
      }

      encoding = options[:encoding] || document.encoding
      options[:encoding] = encoding

      outstring = ""
      if encoding && outstring.respond_to?(:force_encoding)
        outstring.force_encoding(Encoding.find(encoding))
      end
      io = StringIO.new(outstring)
      write_to io, options, &block
      io.string
    end

set_attribute(name, value) click to toggle source
Alias for: []=
swap(node_or_tags) click to toggle source

Swap this Node for `node_or_tags` `node_or_tags` can be a Nokogiri::XML::Node, a ::DocumentFragment, a ::NodeSet, or a string containing markup.

Returns self, to support chaining of calls.

Also see related method `replace`.

    # File lib/nokogiri/xml/node.rb, line 408
    def swap node_or_tags
      replace node_or_tags
      self
    end

text() click to toggle source
Also aliased as: to_str
Alias for: content
text?() click to toggle source

Returns true if this is a Text node

    # File lib/nokogiri/xml/node.rb, line 579
    def text?
      type == TEXT_NODE
    end

to_html(options = {}) click to toggle source

Serialize this Node to HTML

    doc.to_html

See Node#write_to for a list of `options`. For formatted output, use Node#to_xhtml instead.

    # File lib/nokogiri/xml/node.rb, line 741
    def to_html options = {}
      to_format SaveOptions::DEFAULT_HTML, options
    end

to_s() click to toggle source

Turn this node in to a string. If the document is HTML, this method returns html. If the document is XML, this method returns XML.

    # File lib/nokogiri/xml/node.rb, line 612
    def to_s
      document.xml? ? to_xml : to_html
    end

to_str() click to toggle source
Alias for: text
to_xhtml(options = {}) click to toggle source

Serialize this Node to XHTML using `options`

    doc.to_xhtml(:indent => 5, :encoding => 'UTF-8')

See Node#write_to for a list of `options`

    # File lib/nokogiri/xml/node.rb, line 762
    def to_xhtml options = {}
      to_format SaveOptions::DEFAULT_XHTML, options
    end

to_xml(options = {}) click to toggle source

Serialize this Node to XML using `options`

    doc.to_xml(:indent => 5, :encoding => 'UTF-8')

See Node#write_to for a list of `options`

    # File lib/nokogiri/xml/node.rb, line 751
    def to_xml options = {}
      options[:save_with] ||= SaveOptions::DEFAULT_XML
      serialize(options)
    end

traverse(&block) click to toggle source

Yields self and all children to `block` recursively.

    # File lib/nokogiri/xml/node.rb, line 683
    def traverse &block
      children.each{|j| j.traverse(&block) }
      block.call(self)
    end

type() click to toggle source
Alias for: node_type
unlink click to toggle source

Unlink this node from its current context.

    static VALUE unlink_node(VALUE self)
    {
      xmlNodePtr node;
      Data_Get_Struct(self, xmlNode, node);
      xmlUnlinkNode(node);
      nokogiri_root_node(node);
      return self;
    }

Also aliased as: remove
values() click to toggle source

Get the attribute values for this Node.

    # File lib/nokogiri/xml/node.rb, line 450
    def values
      attribute_nodes.map { |node| node.value }
    end

write_html_to(io, options = {}) click to toggle source

Write Node as HTML to `io` with `options`

See Node#write_to for a list of `options`

    # File lib/nokogiri/xml/node.rb, line 805
    def write_html_to io, options = {}
      write_format_to SaveOptions::DEFAULT_HTML, io, options
    end

write_to(io, *options) click to toggle source

Write Node to `io` with `options`. `options` modify the output of this method. Valid options are:

- `:encoding` for changing the encoding

- `:indent_text` the indentation text, defaults to one space

- `:indent` the number of `:indent_text` to use, defaults to 2

- `:save_with` a combination of SaveOptions constants.

To save with UTF-8 indented twice:

    node.write_to(io, :encoding => 'UTF-8', :indent => 2)

To save indented with two dashes:

    node.write_to(io, :indent_text => '-', :indent => 2

    # File lib/nokogiri/xml/node.rb, line 783
    def write_to io, *options
      options       = options.first.is_a?(Hash) ? options.shift : {}
      encoding      = options[:encoding] || options[0]
      if Nokogiri.jruby?
        save_options  = options[:save_with] || options[1]
        indent_times  = options[:indent] || 0
      else
        save_options  = options[:save_with] || options[1] || SaveOptions::FORMAT
        indent_times  = options[:indent] || 2
      end
      indent_text   = options[:indent_text] || ' '

      config = SaveOptions.new(save_options.to_i)
      yield config if block_given?

      native_write_to(io, encoding, indent_text * indent_times, config.options)
    end

write_xhtml_to(io, options = {}) click to toggle source

Write Node as XHTML to `io` with `options`

See Node#write_to for a list of `options`

    # File lib/nokogiri/xml/node.rb, line 813
    def write_xhtml_to io, options = {}
      write_format_to SaveOptions::DEFAULT_XHTML, io, options
    end

write_xml_to(io, options = {}) click to toggle source

Write Node as XML to `io` with `options`

    doc.write_xml_to io, :encoding => 'UTF-8'

See Node#write_to for a list of options

    # File lib/nokogiri/xml/node.rb, line 823
    def write_xml_to io, options = {}
      options[:save_with] ||= SaveOptions::DEFAULT_XML
      write_to io, options
    end

xml?() click to toggle source

Returns true if this is an XML::Document node

    # File lib/nokogiri/xml/node.rb, line 569
    def xml?
      type == DOCUMENT_NODE
    end

xpath *paths, [namespace-bindings, variable-bindings, custom-handler-class] click to toggle source

Search this node for XPath `paths`. `paths` must be one or more XPath queries.

    node.xpath('.//title')

A hash of namespace bindings may be appended. For example:

    node.xpath('.//foo:name', {'foo' => 'http://example.org/'})
    node.xpath('.//xmlns:name', node.root.namespaces)

A hash of variable bindings may also be appended to the namespace bindings. For example:

    node.xpath('.//address[@domestic=$value]', nil, {:value => 'Yes'})

Custom XPath functions may also be defined. To define custom functions create a class and implement the function you want to define. The first argument to the method will be the current matching NodeSet. Any other arguments are ones that you pass in. Note that this class may appear anywhere in the argument list. For example:

    node.xpath('.//title[regex(., "\w+")]', Class.new {
      def regex node_set, regex
        node_set.find_all { |node| node['some_attribute'] =~ /#{regex}/ }
      end
    }.new)

    # File lib/nokogiri/xml/node.rb, line 145
    def xpath *paths
      return NodeSet.new(document) unless document

      paths, handler, ns, binds = extract_params(paths)

      sets = paths.map { |path|
        ctx = XPathContext.new(self)
        ctx.register_namespaces(ns)
        path = path.gsub(/xmlns:/, ' :') unless Nokogiri.uses_libxml?

        binds.each do |key,value|
          ctx.register_variable key.to_s, value
        end if binds

        ctx.evaluate(path, handler)
      }
      return sets.first if sets.length == 1

      NodeSet.new(document) do |combined|
        sets.each do |set|
          set.each do |node|
            combined << node
          end
        end
      end
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.