1XML::DOM::Document(3) User Contributed Perl DocumentationXML::DOM::Document(3)
2
6 XML::DOM::Document - An XML document node in XML::DOM
7
9 XML::DOM::Document extends XML::DOM::Node.
10 It is the main root of the XML document structure as returned by
12 XML::DOM::Parser::parse and XML::DOM::Parser::parsefile.
13 Since elements, text nodes, comments, processing instructions, etc.
15 cannot exist outside the context of a Document, the Document interface
16 also contains the factory methods needed to create these objects. The
17 Node objects created have a getOwnerDocument method which associates
18 them with the Document within whose context they were created.
19 METHODS
21 getDocumentElement
22 This is a convenience method that allows direct access to the child
23 node that is the root Element of the document.
24 getDoctype
26 The Document Type Declaration (see DocumentType) associated with
27 this document. For HTML documents as well as XML documents without
28 a document type declaration this returns undef. The DOM Level 1
29 does not support editing the Document Type Declaration.
30 Not In DOM Spec: This implementation allows editing the doctype.
32 See XML::DOM::ignoreReadOnly for details.
33 getImplementation
35 The DOMImplementation object that handles this document. A DOM
36 application may use objects from multiple implementations.
37 createElement (tagName)
39 Creates an element of the type specified. Note that the instance
40 returned implements the Element interface, so attributes can be
41 specified directly on the returned object.
42 DOMExceptions:
44 • INVALID_CHARACTER_ERR
46 Raised if the tagName does not conform to the XML spec.
48 createTextNode (data)
50 Creates a Text node given the specified string.
51 createComment (data)
53 Creates a Comment node given the specified string.
54 createCDATASection (data)
56 Creates a CDATASection node given the specified string.
57 createAttribute (name [, value [, specified ]])
59 Creates an Attr of the given name. Note that the Attr instance can
60 then be set on an Element using the setAttribute method.
61 Not In DOM Spec: The DOM Spec does not allow passing the value or
63 the specified property in this method. In this implementation they
64 are optional.
65 Parameters:
67 value The attribute's value. See Attr::setValue for details.
68 If the value is not supplied, the specified property
69 is set to 0.
70 specified Whether the attribute value was specified or whether the
71 default
72 value was used. If not supplied, it's assumed to be
73 1.
74 DOMExceptions:
76 • INVALID_CHARACTER_ERR
78 Raised if the name does not conform to the XML spec.
80 createProcessingInstruction (target, data)
82 Creates a ProcessingInstruction node given the specified name and
83 data strings.
84 Parameters:
86 target The target part of the processing instruction.
87 data The data for the node.
88 DOMExceptions:
90 • INVALID_CHARACTER_ERR
92 Raised if the target does not conform to the XML spec.
94 createDocumentFragment
96 Creates an empty DocumentFragment object.
97 createEntityReference (name)
99 Creates an EntityReference object.
100 Additional methods not in the DOM Spec
102 getXMLDecl and setXMLDecl (xmlDecl)
103 Returns the XMLDecl for this Document or undef if none was
104 specified. Note that XMLDecl is not part of the list of child
105 nodes.
106 setDoctype (doctype)
108 Sets or replaces the DocumentType. NOTE: Don't use appendChild or
109 insertBefore to set the DocumentType. Even though doctype will be
110 part of the list of child nodes, it is handled specially.
111 getDefaultAttrValue (elem, attr)
113 Returns the default attribute value as a string or undef, if none
114 is available.
115 Parameters:
117 elem The element tagName.
118 attr The attribute name.
119 getEntity (name)
121 Returns the Entity with the specified name.
122 createXMLDecl (version, encoding, standalone)
124 Creates an XMLDecl object. All parameters may be undefined.
125 createDocumentType (name, sysId, pubId)
127 Creates a DocumentType object. SysId and pubId may be undefined.
128 createNotation (name, base, sysId, pubId)
130 Creates a new Notation object. Consider using
131 XML::DOM::DocumentType::addNotation!
132 createEntity (parameter, notationName, value, sysId, pubId, ndata)
134 Creates an Entity object. Consider using
135 XML::DOM::DocumentType::addEntity!
136 createElementDecl (name, model)
138 Creates an ElementDecl object.
139 DOMExceptions:
141 • INVALID_CHARACTER_ERR
143 Raised if the element name (tagName) does not conform to the
145 XML spec.
146 createAttlistDecl (name)
148 Creates an AttlistDecl object.
149 DOMExceptions:
151 • INVALID_CHARACTER_ERR
153 Raised if the element name (tagName) does not conform to the
155 XML spec.
156 expandEntity (entity [, parameter])
158 Expands the specified entity or parameter entity (if parameter=1)
159 and returns its value as a string, or undef if the entity does not
160 exist. (The entity name should not contain the '%', '&' or ';'
161 delimiters.)
162 check ( [$checker] )
164 Uses the specified XML::Checker to validate the document. If no
165 XML::Checker is supplied, a new XML::Checker is created. See
166 XML::Checker for details.
167 check_sax ( [$checker] )
169 Similar to check() except it uses the SAX interface to XML::Checker
170 instead of the expat interface. This method may disappear or
171 replace check() at some time.
172 createChecker ()
174 Creates an XML::Checker based on the document's DTD. The $checker
175 can be reused to check any elements within the document. Create a
176 new XML::Checker whenever the DOCTYPE section of the document is
177 altered!
178perl v5.32.1 2021-01-27 XML::DOM::Document(3)