Class: NokogiriXml::DTD

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::Nokogiri::XML::Node`
Instance Chain: self, `::Nokogiri::XML::Node`, Enumerable, `::Nokogiri::ClassResolver`, `::Nokogiri::XML::Searchable`, `::Nokogiri::XML::PP::Node`
Inherits:	Nokogiri::XML::Node `::Object` Nokogiri::XML::Node NokogiriXml::DTD
Defined in:	ext/nokogiri/xml_dtd.c

Overview

::Nokogiri::XML::DTD wraps DTD nodes in an XML document

Constant Summary

Class Method Summary

`::Nokogiri::XML::Node` - Inherited

.new	documented in lib/nokogiri/xml/node.rb.

Instance Attribute Summary

`::Nokogiri::XML::Node` - Inherited

#blank?	Returns `true` if the node is an empty or whitespace-only text or cdata node, else `false`.
#cdata?	Returns true if this is a CDATA.
#children	:category: Traversing Document Structure.
#children=	Set the content for this Node `node_or_tags`
#comment?	Returns true if this is a Comment.
#content	[Returns].
#content=	Set the Node’s content to a Text node containing `string`.
#default_namespace=	Adds a default namespace supplied as a string `url` href, to self.
#document	:category: Traversing Document Structure.
#document?	Returns true if this is a Document.
#elem?	Alias for Nokogiri::XML::Node#element?.
#element?	Returns true if this is an Element node.
#fragment?	Returns true if this is a DocumentFragment.
#html?	Returns true if this is an `HTML4::Document` or `HTML5::Document` node.
#inner_html	Get the inner_html for this node’s `Node#children`
#inner_html=	Set the content for this Node to `node_or_tags`.
#inner_text	Alias for Nokogiri::XML::Node#content.
#lang	Searches the language of a node, i.e.
#lang=	Set the language of a node, i.e.
#line	Returns The line number of this Node.
#line=	Sets the line for this Node.
#name	Alias for Nokogiri::XML::Node#node_name.
#namespace	Returns The Namespace of the element or attribute node, or `nil` if there is no namespace.
#namespace=	Set the default namespace on this node (as would be defined with an “xmlns=” attribute in XML source), as a Namespace object `ns`.
#native_content=	Set the content for this Node.
#next	Alias for Nokogiri::XML::Node#next_sibling.
#next=	Alias for Nokogiri::XML::Node#add_next_sibling.
#node_name	Returns the name for this Node.
#node_name=	Set the name for this Node.
#parent	Get the parent Node for this Node.
#parent=	Set the parent Node for this Node.
#previous	Alias for Nokogiri::XML::Node#previous_sibling.
#previous=	Alias for Nokogiri::XML::Node#add_previous_sibling.
#processing_instruction?	Returns true if this is a ProcessingInstruction node.
#read_only?	Is this a read only node?
#text	Alias for Nokogiri::XML::Node#content.
#text?	Returns true if this is a Text node.
#to_str	Alias for Nokogiri::XML::Node#content.
#xml?	Returns true if this is an `XML::Document` node.
#prepend_newline?, #data_ptr?

Instance Method Summary

#attributes

Get a hash of the attributes for this DTD.
#elements

Get a hash of the elements for this DTD.
#entities

Get a hash of the elements for this DTD.
#external_id

Alias for Nokogiri::XML::EntityDecl#external_id.
#notations() → Hash<name(String)⇒Notation>)

Returns
All the notations for this DTD in a Hash of Notation name to Notation.
#system_id

Alias for Nokogiri::XML::EntityDecl#system_id.
#validate(document)

Validate document returning a list of errors.

`::Nokogiri::XML::Node` - Inherited

