Docs For Class HTML

[line 64]
HTML_TreeMenu Class

A simple couple of PHP classes and some not so simple Jabbascript which produces a tree menu. In IE this menu is dynamic, with branches being collapsable. In IE5+ the status of the collapsed/open branches persists across page refreshes.In any other browser the tree is static. Code is based on work of Harald Radi.

Usage.

After installing the package, copy the example php script to your servers document root. Also place the TreeMenu.js and the images folder in the same place. Running the script should then produce the tree.

Thanks go to Chip Chapin (http://www.chipchapin.com) for many excellent ideas and improvements.

Author: Harald Radi <harald.radi@nme.at>
Author: Richard Heyes <richard@php.net>
Access: public

HTML_TreeMenu (Constructor) [line 77]

HTML_TreeMenu HTML_TreeMenu(
)

Constructor

Access: public

[ Top ]

addItem [line 91]

object Returns &addItem(

&$node, object
$node)

This function adds an item to the the tree.

Return: a reference to the new node inside the tree.
Access: public

Parameters:

object	`$node`	—	The node to add. This object should be a HTML_TreeNode object.
	`&$node`	—

[ Top ]

createFromStructure [line 114]

object The createFromStructure(
array
$params)

Import method for creating HTML_TreeMenu objects/structures

out of existing tree objects/structures. Currently supported are Wolfram Kriesings' PEAR Tree class, and Richard Heyes' (me!) Tree class (available here: http://www.phpguru.org/). This method is intended to be used statically, eg: $treeMenu = &HTML_TreeMenu::createFromStructure($myTreeStructureObj);

Return: resulting HTML_TreeMenu object

Parameters:

array $params — An array of parameters that determine how the import happens. This can consist of: structure => The tree structure type => The type of the structure, currently can be either 'heyes' or 'kriesing' nodeOptions => Default options for each node

[ Top ]

createFromXML [line 259]

object The createFromXML(
mixed
$xml)

Creates a treeMenu from XML. The structure of your XML should be like so:

Any of the options you can supply to the HTML_TreeNode constructor can be supplied as attributes to the <node> tag. If there are no subnodes for a particular node, you can use the XML shortcut <node ... /> instead of <node ... ></node>. The $xml argument can be either the XML as a string, or an pre-created XML_Tree object. Also, this method REQUIRES my own Tree class to work (http://phpguru.org/tree.html). If this has not been include()ed or require()ed this method will die().

Return: HTML_TreeMenu object

Parameters:

mixed $xml — This can be either a string containing the XML, or an XML_Tree object (the PEAR::XML_Tree package).

[ Top ]

Class: HTML_TreeMenu

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$items =

Method Detail

HTML_TreeMenu (Constructor) [line 77]

addItem [line 91]

Parameters:

createFromStructure [line 114]

Parameters:

createFromXML [line 259]

Parameters: