Source for file TreeMenu.php
Documentation is available at TreeMenu.php
// +-----------------------------------------------------------------------+
// | Copyright (c) 2002, Richard Heyes, Harald Radi |
// | All rights reserved. |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | o Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | o Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in the |
// | documentation and/or other materials provided with the distribution.|
// | o The names of the authors may not be used to endorse or promote |
// | products derived from this software without specific prior written |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
// | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
// | OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
// | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
// | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
// | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
// | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
// | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
// | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
// +-----------------------------------------------------------------------+
// +-----------------------------------------------------------------------+
// $Id: TreeMenu.php,v 1.1 2005/10/17 18:36:53 jeichorn Exp $
* 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.
* 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
* Thanks go to Chip Chapin (http://www.chipchapin.com) for many
* excellent ideas and improvements.
* Indexed array of subnodes
// Not much to do here :(
* This function adds an item to the the tree.
* @param object $node The node to add. This object should be
* a HTML_TreeNode object.
* @return object Returns a reference to the new node inside
* This class is supplementary to the above and provides a way to
* add nodes to the tree. A node can have other nodes added to it.
* The text for this node.
* The link for this node.
* The icon for this node.
* The css class for this node
* Indexed array of subnodes
* Whether this node is expanded or not
* Whether this node is dynamic or not
* Should this node be made visible?
* The parent node. Null if top level
* Javascript event handlers;
* @param array $options An array of options which you can pass to change
* the way this node looks/acts. This can consist of:
* o text The title of the node, defaults to blank
* o link The link for the node, defaults to blank
* o icon The icon for the node, defaults to blank
* o class The CSS class for this node, defaults to blank
* o expanded The default expanded status of this node, defaults to false
* This doesn't affect non dynamic presentation types
* o isDynamic If this node is dynamic or not. Only affects
* certain presentation types.
* o ensureVisible If true this node will be made visible despite the expanded
* settings, and client side persistence. Will not affect
* some presentation styles, such as Listbox. Default is false
* @param array $events An array of javascript events and the corresponding event handlers.
* Additionally to the standard javascript events you can specify handlers
* for the 'onexpand', 'oncollapse' and 'ontoggle' events which will be fired
* whenever a node is collapsed and/or expanded.
foreach ($options as $option => $value) {
* Allows setting of various parameters after the initial
* constructor call. Possible options you can set are:
* ie The same options as in the constructor
* @param string $option Option to set
* @param string $value Value to set the option to
* Adds a new subnode to this node.
* @param object $node The new node
* If the subnode has ensureVisible set it needs
* to be handled, and all parents set accordingly.
if ($node->ensureVisible) {
* Private function to handle ensureVisible stuff
function _ensureVisible()
$this->parent->_ensureVisible();
* HTML_TreeMenu_Presentation class
* Base class for other presentation classes to
* Base constructor simply sets the menu object
* @param object $structure The menu structure
$this->menu = &$structure;
* Prints the HTML generated by the toHTML() method.
* toHTML() must therefore be defined by the derived
* @param array Options to set. Any options taken by
* the presentation class can be specified
foreach ($options as $option => $value) {
* HTML_TreeMenu_DHTML class
* This class is a presentation class for the tree structure
* created using the TreeMenu/TreeNode. It presents the
* traditional tree, static for browsers that can't handle
* Dynamic status of the treemenu. If true (default) this has no effect. If
* false it will override all dynamic status vars and set the menu to be
* fully expanded an non-dynamic.
* Target for the links generated
* Whether to use clientside persistence or not
* The default CSS class for the nodes
* Whether to skip first level branch images
* Constructor, takes the tree structure as
* an argument and an array of options which
* o images - The path to the images folder. Defaults to "images"
* o linkTarget - The target for the link. Defaults to "_self"
* o defaultClass - The default CSS class to apply to a node. Default is none.
* o usePersistence - Whether to use clientside persistence. This persistence
* is achieved using cookies. Default is true.
* o noTopLevelImages - Whether to skip displaying the first level of images if
* there is multiple top level branches.
* And also a boolean for whether the entire tree is dynamic or not.
* This overrides any perNode dynamic settings.
* @param object $structure The menu structure
* @param array $options Array of options
* @param bool $isDynamic Whether the tree is dynamic or not
$this->menu = &$structure;
$this->usePersistence = true;
foreach ($options as $option => $value) {
* Returns the HTML for the menu. This method can be
* used instead of printMenu() to use the menu system
* with a template system.
* @return string The HTML for the menu
$menuObj = 'objTreeMenu_' . ++ $count;
$html .= '<script language="javascript" type="text/javascript">' . "\n\t";
$html .= sprintf('%s = new TreeMenu("%s", "%s", "%s", "%s", %s, %s);',
$this->usePersistence ? 'true' : 'false',
if (isset ($this->menu->items)) {
for ($i= 0; $i< count($this->menu->items); $i++ ) {
$html .= $this->_nodeToHTML($this->menu->items[$i], $menuObj);
$html .= sprintf("\n\t%s.drawMenu();", $menuObj);
if ($this->usePersistence && $this->isDynamic) {
$html .= sprintf("\n\t%s.resetBranches();", $menuObj);
* Prints a node of the menu
function _nodeToHTML($nodeObj, $prefix, $return = 'newNode')
$expanded = $this->isDynamic ? ($nodeObj->expanded ? 'true' : 'false') : 'true';
$isDynamic = $this->isDynamic ? ($nodeObj->isDynamic ? 'true' : 'false') : 'false';
$html = sprintf("\t %s = %s.addItem(new TreeNode('%s', %s, %s, %s, %s, '%s'));\n",
!empty($nodeObj->icon) ? "'" . $nodeObj->icon . "'" : 'null',
!empty($nodeObj->link) ? "'" . addslashes($nodeObj->link) . "'" : 'null',
foreach ($nodeObj->events as $event => $handler) {
$html .= sprintf("\t %s.setEvent('%s', '%s');\n",
str_replace(array("\r", "\n", "'"), array('\r', '\n', "\'"), $handler));
if (!empty($nodeObj->items)) {
for ($i= 0; $i< count($nodeObj->items); $i++ ) {
$html .= $this->_nodeToHTML($nodeObj->items[$i], $return, $return . '_' . ($i + 1));
* HTML_TreeMenu_Listbox class
* This class presents the menu as a listbox
* The text that is displayed in the first option
* The character used for indentation
* How many of the indent chars to use
* Target for the links generated
* @param object $structure The menu structure
* @param array $options Options whic affect the display of the listbox.
* o promoText The text that appears at the the top of the listbox
* Defaults to "Select..."
* o indentChar The character to use for indenting the nodes
* o indentNum How many of the indentChars to use per indentation level
* o linkTarget Target for the links. Defaults to "_self"
* o submitText Text for the submit button. Defaults to "Go"
$this->menu = $structure;
$this->submitText = 'Go';
foreach ($options as $option => $value) {
* Returns the HTML generated
if (isset ($this->menu->items)) {
for ($i= 0; $i< count($this->menu->items); $i++ ) {
$nodeHTML .= $this->_nodeToHTML($this->menu->items[$i]);
return sprintf('<form target="%s" action="" onsubmit="var link = this.%s.options[this.%s.selectedIndex].value; if (link) {this.action = link; return true} else return false"><select name="%s"><option value="">%s</option>%s</select> <input type="submit" value="%s" /></form>',
'HTML_TreeMenu_Listbox_' . ++ $count,
'HTML_TreeMenu_Listbox_' . $count,
'HTML_TreeMenu_Listbox_' . $count,
* Returns HTML for a single node
function _nodeToHTML($node, $prefix = '')
$html = sprintf('<option value="%s">%s%s</option>', $node->link, $prefix, $node->text);
if (isset ($node->items)) {
for ($i= 0; $i< count($node->items); $i++ ) {
|