From 7fde5c7d758f8c2809fec99ce36b05043847224a Mon Sep 17 00:00:00 2001 From: Hannes Magnusson Date: Sun, 16 Dec 2007 13:10:43 +0000 Subject: [PATCH] MFB: Upgrade to the new-reference-structure - Moved the intro from reference.xml to book.xml - Change the intro ID to intro. - Added setup - Changed the constants section to be git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248356 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/dom/book.xml | 123 +++++++ reference/dom/constants.xml | 6 +- reference/dom/domattr.xml | 160 +++++++++ reference/dom/domcharacterdata.xml | 122 +++++++ reference/dom/domcomment.xml | 88 +++++ reference/dom/domdocument.xml | 368 +++++++++++++++++++++ reference/dom/domdocumentfragment.xml | 119 +++++++ reference/dom/domdocumenttype.xml | 200 +++++++++++ reference/dom/domelement.xml | 128 +++++++ reference/dom/domentity.xml | 205 ++++++++++++ reference/dom/domentityreference.xml | 127 +++++++ reference/dom/domexception.xml | 137 ++++++++ reference/dom/domimplementation.xml | 115 +++++++ reference/dom/domnamednodemap.xml | 115 +++++++ reference/dom/domnode.xml | 297 +++++++++++++++++ reference/dom/domnodelist.xml | 115 +++++++ reference/dom/domnotation.xml | 150 +++++++++ reference/dom/domprocessinginstruction.xml | 130 ++++++++ reference/dom/domtext.xml | 117 +++++++ reference/dom/domxpath.xml | 112 +++++++ reference/dom/reference.xml | 4 +- reference/dom/setup.xml | 57 ++++ 22 files changed, 2989 insertions(+), 6 deletions(-) create mode 100644 reference/dom/book.xml create mode 100644 reference/dom/domattr.xml create mode 100644 reference/dom/domcharacterdata.xml create mode 100644 reference/dom/domcomment.xml create mode 100644 reference/dom/domdocument.xml create mode 100644 reference/dom/domdocumentfragment.xml create mode 100644 reference/dom/domdocumenttype.xml create mode 100644 reference/dom/domelement.xml create mode 100644 reference/dom/domentity.xml create mode 100644 reference/dom/domentityreference.xml create mode 100644 reference/dom/domexception.xml create mode 100644 reference/dom/domimplementation.xml create mode 100644 reference/dom/domnamednodemap.xml create mode 100644 reference/dom/domnode.xml create mode 100644 reference/dom/domnodelist.xml create mode 100644 reference/dom/domnotation.xml create mode 100644 reference/dom/domprocessinginstruction.xml create mode 100644 reference/dom/domtext.xml create mode 100644 reference/dom/domxpath.xml create mode 100644 reference/dom/setup.xml diff --git a/reference/dom/book.xml b/reference/dom/book.xml new file mode 100644 index 0000000000..d85eb0ed2e --- /dev/null +++ b/reference/dom/book.xml @@ -0,0 +1,123 @@ + + + + + + + DOM Extension + DOM + + + &reftitle.intro; + + The DOM extension allows you to operate on XML documents through the DOM + API with PHP 5. + + + For PHP 4, use DOM XML. + + + + DOM extension uses UTF-8 encoding. Use utf8_encode + and utf8_decode to work with texts in ISO-8859-1 + encoding or Iconv for other encodings. + + + + + &reference.dom.setup; + &reference.dom.constants; + + + &reference.dom.domattr; + &reference.dom.domcharacterdata; + &reference.dom.domcomment; + &reference.dom.domdocument; + &reference.dom.domdocumentfragment; + &reference.dom.domdocumenttype; + &reference.dom.domelement; + &reference.dom.domentity; + &reference.dom.domentityreference; + &reference.dom.domexception; + &reference.dom.domimplementation; + &reference.dom.domnamednodemap; + &reference.dom.domnode; + &reference.dom.domnodelist; + &reference.dom.domnotation; + &reference.dom.domprocessinginstruction; + &reference.dom.domtext; + &reference.dom.domxpath; + + + + + diff --git a/reference/dom/constants.xml b/reference/dom/constants.xml index 9f523de3c7..fcda7492ea 100644 --- a/reference/dom/constants.xml +++ b/reference/dom/constants.xml @@ -1,6 +1,6 @@ - -
+ + &reftitle.constants; &extension.constants; @@ -405,7 +405,7 @@
-
+ + + The <classname>DOMAttr</classname> class + DOMAttr + + + + +
+ &reftitle.intro; + + DOMAttr represents an attribute in the + DOMElement object. + +
+ + +
+ Class synopsis + + + + DOMAttr + + + + + DOMAttr + + + + + extends + DOMNode + + + + + + Properties + + + public + readonly + string + name + + + public + readonly + DOMElement + ownerElement + + + public + readonly + bool + schemaTypeInfo + + + public + readonly + bool + specified + + + public + string + value + + + Methods + + + + Inherited methods + + + + + +
+ + +
+ &reftitle.properties; + + + name + + The name of the attribute + + + + ownerElement + + The element which contains the attribute + + + + schemaTypeInfo + + Not implemented yet, always is &null; + + + + specified + + Not implemented yet, always is &null; + + + + value + + The value of the attribute + + + +
+ + + +
+ &reftitle.seealso; + + + W3C specification of Attr + + +
+ + + + + &reference.dom.entities.domattr; + + + + + diff --git a/reference/dom/domcharacterdata.xml b/reference/dom/domcharacterdata.xml new file mode 100644 index 0000000000..94e6aebf1c --- /dev/null +++ b/reference/dom/domcharacterdata.xml @@ -0,0 +1,122 @@ + + + + The DOMCharacterData class + DOMCharacterData + + + + +
+ &reftitle.intro; + + Represents nodes with character data. No nodes directly correspond to + this class, but other nodes do inherit from it. + +
+ + +
+ Class synopsis + + + + DOMCharacterData + + + + + DOMCharacterData + + + + + extends + DOMNode + + + + + + Properties + + + public + string + data + + + readonly + public + int + length + + + Methods + + + + Inherited methods + + + + + +
+ + +
+ &reftitle.properties; + + + data + + The contents of the node. + + + + length + + The length of the contents. + + + +
+ + +
+ &reftitle.seealso; + + + W3C specification of CharacterData + + +
+ + + + &reference.dom.entities.domcharacterdata; + + + + + diff --git a/reference/dom/domcomment.xml b/reference/dom/domcomment.xml new file mode 100644 index 0000000000..0190432d11 --- /dev/null +++ b/reference/dom/domcomment.xml @@ -0,0 +1,88 @@ + + + + The DOMComment class + DOMComment + + + + +
+ &reftitle.intro; + + Represents comment nodes, characters delimited by <!-- + and -->. + +
+ + +
+ Class synopsis + + + + DOMComment + + + + + DOMComment + + + + + extends + DOMCharacterData + + + + + + Methods + + + + Inherited methods + + + + + +
+ +
+ &reftitle.seealso; + + + W3C specification of Comment + + +
+ + + + &reference.dom.entities.domcomment; + + + + + diff --git a/reference/dom/domdocument.xml b/reference/dom/domdocument.xml new file mode 100644 index 0000000000..afecd7d8b6 --- /dev/null +++ b/reference/dom/domdocument.xml @@ -0,0 +1,368 @@ + + + + The DOMDocument class + DOMDocument + + + + +
+ &reftitle.intro; + + Represents an entire HTML or XML document; serves as the root of the + document tree. + +
+ + +
+ Class synopsis + + + + DOMDocument + + + + + DOMDocument + + + + + extends + DOMNode + + + + + + Properties + + + readonly + public + string + actualEncoding + + + readonly + public + DOMConfiguration + config + + + readonly + public + DOMDocumentType + doctype + + + readonly + public + DOMElement + documentElement + + + public + string + documentURI + + + public + string + encoding + + + public + bool + formatOutput + + + readonly + public + DOMImplementation + implementation + + + public + bool + preserveWhiteSpace + true + + + public + bool + recover + + + public + bool + resolveExternals + + + public + bool + standalone + + + public + bool + strictErrorChecking + true + + + public + bool + substituteEntities + + + public + bool + validateOnParse + false + + + public + string + version + + + readonly + public + string + xmlEncoding + + + public + bool + xmlStandalone + + + public + string + xmlVersion + + + Methods + + + + Inherited methods + + + + + +
+ + +
+ &reftitle.properties; + + + actualEncoding + + + Deprecated. Actual encoding of the document, + is a readonly equivalent to + encoding. + + + + + config + + + Deprecated. Configuration used when + DOMDocument::normalizeDocument is + invoked. + + + + + doctype + + The Document Type Declaration associated with this document. + + + + documentElement + + + This is a convenience attribute that allows direct access to the + child node that is the document element of the document. + + + + + documentURI + + The location of the document or &null; if undefined. + + + + encoding + + + Encoding of the document, as specified by the XML declaration. This + attribute is not present in the final DOM Level 3 specification, but + is the only way of manipulating XML document encoding in this + implementation. + + + + + formatOutput + + Nicely formats output with indentation and extra space. + + + + implementation + + + The DOMImplementation object that handles + this document. + + + + + preserveWhiteSpace + + Do not remove redundant white space. Default to &true;. + + + + recover + + + Proprietary. Enables recovery mode, i.e. trying + to parse non-well formed documents. This attribute is not part of + the DOM specification and is specific to libxml. + + + + + resolveExternals + + + Set it to &true; to load external entities from a doctype + declaration. This is useful for including character entities in + your XML document. + + + + + standalone + + + Deprecated. Whether or not the document is + standalone, as specified by the XML declaration, corresponds to + xmlStandalone. + + + + + strictErrorChecking + + Throws DOMException on errors. Default to &true;. + + + + substituteEntities + + + Proprietary. Whether or not to substitute + entities. This attribute is not part of + the DOM specification and is specific to libxml. + + + + + validateOnParse + + Loads and validates against the DTD. Default to &false;. + + + + version + + + Deprecated. Version of XML, corresponds to + xmlVersion + + + + + xmlEncoding + + + An attribute specifying, as part of the XML declaration, the + encoding of this document. This is &null; when unspecified or when it + is not known, such as when the Document was created in memory. + + + + + xmlStandalone + + + An attribute specifying, as part of the XML declaration, whether + this document is standalone. This is &false; when unspecified. + + + + + xmlVersion + + + An attribute specifying, as part of the XML declaration, the + version number of this document. If there is no declaration and if + this document supports the "XML" feature, the value is "1.0". + + + + +
+ + + +
+ &reftitle.seealso; + + + W3C specification for Document + + +
+ + + + + &reference.dom.entities.domdocument; + + + + + diff --git a/reference/dom/domdocumentfragment.xml b/reference/dom/domdocumentfragment.xml new file mode 100644 index 0000000000..04205be368 --- /dev/null +++ b/reference/dom/domdocumentfragment.xml @@ -0,0 +1,119 @@ + + + + The DOMDocumentFragment class + DOMDocumentFragment + + + + + + + +
+ Class synopsis + + + + DOMDocumentFragment + + + + + DOMDocumentFragment + + + + + extends + DOMNode + + + + + + Properties + + + + Methods + + + + Inherited methods + + + + + +
+ + + + + + + + + + + + &reference.dom.entities.domdocumentfragment; + + + + + diff --git a/reference/dom/domdocumenttype.xml b/reference/dom/domdocumenttype.xml new file mode 100644 index 0000000000..d5c8a3a479 --- /dev/null +++ b/reference/dom/domdocumenttype.xml @@ -0,0 +1,200 @@ + + + + The DOMDocumentType class + DOMDocumentType + + + + +
+ &reftitle.intro; + + Each DOMDocument has a doctype + attribute whose value is either &null; or a DOMDocumentType object. + +
+ + +
+ Class synopsis + + + + DOMDocumentType + + + + + DOMDocumentType + + + + + extends + DOMNode + + + + + + Properties + + + readonly + public + string + publicId + + + readonly + public + string + systemId + + + readonly + public + string + name + + + readonly + public + DOMNamedNodeMap + entities + + + readonly + public + DOMNamedNodeMap + notations + + + readonly + public + string + internalSubset + + + + + + Inherited methods + + + + + +
+ + +
+ &reftitle.properties; + + + publicId + + The public identifier of the external subset. + + + + systemId + + + The system identifier of the external subset. This may be an + absolute URI or not. + + + + + name + + + The name of DTD; i.e., the name immediately following the + DOCTYPE keyword. + + + + + entities + + + A DOMNamedNodeMap containing the general + entities, both external and internal, declared in the DTD. + + + + + notations + + + A DOMNamedNodeMap containing the notations + declared in the DTD. + + + + + internalSubset + + + The internal subset as a string, or null if there is none. This is + does not contain the delimiting square brackets. + + + + +
+ + + + + + + + + + + + + + + + + + + + + + diff --git a/reference/dom/domelement.xml b/reference/dom/domelement.xml new file mode 100644 index 0000000000..88bf9d5546 --- /dev/null +++ b/reference/dom/domelement.xml @@ -0,0 +1,128 @@ + + + + The DOMElement class + DOMElement + + + + + + + +
+ Class synopsis + + + + DOMElement + + + + + DOMElement + + + + + extends + DOMNode + + + + + + Properties + + + readonly + public + bool + schemaTypeInfo + + + readonly + public + string + tagName + + + Methods + + + + Inherited methods + + + + + +
+ + +
+ &reftitle.properties; + + + schemaTypeInfo + + Not implemented yet, always return &null; + + + + tagName + + The element name + + + +
+ + + + + + + + + &reference.dom.entities.domelement; + + + + + diff --git a/reference/dom/domentity.xml b/reference/dom/domentity.xml new file mode 100644 index 0000000000..b0a54fb077 --- /dev/null +++ b/reference/dom/domentity.xml @@ -0,0 +1,205 @@ + + + + The DOMEntity class + DOMEntity + + + + +
+ &reftitle.intro; + + This interface represents a known entity, either parsed or unparsed, in an XML document. + +
+ + +
+ Class synopsis + + + + DOMEntity + + + + + DOMEntity + + + + + extends + DOMNode + + + + + + Properties + + + readonly + public + string + publicId + + + readonly + public + string + systemId + + + readonly + public + string + notationName + + + public + string + actualEncoding + + + readonly + public + string + encoding + + + readonly + public + string + version + + + + + Inherited methods + + + + + +
+ + +
+ &reftitle.properties; + + + publicId + + + The public identifier associated with the entity if specified, and + &null; otherwise. + + + + + systemId + + + The system identifier associated with the entity if specified, and + &null; otherwise. This may be an absolute URI or not. + + + + + notationName + + + For unparsed entities, the name of the notation for the entity. For + parsed entities, this is &null;. + + + + + actualEncoding + + + An attribute specifying the encoding used for this entity at the + time of parsing, when it is an external parsed entity. This is + &null; if it an entity from the internal subset or if it is not + known. + + + + + encoding + + + An attribute specifying, as part of the text declaration, the + encoding of this entity, when it is an external parsed entity. This + is &null; otherwise. + + + + + version + + + An attribute specifying, as part of the text declaration, the + version number of this entity, when it is an external parsed + entity. This is &null; otherwise. + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + diff --git a/reference/dom/domentityreference.xml b/reference/dom/domentityreference.xml new file mode 100644 index 0000000000..688e02cfe3 --- /dev/null +++ b/reference/dom/domentityreference.xml @@ -0,0 +1,127 @@ + + + + + The DOMEntityReference class + DOMEntityReference + + + + + + + +
+ Class synopsis + + + + DOMEntityReference + + + + + DOMEntityReference + + + + + extends + DOMNode + + + + + + Properties + + + + Methods + + + + Inherited methods + + + + + +
+ + + + + + + + + + + + &reference.dom.entities.domentityreference; + + + + + diff --git a/reference/dom/domexception.xml b/reference/dom/domexception.xml new file mode 100644 index 0000000000..b73b399060 --- /dev/null +++ b/reference/dom/domexception.xml @@ -0,0 +1,137 @@ + + + + + The DOMException class + DOMException + + + + +
+ &reftitle.intro; + + DOM operations raise exceptions under particular circumstances, i.e., + when an operation is impossible to perform for logical reasons. + + + See also . + +
+ + +
+ Class synopsis + + + + DOMException + + + + + DOMException + + + + + extends + Exception + + + + + + Properties + + + readonly + public + int + code + + + + + + + + + +
+ + +
+ &reftitle.properties; + + + code + + An integer indicating the type of error generated + + + +
+ + + + + + + + + + + + + + + + + + + + + + diff --git a/reference/dom/domimplementation.xml b/reference/dom/domimplementation.xml new file mode 100644 index 0000000000..8f4ce350ed --- /dev/null +++ b/reference/dom/domimplementation.xml @@ -0,0 +1,115 @@ + + + + + The DOMImplementation class + DOMImplementation + + + + +
+ &reftitle.intro; + + The DOMImplementation interface provides a number + of methods for performing operations that are independent of any + particular instance of the document object model. + +
+ + +
+ Class synopsis + + + + DOMImplementation + + + + + DOMImplementation + + + + + + Properties + + + + Methods + + + + + +
+ + + + + + + + + + + + &reference.dom.entities.domimplementation; + + + + + diff --git a/reference/dom/domnamednodemap.xml b/reference/dom/domnamednodemap.xml new file mode 100644 index 0000000000..b54c0fa9a0 --- /dev/null +++ b/reference/dom/domnamednodemap.xml @@ -0,0 +1,115 @@ + + + + + The DOMNamedNodeMap class + DOMNamedNodeMap + + + + + + + +
+ Class synopsis + + + + DOMNamedNodeMap + + + + + DOMNamedNodeMap + + + + + + Properties + + + + Methods + + + + + +
+ + + + + + + + + + + + &reference.dom.entities.domnamednodemap; + + + + + diff --git a/reference/dom/domnode.xml b/reference/dom/domnode.xml new file mode 100644 index 0000000000..d43c625e65 --- /dev/null +++ b/reference/dom/domnode.xml @@ -0,0 +1,297 @@ + + + + The DOMNode class + DOMNode + + + + + +
+ Class synopsis + + + + DOMNode + + + + + DOMNode + + + + + + Properties + + + public + readonly + string + nodeName + + + public + string + nodeValue + + + public + readonly + int + nodeType + + + public + readonly + DOMNode + parentNode + + + public + readonly + DOMNodeList + childNodes + + + public + readonly + DOMNode + firstChild + + + public + readonly + DOMNode + lastChild + + + public + readonly + DOMNode + previousSibling + + + public + readonly + DOMNode + nextSibling + + + public + readonly + DOMNamedNodeMap + attributes + + + public + readonly + DOMDocument + ownerDocument + + + public + readonly + string + namespaceURI + + + public + string + prefix + + + public + readonly + string + localName + + + public + readonly + string + baseURI + + + public + string + textContent + + Methods + + + + +
+ + +
+ &reftitle.properties; + + + nodeName + + Returns the most accurate name for the current node type + + + + nodeValue + + The value of this node, depending on its type + + + + nodeType + + Gets the type of the node. One of the predefined XML_xxx_NODE constants + + + + parentNode + + The parent of this node + + + + childNodes + + + A DOMNodeList that contains all + children of this node. If there are no children, this is an empty + DOMNodeList. + + + + + firstChild + + + The first child of this node. If there is no such node, this + returns &null;. + + + + + lastChild + + The last child of this node. If there is no such node, this returns &null;. + + + + previousSibling + + + The node immediately preceding this node. If there is no such + node, this returns &null;. + + + + + nextSibling + + + The node immediately following this node. If there is no such + node, this returns &null;. + + + + + attributes + + + A DOMNamedNodeMap containing the + attributes of this node (if it is a DOMElement) + or &null; otherwise. + + + + + ownerDocument + + The DOMDocument object associated with this node. + + + + namespaceURI + + The namespace URI of this node, or &null; if it is unspecified. + + + + prefix + + The namespace prefix of this node, or &null; if it is unspecified. + + + + localName + + Returns the local part of the qualified name of this node. + + + + baseURI + + + The absolute base URI of this node or &null; if the implementation + wasn't able to obtain an absolute URI. + + + + + textContent + + This attribute returns the text content of this node and its descendants. + + + +
+ + + +
+ &reftitle.seealso; + + + W3C specification of Node + + +
+ + + + + &reference.dom.entities.domnode; + + + + + diff --git a/reference/dom/domnodelist.xml b/reference/dom/domnodelist.xml new file mode 100644 index 0000000000..8f52b5a1eb --- /dev/null +++ b/reference/dom/domnodelist.xml @@ -0,0 +1,115 @@ + + + + + The DOMNodeList class + DOMNodeList + + + + + + + +
+ Class synopsis + + + + DOMNodeList + + + + + DOMNodeList + + + + + + Properties + + + readonly + public + int + length + + + Methods + + + + + +
+ + +
+ &reftitle.properties; + + + length + + + The number of nodes in the list. The range of valid child node + indices is 0 to length - 1 inclusive. + + + + +
+ + + + + + + + + &reference.dom.entities.domnodelist; + + + + + diff --git a/reference/dom/domnotation.xml b/reference/dom/domnotation.xml new file mode 100644 index 0000000000..ffbce3ea39 --- /dev/null +++ b/reference/dom/domnotation.xml @@ -0,0 +1,150 @@ + + + + + The DOMNotation class + DOMNotation + + + + + + + +
+ Class synopsis + + + + DOMNotation + + + + + DOMNotation + + + + + extends + DOMNode + + + + + + Properties + + + readonly + public + string + publicId + + + readonly + public + string + systemId + + + + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + publicId + + Prop description + + + + + systemId + + Prop description + + + + +
+ + + + + + + + + + + + + + + + + + + + + + diff --git a/reference/dom/domprocessinginstruction.xml b/reference/dom/domprocessinginstruction.xml new file mode 100644 index 0000000000..ffbf4cb206 --- /dev/null +++ b/reference/dom/domprocessinginstruction.xml @@ -0,0 +1,130 @@ + + + + The DOMProcessingInstruction class + DOMProcessingInstruction + + + + + + + +
+ Class synopsis + + + + DOMProcessingInstruction + + + + + DOMProcessingInstruction + + + + + extends + DOMNode + + + + + + Properties + + + readonly + public + string + target + + + public + string + data + + + Methods + + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + target + + Prop description + + + + + data + + Prop description + + + + +
+ + + + + + + + + &reference.dom.entities.domprocessinginstruction; + + + + + diff --git a/reference/dom/domtext.xml b/reference/dom/domtext.xml new file mode 100644 index 0000000000..6b8bac3782 --- /dev/null +++ b/reference/dom/domtext.xml @@ -0,0 +1,117 @@ + + + + The DOMText class + DOMText + + + + + + + +
+ Class synopsis + + + + DOMText + + + + + DOMText + + + + + extends + DOMCharacterData + + + + + + Properties + + + readonly + public + string + wholeText + + + Methods + + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + wholeText + + Prop description + + + +
+ + + + + + + + + &reference.dom.entities.domtext; + + + + + diff --git a/reference/dom/domxpath.xml b/reference/dom/domxpath.xml new file mode 100644 index 0000000000..f1c9ec39a0 --- /dev/null +++ b/reference/dom/domxpath.xml @@ -0,0 +1,112 @@ + + + + + The DOMXPath class + DOMXPath + + + + + + + +
+ Class synopsis + + + + DOMXPath + + + + + DOMXPath + + + + + + Properties + + + public + DOMDocument + document + + + Methods + + + + + +
+ + + +
+ &reftitle.properties; + + + document + + Prop description + + + +
+ + + + + + + + + &reference.dom.entities.domxpath; + + + + + diff --git a/reference/dom/reference.xml b/reference/dom/reference.xml index 0e87ff40ce..6705db1f7c 100644 --- a/reference/dom/reference.xml +++ b/reference/dom/reference.xml @@ -1,7 +1,5 @@ - - - + DOM Functions diff --git a/reference/dom/setup.xml b/reference/dom/setup.xml new file mode 100644 index 0000000000..1020272af9 --- /dev/null +++ b/reference/dom/setup.xml @@ -0,0 +1,57 @@ + + + + + &reftitle.setup; + + +
+ &reftitle.required; + &no.requirement; +
+ + + +
+ &reftitle.install; + &no.install; +
+ + + +
+ &reftitle.runtime; + &no.config; +
+ + + +
+ &reftitle.resources; + &no.resource; +
+ + + + + +