Class: PHPTreeMenu

Source Location: /javascript/phplayersmenu/lib/phptreemenu.inc.php

Class Overview

LayersMenuCommon
   |
   --PHPTreeMenu

This is the PHPTreeMenu 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 PHPTreeMenu class of the PHP Layers Menu library.

This class depends on the LayersMenuCommon class. It provides "server-side" (PHP-based) tree menus, that to do not require JavaScript to work.

Tags:

version:

3.2.0-rc

[ Top ]

Class Methods

constructor PHPTreeMenu [line 55]

void PHPTreeMenu(
)

The constructor method; it initializates some variables

[ Top ]

method getPHPTreeMenu [line 429]

string getPHPTreeMenu(
string
$menu_name)

Method that returns the code of the requested PHP Tree Menu

Tags:

access:

public

Parameters:

string

$menu_name

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

[ Top ]

method newPHPTreeMenu [line 127]

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

Method to prepare a new PHP Tree Menu.

This method processes items of a menu and parameters submitted through GET (i.e. nodes to be expanded) 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 printPHPTreeMenu [line 441]

void printPHPTreeMenu(
string
$menu_name)

Method that prints the code of the requested PHP Tree Menu

Tags:

access:

public

Parameters:

string

$menu_name

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

[ Top ]

method setDirroot [line 71]

boolean setDirroot(

$dirroot)

The method to set the dirroot directory

Tags:

access:

public

Parameters:

$dirroot

[ Top ]

method setPHPTreeMenuDefaultExpansion [line 91]

void setPHPTreeMenuDefaultExpansion(

$phpTreeMenuDefaultExpansion)

The method to set the default value of the expansion string for the PHP Tree Menu

Tags:

access:

public

Parameters:

$phpTreeMenuDefaultExpansion

[ Top ]

method setPHPTreeMenuImagesType [line 101]

void setPHPTreeMenuImagesType(

$phpTreeMenuImagesType)

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

Tags:

access:

public

Parameters:

$phpTreeMenuImagesType

[ Top ]

method setPHPTreeMenuSeparator [line 81]

void setPHPTreeMenuSeparator(

$phpTreeMenuSeparator)

The method to set the value of separator for the Tree Menu query string

Tags:

access:

public

Parameters:

$phpTreeMenuSeparator

[ Top ]

method setPHPTreeMenuTheme [line 111]

void setPHPTreeMenuTheme(

$phpTreeMenuTheme)

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

Tags:

access:

public

Parameters:

$phpTreeMenuTheme

[ Top ]

Documentation generated on Fri, 18 Jul 2008 21:49:38 +0200 by phpDocumentor 1.4.1