[ class tree: ] [ index: ] [ all elements ]

Class: DB_NestedSet_TreeMenu

Source Location: /DB_NestedSet-1.4.1/NestedSet/TreeMenu.php

Class Overview

DB_NestedSet_Output
   |
   --DB_NestedSet_TreeMenu

DB_NestedSet_TreeMenu


Author(s):

  • daniel

Version:

  • $Id: TreeMenu.php 204899 2006-01-10 08:41:13Z bate $

Copyright:

  • Copyright (c) 2004

Methods


Inherited Variables

Inherited Methods

Class: DB_NestedSet_Output

DB_NestedSet_Output::factory()
Returns a output driver object
DB_NestedSet_Output::listbox_toHTML()
Returns the HTML for the listbox. This method can be used instead of printListbox() to use the menu system with a template system.
DB_NestedSet_Output::printListbox()
Print's a listbox representing the current tree Overriden by the driver class
DB_NestedSet_Output::printTree()
Print's the current tree using the output driver Overriden by the driver class
DB_NestedSet_Output::returnStructure()
DB_NestedSet_Output::setOptions()
Set's options for a specific output group (printTree, printListbox) This enables you to set specific options for each output method
DB_NestedSet_Output::tree_toHTML()
Returns the HTML for the DHTML-menu. This method can be used instead of printMenu() to use the menu system with a template system.

Class Details

[line 40]
DB_NestedSet_TreeMenu
  • Author: daniel
  • Version: $Id: TreeMenu.php 204899 2006-01-10 08:41:13Z bate $
  • Copyright: Copyright (c) 2004
  • Access: public


[ Top ]


Method Detail

DB_NestedSet_TreeMenu (Constructor)   [line 75]

void DB_NestedSet_TreeMenu( array $params)

The constructor

Parameters:

array   $params   —  The config parameters used for building the tree.

[ Top ]

listbox_toHTML   [line 238]

string listbox_toHTML( )

Returns the HTML for the listbox. This method can be used instead of printListbox() to use the menu system with a template system.
  • Return: The HTML for the listbox
  • Author: Emanuel Zueger
  • Access: public

Overrides DB_NestedSet_Output::listbox_toHTML() (Returns the HTML for the listbox. This method can be used instead of printListbox() to use the menu system with a template system.)
[ Top ]

printListbox   [line 206]

void printListbox( )

Print's a listbox representing the current tree
  • Access: public

Overrides DB_NestedSet_Output::printListbox() (Print's a listbox representing the current tree Overriden by the driver class)
[ Top ]

printTree   [line 194]

void printTree( )

Print's the current tree using the output driver
  • Access: public

Overrides DB_NestedSet_Output::printTree() (Print's the current tree using the output driver Overriden by the driver class)
[ Top ]

tree_toHTML   [line 222]

string tree_toHTML( )

Returns the HTML for the DHTML-menu. This method can be used instead of printMenu() to use the menu system with a template system.
  • Return: The HTML for the menu
  • Access: public

Overrides DB_NestedSet_Output::tree_toHTML() (Returns the HTML for the DHTML-menu. This method can be used instead of printMenu() to use the menu system with a template system.)
[ Top ]

_createFromStructure   [line 113]

object A &_createFromStructure( array $params)

Note that these parameters may be added to the individual nodes to control their behavior:

    or 'expandedIcon'
    • 'events' => (optional) An array of any events to pass to the node when creating it such as 'onclick' or 'onexpand'

    • Return: HTML_TreeMenu object
    • Access: public

    Parameters:

    array   $params   —  The configuration parameters. Available params are:
    • 'structure' => [REQU] The result from $nestedSet->getAllNodes(true)
    • 'textField' => [REQU] The field in the table that has the text for node
    • 'linkField' => [REQU] The field in the table that has the link for the node
    The following params are optional. Please refer to HTML_TreeMenu's manual. The params are equal to the HTML_TreeMenu::Node properties without the 'Field' appended
    • 'iconField' => [OPT]
    • 'expandedIconField' => [OPT]
    • 'classField' => [OPT]
    • 'expandedField' => [OPT]
    • 'linkTargetField' => [OPT]
    • 'isDynamicField' => [OPT]
    • 'ensureVisibleField' => [OPT]
    • 'options' => (optional) An array of any additional options to pass to the node when it is created (i.e. icon, class). See HTML_TreeNode for the options)
    </pre>

    [ Top ]


    Documentation generated on Mon, 11 Mar 2019 15:37:11 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.