Class: TreeMenu

Source Location: /htdocs/js/phplayersmenu/lib/treemenu.inc.php

Class Overview

LayersMenuCommon
   |
   --TreeMenu

This is the TreeMenu class of the PHP Layers Menu library.

Author(s):

Version:

3.2.0-rc

Methods

Inherited Methods

Class: LayersMenuCommon

LayersMenuCommon::LayersMenuCommon(): The constructor method; it initializates the menu system
LayersMenuCommon::parseStructureForMenu(): The method to parse the current menu structure and correspondingly update related variables
LayersMenuCommon::replaceStringInUrls(): A method to replace strings in all URLs (hrefs) of a menu
LayersMenuCommon::scanTableForMenu(): The method to parse the current menu table and correspondingly update related variables
LayersMenuCommon::setDBConnParms(): The method to set parameters for the DB connection
LayersMenuCommon::setDirrootCommon(): The method to set the dirroot directory
LayersMenuCommon::setIcondir(): The method to set the icondir directory
LayersMenuCommon::setIconsize(): The method to set the iconsize array
LayersMenuCommon::setIconwww(): The method to set iconwww
LayersMenuCommon::setImgdir(): The method to set the imgdir directory
LayersMenuCommon::setImgwww(): The method to set imgwww
LayersMenuCommon::setLibjsdir(): The method to set the libjsdir directory
LayersMenuCommon::setLinksTargets(): A method to set the same target for all links of a menu
LayersMenuCommon::setMenuStructureFile(): The method to read the menu structure from a file
LayersMenuCommon::setMenuStructureString(): The method to set the menu structure passing it through a string
LayersMenuCommon::setPrependedUrl(): The method to set the prepended URL
LayersMenuCommon::setSelectedItemByCount(): A method to select the current item of $menu_name in terms of $cnt, i.e., very likely, in terms of its line number in the corresponding menu structure file (excluding from the count commented out lines, if any)
LayersMenuCommon::setSelectedItemById(): A method to select the current item of $menu_name in terms of the corresponding id (see the DB table structure); obviously, this method can be used only together with the DB support
LayersMenuCommon::setSelectedItemByUrl(): A method to select the current item of $menu_name specifying a string that occurs in the current URL
LayersMenuCommon::setSelectedItemByUrlEregi(): A method to select the current item of $menu_name specifying a regular expression that matches (a substring of) the current URL; just the same as the setSelectedItemByUrl() method, but using eregi() instead of strpos()
LayersMenuCommon::setSeparator(): The method to set the value of separator
LayersMenuCommon::setTableFields(): The method to set names of fields of the table storing data describing the menu
LayersMenuCommon::setTableFields_i18n(): The method to set names of fields of the i18n table corresponding to $tableName
LayersMenuCommon::setTableName(): The method to set the name of the table storing data describing the menu
LayersMenuCommon::setTableName_i18n(): The method to set the name of the i18n table corresponding to $tableName
LayersMenuCommon::setTpldirCommon(): The method to set the tpldir directory
LayersMenuCommon::unsetIconsize(): The method to unset the iconsize array
LayersMenuCommon::_getmicrotime()

Class Details

[line 17]
This is the TreeMenu class of the PHP Layers Menu library.

This class depends on the LayersMenuCommon class and on the PEAR conforming version of the PHPLib Template class, i.e. on HTML_Template_PHPLIB

Tags:

version:

3.2.0-rc

[ Top ]

Class Methods

constructor TreeMenu [line 43]

void TreeMenu(
)

The constructor method; it initializates the menu system

[ Top ]

method getTreeMenu [line 379]

string getTreeMenu(
string
$menu_name)

Method that returns the code of the requested Tree Menu

Tags:

access:

public

Parameters:

string

$menu_name

the name of the menu whose Tree Menu code has to be returned

[ Top ]

method newTreeMenu [line 99]

string newTreeMenu(
[string
$menu_name = ''])

Method to prepare a new Tree Menu.

This method processes items of a menu to prepare and return the corresponding Tree Menu code.

Tags:

access:

public

Parameters:

string

$menu_name

the name of the menu whose items have to be processed

[ Top ]

method printTreeMenu [line 391]

void printTreeMenu(
string
$menu_name)

Method that prints the code of the requested Tree Menu

Tags:

access:

public

Parameters:

string

$menu_name

the name of the menu whose Tree Menu code has to be printed

[ Top ]

method setDirroot [line 64]

boolean setDirroot(

$dirroot)

The method to set the dirroot directory

Tags:

access:

public

Parameters:

$dirroot

[ Top ]

method setTreeMenuImagesType [line 74]

void setTreeMenuImagesType(

$treeMenuImagesType)

The method to set the type of images used for the Tree Menu

Tags:

access:

public

Parameters:

$treeMenuImagesType

[ Top ]

method setTreeMenuTheme [line 84]

void setTreeMenuTheme(

$treeMenuTheme)

The method to set the prefix for filenames of images of a theme

Tags:

access:

public

Parameters:

$treeMenuTheme

[ Top ]

Documentation generated on Sun, 30 Dec 2007 17:51:03 -0800 by phpDocumentor 1.3.1