Class PHPTreeMenu

Description

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.

  • version: 3.2.0-rc

Located in /smarty/plugins/menuLayer/lib/phptreemenu.inc.php (line 17)

LayersMenuCommon
   |
   --PHPTreeMenu
Method Summary
void PHPTreeMenu ()
string getPHPTreeMenu (string $menu_name)
string newPHPTreeMenu ([string $menu_name = ''])
void printPHPTreeMenu (string $menu_name)
boolean setDirroot ( $dirroot)
void setPHPTreeMenuDefaultExpansion ( $phpTreeMenuDefaultExpansion)
void setPHPTreeMenuImagesType ( $phpTreeMenuImagesType)
void setPHPTreeMenuSeparator ( $phpTreeMenuSeparator)
void setPHPTreeMenuTheme ( $phpTreeMenuTheme)
Methods
Constructor PHPTreeMenu (line 55)

The constructor method; it initializates some variables

void PHPTreeMenu ()
getPHPTreeMenu (line 429)

Method that returns the code of the requested PHP Tree Menu

  • access: public
string getPHPTreeMenu (string $menu_name)
  • string $menu_name: the name of the menu whose PHP Tree Menu code has to be returned
newPHPTreeMenu (line 127)

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.

  • access: public
string newPHPTreeMenu ([string $menu_name = ''])
  • string $menu_name: the name of the menu whose items have to be processed
printPHPTreeMenu (line 441)

Method that prints the code of the requested PHP Tree Menu

  • access: public
void printPHPTreeMenu (string $menu_name)
  • string $menu_name: the name of the menu whose PHP Tree Menu code has to be printed
setDirroot (line 71)

The method to set the dirroot directory

  • access: public
boolean setDirroot ( $dirroot)
  • $dirroot
setPHPTreeMenuDefaultExpansion (line 91)

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

  • access: public
void setPHPTreeMenuDefaultExpansion ( $phpTreeMenuDefaultExpansion)
  • $phpTreeMenuDefaultExpansion
setPHPTreeMenuImagesType (line 101)

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

  • access: public
void setPHPTreeMenuImagesType ( $phpTreeMenuImagesType)
  • $phpTreeMenuImagesType
setPHPTreeMenuSeparator (line 81)

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

  • access: public
void setPHPTreeMenuSeparator ( $phpTreeMenuSeparator)
  • $phpTreeMenuSeparator
setPHPTreeMenuTheme (line 111)

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

  • access: public
void setPHPTreeMenuTheme ( $phpTreeMenuTheme)
  • $phpTreeMenuTheme

Inherited Methods

Inherited From LayersMenuCommon

LayersMenuCommon::LayersMenuCommon()
LayersMenuCommon::parseStructureForMenu()
LayersMenuCommon::replaceStringInUrls()
LayersMenuCommon::scanTableForMenu()
LayersMenuCommon::setDBConnParms()
LayersMenuCommon::setDirrootCommon()
LayersMenuCommon::setIcondir()
LayersMenuCommon::setIconsize()
LayersMenuCommon::setIconwww()
LayersMenuCommon::setImgdir()
LayersMenuCommon::setImgwww()
LayersMenuCommon::setLibjsdir()
LayersMenuCommon::setLinksTargets()
LayersMenuCommon::setMenuStructureFile()
LayersMenuCommon::setMenuStructureString()
LayersMenuCommon::setPrependedUrl()
LayersMenuCommon::setSelectedItemByCount()
LayersMenuCommon::setSelectedItemById()
LayersMenuCommon::setSelectedItemByUrl()
LayersMenuCommon::setSelectedItemByUrlEregi()
LayersMenuCommon::setSeparator()
LayersMenuCommon::setTableFields()
LayersMenuCommon::setTableFields_i18n()
LayersMenuCommon::setTableName()
LayersMenuCommon::setTableName_i18n()
LayersMenuCommon::setTpldirCommon()
LayersMenuCommon::unsetIconsize()
LayersMenuCommon::_getmicrotime()

Documentation generated on Wed, 05 Oct 2011 10:36:43 +0200 by phpDocumentor 1.4.1