From 37fda033a27c539ec9b25239b7317a8eed594637 Mon Sep 17 00:00:00 2001 From: Hannes Magnusson Date: Sun, 23 Dec 2007 22:26:16 +0000 Subject: [PATCH] MFB: Upgrade to the new-reference-structure && new-oo-style - (Created missing setup sections in setup.xml, if any) - Moved the intro to book.xml - Changed the intro ID from .intro to intro. - Moved the constants entity to book.xml - Changed constants.xml to be an appendix - Moved the encoding section to book.xml - Moved the content in configure.xml into setup.xml NOTE: Removed reference.xml and configure.xml git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248889 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/xmlreader/book.xml | 58 +++ reference/xmlreader/constants.xml | 6 +- reference/xmlreader/setup.xml | 64 ++++ reference/xmlreader/xmlreader.xml | 573 ++++++++++++++++++++++++++++++ 4 files changed, 698 insertions(+), 3 deletions(-) create mode 100644 reference/xmlreader/book.xml create mode 100644 reference/xmlreader/setup.xml create mode 100644 reference/xmlreader/xmlreader.xml diff --git a/reference/xmlreader/book.xml b/reference/xmlreader/book.xml new file mode 100644 index 0000000000..8d549c7bb6 --- /dev/null +++ b/reference/xmlreader/book.xml @@ -0,0 +1,58 @@ + + + + + XMLReader + + + + &reftitle.intro; + + The XMLReader extension is an XML Pull parser. The reader acts as a + cursor going forward on the document stream and stopping at each node + on the way. + + +
+ &reftitle.encoding; + + It is important to note that internally, libxml uses the UTF-8 encoding + and as such, the encoding of the retrieved contents will always be in + UTF-8 encoding. + +
+ + + + + + &reference.xmlreader.setup; + + &reference.xmlreader.xmlreader; + + + + + diff --git a/reference/xmlreader/constants.xml b/reference/xmlreader/constants.xml index 9a8489c6ab..f65329bd80 100644 --- a/reference/xmlreader/constants.xml +++ b/reference/xmlreader/constants.xml @@ -1,6 +1,6 @@ - -
+ + &reftitle.constants; &extension.constants; @@ -213,7 +213,7 @@ -
+ + + + &reftitle.setup; + + +
+ &reftitle.required; + &no.requirement; +
+ + + +
+ &reftitle.install; + + The XMLReader extension is available in PECL as of PHP 5.0.0 and is + included and enabled as of PHP 5.1.0 by default. It can be enabled + by adding the argument + (or before 5.1.0) + to your configure line. The libxml + extension is required. + +
+ + + +
+ &reftitle.runtime; + &no.config; +
+ + + +
+ &reftitle.resources; + &no.resource; +
+ + + + + + diff --git a/reference/xmlreader/xmlreader.xml b/reference/xmlreader/xmlreader.xml new file mode 100644 index 0000000000..d916f32655 --- /dev/null +++ b/reference/xmlreader/xmlreader.xml @@ -0,0 +1,573 @@ + + + + The XMLReader class + XMLReader + + + + +
+ &reftitle.intro; + + The XMLReader extension is an XML Pull parser. The reader acts as a + cursor going forward on the document stream and stopping at each node + on the way. + +
+ + +
+ Class synopsis + + + + XMLReader + + + + + XMLReader + + + + + Constants + + + const + int + XMLReader::NONE + 0 + + + const + int + XMLReader::ELEMENT + 1 + + + const + int + XMLReader::ATTRIBUTE + 2 + + + const + int + XMLReader::TEXT + 3 + + + const + int + XMLReader::CDATA + 4 + + + const + int + XMLReader::ENTITY_REF + 5 + + + const + int + XMLReader::ENTITY + 6 + + + const + int + XMLReader::PI + 7 + + + const + int + XMLReader::COMMENT + 8 + + + const + int + XMLReader::DOC + 9 + + + const + int + XMLReader::DOC_TYPE + 10 + + + const + int + XMLReader::DOC_FRAGMENT + 11 + + + const + int + XMLReader::NOTATION + 12 + + + const + int + XMLReader::WHITESPACE + 13 + + + const + int + XMLReader::SIGNIFICANT_WHITESPACE + 14 + + + const + int + XMLReader::END_ELEMENT + 15 + + + const + int + XMLReader::END_ENTITY + 16 + + + const + int + XMLReader::XML_DECLARATION + 17 + + + const + int + XMLReader::LOADDTD + 1 + + + const + int + XMLReader::DEFAULTATTRS + 2 + + + const + int + XMLReader::VALIDATE + 3 + + + const + int + XMLReader::SUBST_ENTITIES + 4 + + + Properties + + + public + readonly + int + attributeCount + + + public + readonly + string + baseURI + + + public + readonly + int + depth + + + public + readonly + bool + hasAttributes + + + public + readonly + bool + hasValue + + + public + readonly + bool + isDefault + + + public + readonly + bool + isEmptyElement + + + public + readonly + string + localName + + + public + readonly + string + name + + + public + readonly + string + namespaceURI + + + public + readonly + int + nodeType + + + public + readonly + string + prefix + + + public + readonly + string + value + + + public + readonly + string + xmlLang + + + + Methods + + + + + +
+ + +
+ &reftitle.properties; + + + attributeCount + + + The number of attributes on the node + + + + + + baseURI + + The base URI of the node + + + + + depth + + Depth of the node in the tree, starting at 0 + + + + + hasAttributes + + Indicates if node has attributes + + + + + hasValue + + Indicates if node has a text value + + + + + isDefault + + Indicates if attribute is defaulted from DTD + + + + + isEmptyElement + + Indicates if node is an empty element tag + + + + + localName + + The local name of the node + + + + + name + + The qualified name of the node + + + + + namespaceURI + + The URI of the namespace associated with the node + + + + + nodeType + + The node type for the node + + + + + prefix + + The prefix of the namespace associated with thenode + + + + + value + + The text value of the node + + + + + xmlLang + + The xml:lang scope which the node resides + + + + +
+ + + +
+ &reftitle.constants; +
+ XMLReader Node Types + + + + XMLReader::NONE + + No node type + + + + + XMLReader::ELEMENT + + Start element + + + + + XMLReader::ATTRIBUTE + + Attribute node + + + + + XMLReader::TEXT + + Text node + + + + + XMLReader::CDATA + + CDATA node + + + + + XMLReader::ENTITY_REF + + Entity Reference node + + + + + XMLReader::ENTITY + + Entity Declaration node + + + + + XMLReader::PI + + Processing Instruction node + + + + + XMLReader::COMMENT + + Comment node + + + + + XMLReader::DOC + + Document node + + + + + XMLReader::DOC_TYPE + + Document Type node + + + + + XMLReader::DOC_FRAGMENT + + Document Fragment node + + + + + XMLReader::NOTATION + + Notation node + + + + + XMLReader::WHITESPACE + + Whitespace node + + + + + XMLReader::SIGNIFICANT_WHITESPACE + + Significant Whitespace node + + + + + XMLReader::END_ELEMENT + + End Element + + + + + XMLReader::END_ENTITY + + End Entity + + + + + XMLReader::XML_DECLARATION + + XML Declaration node + + + + +
+ +
+ XMLReader Parser Options + + + + + XMLReader::LOADDTD + + Load DTD but do not validate + + + + + XMLReader::DEFAULTATTRS + + Load DTD and default attributes but do not validate + + + + + XMLReader::VALIDATE + + Load DTD and validate while parsing + + + + + XMLReader::SUBST_ENTITIES + + Substitute entities and expand references + + + + +
+
+ + + + &reference.xmlreader.entities.xmlreader; + + + + +