Class: XMLNode

[line 141]
XMLNode stores all the XML nodes of your document.

New in 1.2:

• New $cdata property so that it knows to wrap the contents properly in the write () method.

New in 1.4:

• Added method query (), which allows users to traverse a set of nodes more easily and more legibly by using the most basic subset of XPath. Currently supports only the most basic syntax (/node1/node2/node3).

New in 1.6:

• Added a space before the slash in self-closing tags, so as to be able to work with cross-browser-compatible XHTML markup.

New in 1.8:

• Added line breaks and tabs to the write() method, so that XMLDoc produces legible XML output. Set $level to -1 to signify no auto-indenting.

New in 2.0:

• Added a makeObj() method, which is helpful in passing nodes around like one would database query results.

New in 2.2:

• Added a makeRefObj() method, which is similar to makeObj(), but takes references to the document structure instead, so any modifications to the object returned are actually being made to the XML structure as well.

New in 2.4:

• makeObj() and makeRefObj() now handle multiple child nodes with the same name by turning them into an array of their $content properties.

New in 2.6:

• Added a new parameter to the query() method that lets you return an array of references to the resulting nodes instead of copies. This makes it easier to use the query() method in conjunction with document updates.

New in 3.0:

• Changed query() so that it uses saf.XML.Doc.Query instead of processing the query itself.
• Added a path() method which returns the unique path (as understood by saf.XML.Doc.Query) to the current node.
• Added a $parent property, which references the parent node (if not the root node).
• Added a $number property, which keeps track of the position of this node within similarly-named children of its parent.
• Added the makeMenu() and _makeMenu() methods, which turn the current node and its children into a saf.GUI.Menu object, making it easy to display a document as a hierarchy using templates.

New in 3.2:

• $callbackStart
• $callbackEnd
• $callbackObject
• $propagateCallback

New methods:

• setCallback()
• propagateCallback()

These new pieces add the ability to easily define custom callback functions to handle the starting and ending tags of a node, essentially implementing a form of XML transformations in pure PHP (read: EASY). For an example of a simple callback usage, check out saf.XML.SLiP.Writer in saf/docs or DocReader. This example package implements an XML to SLiP conversion. SLiP is a simplified markup language that can be used to express hierarchies in the same way that XML can, but is much quicker to read and write making it ideal for pseudocode applications.

New in 3.4:

• Modified makeObj() so that empty child nodes would be set as properties with a value of 'true' (boolean). This change was not made to makeRefObj() however, because it is more proper in that case to refer to the empty contents of the node, which is often the purpose of the reference to begin with.

New in 3.6:

• Modified path() to start counting path numbers at 1 instead of 0.
• Added an $xquery property, and modified query() to work with the new saf.XML.Doc.Query package.

New in 3.8:

• Added named aliases to each child, so that they may be referred to by name for convenience. For example: $doc->_html->_head->_title->content or $doc->_html->_body->_h1->content). Note the underscores, used to prevent naming conflicts. In the case where there are more than one child of the same name, the _name alias is turned into a numbered array.

1     <?php
2     
3      $foo =& new XMLNode ('foo');
4      $bar =& $foo->addChild ('bar', 'qwerty');
5      $foobar =& $foo->addChild ('foobar');
6      $foobar->setAttribute ('asdf', 'fdsa');
7      echo $foo->write ();
8     
9      --- Output:
10     <foo><bar>qwerty</bar><foobar asdf="fdsa"/></foo>
11    
12     ? >

Tags:

$attributes = array ()

[line 172]

Array of attribute objects.

Tags:

$callbackEnd =  false

[line 226]

The function or method to use as a callback for the end tag of the current XML node.

Tags:

$callbackObject =  false

[line 236]

The object that contains the methods listed in $callbackStart and $callbackEnd (if they are methods and not ordinary custom or built-in PHP functions).

Tags:

$callbackStart =  false

[line 217]

The function or method to use as a callback for the start tag of the current XML node.

Tags:

$cdata =  false

[line 190]

Notes whether the contents of this node should be displayed as a <![CDATA[ ... ]]> block.

Tags:

$children = array ()

[line 164]

Array of child node objects.

Tags:

$comment =

[line 181]

Attach a comment to the node, which will appear as an XML comment tag above the element.

Tags:

$content =

[line 156]

Content of the node.

Tags:

$name =

[line 148]

Name of the node.

Tags:

$number =  0

[line 199]

Contains the number of this node within its parent node. Numbers only increase when more than one child has the same name.

Tags:

$parent =  false

[line 208]

Contains a reference to the parent of this node, or false if this is the root node of the document.

Tags:

$propagateCallback =  false

[line 245]

Whether or not to propagate callback settings to new child nodes upon their creation. Defaults to false.

Tags:

$xquery =

[line 253]

If query() has been called, this will contain the XMLDocQuery object.

Tags:

---

constructor XMLNode [line 263]

---

method addChild [line 282]

---

method makeMenu [line 726]

---

method makeObj [line 593]

---

method makeRefObj [line 643]

---

method path [line 564]

---

method propagateCallback [line 399]

---

method query [line 547]

---

method setAttribute [line 324]

---

method setCallback [line 342]

---

method write [line 423]