#<<	Add `node_or_tags` as a child of this Node.
#<=>	Compare two Node objects with respect to their Document.
#==	Test to see if this Node is equal to `other`
#[]	Fetch an attribute from this node.
#[]=	Update the attribute `name` to `value`, or create the attribute if it does not exist.
#accept	Accept a visitor.
#add_child	Add `node_or_tags` as a child of this Node.
#add_class	Ensure HTML CSS classes are present on `self`.
#add_namespace	Alias for Nokogiri::XML::Node#add_namespace_definition.
#add_namespace_definition	:category: Manipulating Document Structure.
#add_next_sibling	Insert `node_or_tags` after this Node (as a sibling).
#add_previous_sibling	Insert `node_or_tags` before this Node (as a sibling).
#after	Insert `node_or_tags` after this node (as a sibling).
#ancestors	Get a list of ancestor Node for this Node.
#append_class	Add HTML CSS classes to `self`, regardless of duplication.
#attr	Alias for Nokogiri::XML::Node#[].
#attribute	:category: Working With Node Attributes.
#attribute_nodes	:category: Working With Node Attributes.
#attribute_with_ns	:category: Working With Node Attributes.
#attributes	Fetch this node’s attributes.
#before	Insert `node_or_tags` before this node (as a sibling).
#canonicalize,
#child	:category: Traversing Document Structure.
#classes	Fetch CSS class names of a Node.
#clone	Clone this node.
#create_external_subset	Create an external subset.
#create_internal_subset	Create the internal subset of a document.
#css_path	Get the path to this node as a CSS expression.
#deconstruct_keys	Returns a hash describing the Node, to use in pattern matching.
#decorate!	Decorate this node with the decorators set up in this node’s Document.
#delete	Alias for Nokogiri::XML::Node#remove_attribute.
#description	Fetch the `::Nokogiri::HTML4::ElementDescription` for this node.
#do_xinclude	Do xinclude substitution on the subtree below node.
#dup	Duplicate this node.
#each	Iterate over each attribute name and value pair for this Node.
#element_children	[Returns].
#elements	Alias for Nokogiri::XML::Node#element_children.
#encode_special_chars	Encode any special characters in `string`
#external_subset	Get the external subset.
#first_element_child	Returns The first child Node that is an element.
#fragment	Create a DocumentFragment containing `tags` that is relative to this context node.
#get_attribute	Alias for Nokogiri::XML::Node#[].
#has_attribute?	Alias for Nokogiri::XML::Node#key?.
#initialize	Create a new node with `name` that belongs to `document`.
#internal_subset	Get the internal subset.
#key?	Returns true if `attribute` is set.
#keys	Get the attribute names for this Node.
#kwattr_add	Ensure that values are present in a keyword attribute.
#kwattr_append	Add keywords to a Node’s keyword attribute, regardless of duplication.
#kwattr_remove	Remove keywords from a keyword attribute.
#kwattr_values	Fetch values from a keyword attribute of a Node.
#last_element_child	Returns The last child Node that is an element.
#matches?	Returns true if this Node matches `selector`
#namespace_definitions	[Returns].
#namespace_scopes	Returns Array of all the Namespaces on this node and its ancestors.
#namespaced_key?	Returns true if `attribute` is set with `namespace`
#namespaces	Fetch all the namespaces on this node and its ancestors.
#next_element	Returns the next `::Nokogiri::XML::Element` type sibling node.
#next_sibling	Returns the next sibling node.
#node_type	Get the type for this Node.
#parse	Parse `string_or_io` as a document fragment within the context of this node.
#path	Returns the path associated with this Node.
#pointer_id	[Returns].
#prepend_child	Add `node_or_tags` as the first child of this Node.
#previous_element	Returns the previous `::Nokogiri::XML::Element` type sibling node.
#previous_sibling	Returns the previous sibling node.
#remove	Alias for Nokogiri::XML::Node#unlink.
#remove_attribute	Remove the attribute named `name`
#remove_class	Remove HTML CSS classes from this node.
#replace	Replace this Node with `node_or_tags`.
#serialize	Serialize Node using `options`.
#set_attribute	Alias for Nokogiri::XML::Node#[]=.
#swap	Swap this Node for `node_or_tags`
#to_html	Serialize this Node to HTML.
#to_s	Turn this node in to a string.
#to_xhtml	Serialize this Node to XHTML using `options`
#to_xml	Serialize this Node to XML using `options`
#traverse	Yields self and all children to `block` recursively.
#type	Alias for Nokogiri::XML::Node#node_type.
#unlink	Unlink this node from its current context.
#value?	Does this Node’s attributes include <value>.
#values	Get the attribute values for this Node.
#wrap	Wrap this Node with the node parsed from `markup` or a dup of the `node`.
#write_html_to	Write Node as HTML to `io` with `options`
#write_to	Serialize this node or document to `io`.
#write_xhtml_to	Write Node as XHTML to `io` with `options`
#write_xml_to	Write Node as XML to `io` with `options`
#add_child_node_and_reparent_attrs, #add_sibling,
#compare	Compare this Node to `other` with respect to their Document.
#dump_html	Returns the Node as html.
#get	Get the value for `attribute`
#html_standard_serialize,
#in_context	TODO: DOCUMENT ME.
#inspect_attributes, #keywordify,
#native_write_to	Write this Node to `io` with `encoding` and `options`
#process_xincludes	Loads and substitutes all xinclude elements below the node.
#set	Set the `property` to `value`
#set_namespace	Set the namespace to `namespace`
#to_format, #write_format_to, #add_child_node, #add_next_sibling_node, #add_previous_sibling_node, #replace_node

`::Nokogiri::ClassResolver` - Included

#related_class

Find a class constant within the.

`::Nokogiri::XML::Searchable` - Included

#%	Alias for Nokogiri::XML::Searchable#at.
#/	Alias for Nokogiri::XML::Searchable#search.
#>	Search this node’s immediate children using CSS selector `selector`
#at	Search this object for `paths`, and return only the first result.
#at_css	Search this object for CSS `rules`, and return only the first match.
#at_xpath	Search this node for XPath `paths`, and return only the first match.
#css	Search this object for CSS `rules`.
#search	Search this object for `paths`.
#xpath	Search this node for XPath `paths`.
#css_internal, #css_rules_to_xpath, #xpath_impl, #xpath_internal, #xpath_query_from_css_rule, #extract_params

