]> granicus.if.org Git - php/commitdiff
Add some minimalistic documentation
authorMarcus Boerger <helly@php.net>
Thu, 8 Jan 2004 21:14:38 +0000 (21:14 +0000)
committerMarcus Boerger <helly@php.net>
Thu, 8 Jan 2004 21:14:38 +0000 (21:14 +0000)
ext/simplexml/README [new file with mode: 0755]

diff --git a/ext/simplexml/README b/ext/simplexml/README
new file mode 100755 (executable)
index 0000000..9a86715
--- /dev/null
@@ -0,0 +1,29 @@
+SimpleXML is meant to be an easy way to access XML data.
+
+SimpleXML objects follow four basic rules:
+
+1) properties denote elements
+2) numeric indices denote elements
+3) non numeric indices denote attributes
+4) string conversion allows to access TEXT data
+
+When an elements TEXT data is being accessed through a property
+then the result does not include the TEXT data of subelements.
+
+If PHP is compiled with ext/SPL being compiled into the binary
+then SimpleXML objects implement the interface RecursiveIterator 
+so that they can be iterated recursively (http://pecl.php.net/spl).
+
+Known issues
+============
+
+Due to engine problems it is currently not possible to access
+a subelement by index 0: $object->property[0].
+
+TODO
+====
+
+At the moment property access to multiple elements of the same
+name returns an array of SimpleXML objetcs. This should be an 
+object of a new type instead so that all kinds of linkage,
+assignment and deleting would work.
\ No newline at end of file