One Hat Cyber Team

View File Name : XML::GDOME::Document.3pm

.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "XML::GDOME::Document 3"
.TH XML::GDOME::Document 3 "2002-09-15" "perl v5.14.2" "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"
.Vb 1
\&  XML::GDOME::Document \- Interface Document implementation.
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&  $docType  = $doc\->getDoctype();
\&  $elem     = $doc\->getDocumentElement();
\&  $DOMImpl  = $doc\->getImplementation();
\&  $attr     = $doc\->createAttribute($name);
\&  $attr     = $doc\->createAttributeNS($namespaceURI,$qualifiedName);
\&  $cdata    = $doc\->createCDATASection($data);
\&  $comment  = $doc\->createComment($data);
\&  $docFrag  = $doc\->createDocumentFragment();
\&  $elem     = $doc\->createElement($tagName);
\&  $elem     = $doc\->createElementNS($namespaceURI,$qualifiedName);
\&  $entRef   = $doc\->createEntityReference($name);
\&  $pi       = $doc\->createProcessingInstruction($target,$data);
\&  $text     = $doc\->createTextNode($data);
\&  $elem     = $doc\->getElementById($elementId);
\&  $nodeList = $doc\->getElementsByTagName($tagname);
\&  $nodeList = $doc\->getElementsByTagNameNS($namespaceURI,$localName);
\&  $node     = $doc\->importNode($importedNode,$deep);
\&  $str      = $doc\->toString($mode);
\&  $str      = $doc\->toStringEnc($encoding,$mode);
.Ve
.SH "CLASS INHERITANCE"
.IX Header "CLASS INHERITANCE"
XML::GDOME::Node > XML::GDOME::Document
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$docType = $doc\->\fIgetDoctype()\fR;" 4
.el .IP "\f(CW$docType\fR = \f(CW$doc\fR\->\fIgetDoctype()\fR;" 4
.IX Item "$docType = $doc->getDoctype();"
\&\fIReturns\fR: The Document Type Declaration associated with this document. The \s-1DOM\s0 Level 2 does not support editing the Document Type Declaration. docType cannot be altered in any way, including through the use of methods inherited from the Node interface, such as insertNode or removeNode.
.ie n .IP "$elem = $doc\->\fIgetDocumentElement()\fR;" 4
.el .IP "\f(CW$elem\fR = \f(CW$doc\fR\->\fIgetDocumentElement()\fR;" 4
.IX Item "$elem = $doc->getDocumentElement();"
\&\fIReturns\fR: the root Element of the Document.
.ie n .IP "$DOMImpl = $doc\->\fIgetImplementation()\fR;" 4
.el .IP "\f(CW$DOMImpl\fR = \f(CW$doc\fR\->\fIgetImplementation()\fR;" 4
.IX Item "$DOMImpl = $doc->getImplementation();"
\&\fIReturns\fR: the DOMImplementation object that handles this document.
.ie n .IP "$attr = $doc\->createAttribute($name);" 4
.el .IP "\f(CW$attr\fR = \f(CW$doc\fR\->createAttribute($name);" 4
.IX Item "$attr = $doc->createAttribute($name);"
Creates an Attr of the given \fIname\fR. Note that the Attr instance can then be set on an Element using the setAttributeNode method. To create an attribute with a qualified name and namespace \s-1URI\s0, use the \fIgdome_doc_createAttributeNS()\fR method.
.Sp
\&\fI\f(CI\*(C`name\*(C'\fI\fR: The name of the attribute
.Sp
\&\fIReturns\fR: a new Attr object with the nodeName attribute set to \fIname\fR, and localName, prefix, and namespaceURI set to undef. The value of the attribute is the empty string.
.ie n .IP "$attr = $doc\->createAttributeNS($namespaceURI,$qualifiedName);" 4
.el .IP "\f(CW$attr\fR = \f(CW$doc\fR\->createAttributeNS($namespaceURI,$qualifiedName);" 4
.IX Item "$attr = $doc->createAttributeNS($namespaceURI,$qualifiedName);"
Creates an attribute of the given qualified name and namespace \s-1URI\s0.
.Sp
\&\fI\f(CI\*(C`namespaceURI\*(C'\fI\fR: The namespace \s-1URI\s0 of the attribute to create
.Sp
\&\fI\f(CI\*(C`qualifiedName\*(C'\fI\fR: The qualified name of the attribute to create
.Sp
\&\fIReturns\fR: a new Attr object with the following attributes: \f(CW%Node\fR.nodeName = \fIqualifiedName\fR, \f(CW%Node\fR.namespaceURI = \fInamespaceURI\fR, \f(CW%Node\fR.prefix = prefix, extracted from \fIqualifiedName\fR, \f(CW%Node\fR.localName = localName, extracted from \fIqualifiedName\fR, \f(CW%Attr\fR.name = \fIqualifiedName\fR, \f(CW%Node\fR.nodeValue = the empty string.
.Sp
\&\f(CW\*(C`GDOME_NAMESPACE_ERR\*(C'\fR: Raised if the \fIqualifiedName\fR is malformed, if the \fIqualifiedName\fR has a prefix and the \fInamespaceURI\fR is \f(CW%NUKK\fR, if the \fIqualifiedName\fR has a prefix that is \*(L"xml\*(R" and the \fInamespaceURI\fR is different from \*(L"http://www.w3.org/XML/1998/namespace\*(R", or if the \fIqualifiedName\fR is \*(L"xmlns\*(R" and the \fInamespaceURI\fR is different from \*(L"http://www.w3.org/2000/xmlns/\*(R".
.ie n .IP "$cdata = $doc\->createCDATASection($data);" 4
.el .IP "\f(CW$cdata\fR = \f(CW$doc\fR\->createCDATASection($data);" 4
.IX Item "$cdata = $doc->createCDATASection($data);"
Creates a CDATASection node whose value is the specified string.
.Sp
\&\fI\f(CI\*(C`data\*(C'\fI\fR: The data for the CDATASection contents
.Sp
\&\fIReturns\fR: the new CDATASection object.
.ie n .IP "$comment = $doc\->createComment($data);" 4
.el .IP "\f(CW$comment\fR = \f(CW$doc\fR\->createComment($data);" 4
.IX Item "$comment = $doc->createComment($data);"
Creates a Comment node whose value is the specified string.
.Sp
\&\fI\f(CI\*(C`data\*(C'\fI\fR: The data for the comment contents
.Sp
\&\fIReturns\fR: the new Comment object.
.ie n .IP "$docFrag = $doc\->\fIcreateDocumentFragment()\fR;" 4
.el .IP "\f(CW$docFrag\fR = \f(CW$doc\fR\->\fIcreateDocumentFragment()\fR;" 4
.IX Item "$docFrag = $doc->createDocumentFragment();"
Creates an empty DocumentFragment object.
.Sp
\&\fIReturns\fR: the new DocumentFragment object.
.ie n .IP "$elem = $doc\->createElement($tagName);" 4
.el .IP "\f(CW$elem\fR = \f(CW$doc\fR\->createElement($tagName);" 4
.IX Item "$elem = $doc->createElement($tagName);"
Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object. To create an element with a qualified name and namespace \s-1URI\s0, use the \fIgdome_doc_createElementNS()\fR function.
.Sp
\&\fI\f(CI\*(C`tagName\*(C'\fI\fR: The name of the element type to instantiate.
.Sp
\&\fIReturns\fR: a new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to undef.
.ie n .IP "$elem = $doc\->createElementNS($namespaceURI,$qualifiedName);" 4
.el .IP "\f(CW$elem\fR = \f(CW$doc\fR\->createElementNS($namespaceURI,$qualifiedName);" 4
.IX Item "$elem = $doc->createElementNS($namespaceURI,$qualifiedName);"
Creates an element of the given qualified name and namespace \s-1URI\s0.
.Sp
\&\fI\f(CI\*(C`namespaceURI\*(C'\fI\fR: The namespace \s-1URI\s0 of the element to create
.Sp
\&\fI\f(CI\*(C`qualifiedName\*(C'\fI\fR: The qualified name of the element to create
.Sp
\&\fIReturns\fR: a new Element object with the following attributes: \f(CW%Node\fR.nodeName = \fIqualifiedName\fR, \f(CW%Node\fR.namespaceURI = \fInamespaceURI\fR, \f(CW%Node\fR.prefix = prefix, extracted from \fIqualifiedName\fR, \f(CW%Node\fR.localName = localName, extracted from \fIqualifiedName\fR, \f(CW%Element\fR.tagName = \fIqualifiedName\fR.
.Sp
\&\f(CW\*(C`GDOME_NAMESPACE_ERR\*(C'\fR: Raised if the \fIqualifiedName\fR is malformed, if the \fIqualifiedName\fR has a prefix and the \fInamespaceURI\fR is undef, or if the \fIqualifiedName\fR has a prefix that is \*(L"xml\*(R" and the \fInamespaceURI\fR is different from \*(L"http://www.w3.org/XML/1998/namespace\*(R".
.ie n .IP "$entRef = $doc\->createEntityReference($name);" 4
.el .IP "\f(CW$entRef\fR = \f(CW$doc\fR\->createEntityReference($name);" 4
.IX Item "$entRef = $doc->createEntityReference($name);"
Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference node is made the same as that of the corresponding Entity node.
.Sp
\&\fI\f(CI\*(C`name\*(C'\fI\fR: The name of the entity to reference
.Sp
\&\fIReturns\fR: the new EntityReference object.
.ie n .IP "$pi = $doc\->createProcessingInstruction($target,$data);" 4
.el .IP "\f(CW$pi\fR = \f(CW$doc\fR\->createProcessingInstruction($target,$data);" 4
.IX Item "$pi = $doc->createProcessingInstruction($target,$data);"
Creates a ProcessingInstruction node given the specified name and data strings.
.Sp
\&\fI\f(CI\*(C`target\*(C'\fI\fR: The target part of the processing instruction
.Sp
\&\fI\f(CI\*(C`data\*(C'\fI\fR: The data for the node
.Sp
\&\fIReturns\fR: The new ProcessingInstruction object.
.ie n .IP "$text = $doc\->createTextNode($data);" 4
.el .IP "\f(CW$text\fR = \f(CW$doc\fR\->createTextNode($data);" 4
.IX Item "$text = $doc->createTextNode($data);"
Creates a Text node given the specified string.
.Sp
\&\fI\f(CI\*(C`data\*(C'\fI\fR: The data for the node
.Sp
\&\fIReturns\fR: The new TextNode object.
.ie n .IP "$elem = $doc\->getElementById($elementId);" 4
.el .IP "\f(CW$elem\fR = \f(CW$doc\fR\->getElementById($elementId);" 4
.IX Item "$elem = $doc->getElementById($elementId);"
\&\fI\f(CI\*(C`elementId\*(C'\fI\fR: The unique id value for an element
.Sp
\&\fIReturns\fR: the Element whose \f(CW%ID\fR is given by \fIelementId\fR. If no such element exists, returns undef. Behavior is not defined if more than one element has this \f(CW%ID\fR.
.ie n .IP "$nodeList = $doc\->getElementsByTagName($tagname);" 4
.el .IP "\f(CW$nodeList\fR = \f(CW$doc\fR\->getElementsByTagName($tagname);" 4
.IX Item "$nodeList = $doc->getElementsByTagName($tagname);"
\&\fI\f(CI\*(C`tagName\*(C'\fI\fR: The name of the tag to match on. The special value * matches           all tags.
.Sp
\&\fIReturns\fR: a NodeList of all the elements with a given tag name in the order in which they are encountered in a preorder traversal of the Document tree.
.ie n .IP "$nodeList = $doc\->getElementsByTagNameNS($namespaceURI,$localName);" 4
.el .IP "\f(CW$nodeList\fR = \f(CW$doc\fR\->getElementsByTagNameNS($namespaceURI,$localName);" 4
.IX Item "$nodeList = $doc->getElementsByTagNameNS($namespaceURI,$localName);"
\&\fI\f(CI\*(C`namespaceURI\*(C'\fI\fR: The namespace \s-1URI\s0 of the elements to match on. The special                value * matches all namespaces.
.Sp
\&\fI\f(CI\*(C`localName\*(C'\fI\fR: The local name of the elements to match on. The special value             * matches all local names.
.Sp
\&\fIReturns\fR: a NodeList of all the descendant elements with a given local name and namespace \s-1URI\s0 in the order in which they are encountered in a preorder traversal of this Document tree.
.ie n .IP "$node = $doc\->importNode($importedNode,$deep);" 4
.el .IP "\f(CW$node\fR = \f(CW$doc\fR\->importNode($importedNode,$deep);" 4
.IX Item "$node = $doc->importNode($importedNode,$deep);"
Imports a node from another document to this document. The returned node has no parent; (parentNode is undef). The source node is not altered or removed from the original document; this method creates a new copy of the source node. \s-1DOCUMENT\s0, \s-1DOCUMENT_TYPE\s0, \s-1NOTATION\s0 and \s-1ENTITY\s0 nodes are not supported.
.Sp
\&\fI\f(CI\*(C`importedNode\*(C'\fI\fR: The node to import.
.Sp
\&\fI\f(CI\*(C`deep\*(C'\fI\fR: If 1, recursively import the subtree under the specified node;        if 0, import only the node itself. This has no effect on Attr,        EntityReference, and Notation nodes.
.Sp
\&\fIReturns\fR: the imported node that belongs to this Document.
.Sp
\&\f(CW\*(C`GDOME_NOT_SUPPORTED_ERR\*(C'\fR: Raised if the type of node being imported is not supported.
.ie n .IP "$str = $doc\->toString($mode);" 4
.el .IP "\f(CW$str\fR = \f(CW$doc\fR\->toString($mode);" 4
.IX Item "$str = $doc->toString($mode);"
Save the \s-1DOM\s0 tree of the Document to a string
.Sp
\&\fI\f(CI\*(C`mode\*(C'\fI\fR: the indentation mode wanted, either \s-1GDOME_SAVE_STANDARD\s0 or \s-1GDOME_SAVE_LIBXML_INDENT\s0
.Sp
\&\fIReturns\fR: string representation of \s-1DOM\s0 tree
.ie n .IP "$str = $doc\->toStringEnc($encoding,$mode);" 4
.el .IP "\f(CW$str\fR = \f(CW$doc\fR\->toStringEnc($encoding,$mode);" 4
.IX Item "$str = $doc->toStringEnc($encoding,$mode);"
Save the \s-1DOM\s0 tree of the Document to a string
.Sp
\&\fI\f(CI\*(C`mode\*(C'\fI\fR: the indentation mode wanted, either \s-1GDOME_SAVE_STANDARD\s0 or \s-1GDOME_SAVE_LIBXML_INDENT\s0
.Sp
\&\fI\f(CI\*(C`encoding\*(C'\fI\fR: character encoding to use when generating \s-1XML\s0 text
.Sp
\&\fIReturns\fR: string representation of \s-1DOM\s0 tree using the specified character encoding standard