`::Nokogiri::XML::PP::Node` - Included

#inspect, #pretty_print

Constructor Details

This class inherits a constructor from Nokogiri::XML::Node

Instance Method Details

#attributes

Get a hash of the attributes for this DTD.

[ GitHub ]

# File 'ext/nokogiri/xml_dtd.c', line 87


static VALUE
attributes(VALUE self)
{
  xmlDtdPtr dtd;
  VALUE hash;

  Noko_Node_Get_Struct(self, xmlDtd, dtd);

  hash = rb_hash_new();

  if (!dtd->attributes) { return hash; }

  xmlHashScan((xmlHashTablePtr)dtd->attributes, element_copier, (void *)hash);

  return hash;
}

#elements

Get a hash of the elements for this DTD.

[ GitHub ]

# File 'ext/nokogiri/xml_dtd.c', line 110


static VALUE
elements(VALUE self)
{
  xmlDtdPtr dtd;
  VALUE hash;

  Noko_Node_Get_Struct(self, xmlDtd, dtd);

  if (!dtd->elements) { return Qnil; }

  hash = rb_hash_new();

  xmlHashScan((xmlHashTablePtr)dtd->elements, element_copier, (void *)hash);

  return hash;
}

#entities

Get a hash of the elements for this DTD.

[ GitHub ]

# File 'ext/nokogiri/xml_dtd.c', line 41


static VALUE
entities(VALUE self)
{
  xmlDtdPtr dtd;
  VALUE hash;

  Noko_Node_Get_Struct(self, xmlDtd, dtd);

  if (!dtd->entities) { return Qnil; }

  hash = rb_hash_new();

  xmlHashScan((xmlHashTablePtr)dtd->entities, element_copier, (void *)hash);

  return hash;
}

#external_id

Alias for Nokogiri::XML::EntityDecl#external_id.

#notations() → Hash<name(String)⇒Notation>)

Returns: All the notations for this DTD in a Hash of Notation name to Notation.

[ GitHub ]

# File 'ext/nokogiri/xml_dtd.c', line 64


static VALUE
notations(VALUE self)
{
  xmlDtdPtr dtd;
  VALUE hash;

  Noko_Node_Get_Struct(self, xmlDtd, dtd);

  if (!dtd->notations) { return Qnil; }

  hash = rb_hash_new();

  xmlHashScan((xmlHashTablePtr)dtd->notations, notation_copier, (void *)hash);

  return hash;
}

#system_id

Alias for Nokogiri::XML::EntityDecl#system_id.

#validate(document)

Validate document returning a list of errors

[ GitHub ]

# File 'ext/nokogiri/xml_dtd.c', line 133


static VALUE
validate(VALUE self, VALUE document)
{
  xmlDocPtr doc;
  xmlDtdPtr dtd;
  xmlValidCtxtPtr ctxt;
  VALUE error_list;

  Noko_Node_Get_Struct(self, xmlDtd, dtd);
  doc = noko_xml_document_unwrap(document);
  error_list = rb_ary_new();

  ctxt = xmlNewValidCtxt();

  xmlSetStructuredErrorFunc((void *)error_list, Nokogiri_error_array_pusher);

  xmlValidateDtd(ctxt, doc, dtd);

  xmlSetStructuredErrorFunc(NULL, NULL);

  xmlFreeValidCtxt(ctxt);

  return error_list;
}

Class: NokogiriXml::DTD

Overview

Constant Summary

::Nokogiri::XML::PP::Node - Included

::Nokogiri::XML::Searchable - Included

::Nokogiri::ClassResolver - Included

::Nokogiri::XML::Node - Inherited

Class Method Summary

::Nokogiri::XML::Node - Inherited

Instance Attribute Summary

::Nokogiri::XML::Node - Inherited

Instance Method Summary

::Nokogiri::XML::Node - Inherited

::Nokogiri::ClassResolver - Included

::Nokogiri::XML::Searchable - Included

::Nokogiri::XML::PP::Node - Included

Constructor Details

Instance Method Details

#attributes

#elements

#entities

#external_id

#notations() → Hash<name(String)⇒Notation>)

#system_id

#validate(document)

`::Nokogiri::XML::PP::Node` - Included

`::Nokogiri::XML::Searchable` - Included

`::Nokogiri::ClassResolver` - Included

`::Nokogiri::XML::Node` - Inherited

`::Nokogiri::XML::Node` - Inherited

`::Nokogiri::XML::Node` - Inherited

`::Nokogiri::XML::Node` - Inherited

`::Nokogiri::ClassResolver` - Included

`::Nokogiri::XML::Searchable` - Included

`::Nokogiri::XML::PP::Node` - Included