Class LayersMenu

Description

This is the LayersMenu 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

  • version: 3.2.0-rc

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

LayersMenuCommon
   |
   --LayersMenu
Method Summary
void LayersMenu ([ $menuTopShift = 6], [ $menuRightShift = 7], [ $menuLeftShift = 2], [ $thresholdY = 5], [ $abscissaStep = 140])
string getFooter ()
string getHeader ()
string getMenu (string $menu_name)
string makeFooter ()
string makeHeader ()
string newHorizontalMenu ([string $menu_name = ''])
string newVerticalMenu ([string $menu_name = ''])
void parseCommon ([string $menu_name = ''])
void printFooter ()
void printHeader ()
void printMenu (string $menu_name)
void setAbscissaStep ( $abscissaStep)
boolean setDirroot ( $dirroot)
boolean setDownArrowImg (string $downArrowImg)
boolean setForwardArrowImg (string $forwardArrowImg)
boolean setHorizontalMenuTpl ( $horizontalMenuTpl)
void setMenuLeftShift ( $menuLeftShift)
void setMenuRightShift ( $menuRightShift)
void setMenuTopShift ( $menuTopShift)
boolean setSubMenuTpl ( $subMenuTpl)
void setThresholdY ( $thresholdY)
boolean setTpldir ( $tpldir)
void setTransparentIcon (string $transparentIcon)
boolean setVerticalMenuTpl ( $verticalMenuTpl)
Methods
Constructor LayersMenu (line 161)

The constructor method; it initializates the menu system

void LayersMenu ([ $menuTopShift = 6], [ $menuRightShift = 7], [ $menuLeftShift = 2], [ $thresholdY = 5], [ $abscissaStep = 140])
  • $menuTopShift
  • $menuRightShift
  • $menuLeftShift
  • $thresholdY
  • $abscissaStep
getFooter (line 922)

Method that returns the code of the footer

  • access: public
string getFooter ()
getHeader (line 849)

Method that returns the code of the header

  • access: public
string getHeader ()
getMenu (line 874)

Method that returns the code of the requested _firstLevelMenu

  • access: public
string getMenu (string $menu_name)
  • string $menu_name: the name of the menu whose _firstLevelMenu has to be returned
makeFooter (line 900)

Method to prepare the footer.

This method obtains the footer using collected informations and the suited JavaScript template; it returns the code of the footer

  • access: public
string makeFooter ()
makeHeader (line 816)

Method to prepare the header.

This method obtains the header using collected informations and the suited JavaScript template; it returns the code of the header

  • access: public
string makeHeader ()
newHorizontalMenu (line 496)

Method to preparare a horizontal menu.

This method processes items of a menu to prepare the corresponding horizontal menu code updating many variables; it returns the code of the corresponding _firstLevelMenu

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

Method to preparare a vertical menu.

This method processes items of a menu to prepare the corresponding vertical menu code updating many variables; it returns the code of the corresponding _firstLevelMenu

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

A method providing parsing needed both for horizontal and vertical menus; it can be useful also with the ProcessLayersMenu extended class

  • access: public
void parseCommon ([string $menu_name = ''])
  • string $menu_name: the name of the menu for which the parsing has to be performed
printFooter (line 935)

Method that prints the code of the footer

  • access: public
void printFooter ()
printHeader (line 862)

Method that prints the code of the header

  • access: public
void printHeader ()
printMenu (line 886)

Method that prints the code of the requested _firstLevelMenu

  • access: public
void printMenu (string $menu_name)
  • string $menu_name: the name of the menu whose _firstLevelMenu has to be printed
setAbscissaStep (line 243)

The method to set the value of abscissaStep

  • access: public
void setAbscissaStep ( $abscissaStep)
  • $abscissaStep
setDirroot (line 253)

The method to set the dirroot directory

  • access: public
boolean setDirroot ( $dirroot)
  • $dirroot
setDownArrowImg (line 388)

The method to set an image to be used for the down arrow

  • access: public
boolean setDownArrowImg (string $downArrowImg)
  • string $downArrowImg: the down arrow image filename
setForwardArrowImg (line 369)

The method to set an image to be used for the forward arrow

  • access: public
boolean setForwardArrowImg (string $forwardArrowImg)
  • string $forwardArrowImg: the forward arrow image filename
setHorizontalMenuTpl (line 303)

The method to set horizontalMenuTpl

  • access: public
boolean setHorizontalMenuTpl ( $horizontalMenuTpl)
  • $horizontalMenuTpl
setMenuLeftShift (line 223)

The method to set the value of menuLeftShift

  • access: public
void setMenuLeftShift ( $menuLeftShift)
  • $menuLeftShift
setMenuRightShift (line 213)

The method to set the value of menuRightShift

  • access: public
void setMenuRightShift ( $menuRightShift)
  • $menuRightShift
setMenuTopShift (line 203)

The method to set the value of menuTopShift

  • access: public
void setMenuTopShift ( $menuTopShift)
  • $menuTopShift
setSubMenuTpl (line 339)

The method to set subMenuTpl

  • access: public
boolean setSubMenuTpl ( $subMenuTpl)
  • $subMenuTpl
setThresholdY (line 233)

The method to set the value of thresholdY

  • access: public
void setThresholdY ( $thresholdY)
  • $thresholdY
setTpldir (line 267)

The method to set the tpldir directory

  • access: public
boolean setTpldir ( $tpldir)
  • $tpldir
setTransparentIcon (line 358)

A method to set transparentIcon

  • access: public
void setTransparentIcon (string $transparentIcon)
  • string $transparentIcon: a transparentIcon filename (without the path)
setVerticalMenuTpl (line 321)

The method to set verticalMenuTpl

  • access: public
boolean setVerticalMenuTpl ( $verticalMenuTpl)
  • $verticalMenuTpl

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:41 +0200 by phpDocumentor 1.4.1