Class ProcessLayersMenu

Description

This is an extension of the "common" class of the PHP Layers Menu library.

It provides methods useful to process/convert menus data, e.g. to output a menu structure and a DB SQL dump corresponding to already parsed data and hence also to convert a menu structure file to a DB SQL dump and viceversa

  • version: 3.2.0-rc

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

LayersMenuCommon
   |
   --ProcessLayersMenu
Method Summary
string getMenuStructure ([string $menu_name = ''], [string $separator = '|'])
string getSQLDump ([string $menu_name = ''], [string $db_type = ''])
boolean setDirroot ( $dirroot)
Methods
Constructor ProcessLayersMenu (line 24)

The constructor method

void ProcessLayersMenu ()
getMenuStructure (line 48)

Method to output a menu structure corresponding to items of a menu

  • access: public
string getMenuStructure ([string $menu_name = ''], [string $separator = '|'])
  • string $menu_name: the name of the menu for which a menu structure has to be returned
  • string $separator: the character used in the menu structure format to separate fields of each item
getSQLDump (line 85)

Method to output a DB SQL dump corresponding to items of a menu

  • access: public
string getSQLDump ([string $menu_name = ''], [string $db_type = ''])
  • string $menu_name: the name of the menu for which a DB SQL dump has to be returned
  • string $db_type: the type of DB to dump for; leave it either empty or not specified if you are using PHP < 5, as sqlite_escape_string() has been added in PHP 5; it has to be specified and set to 'sqlite' only if the dump has to be prepared for SQLite; it is not significant if != 'sqlite'
setDirroot (line 34)

The method to set the dirroot directory

  • access: public
boolean setDirroot ( $dirroot)
  • $dirroot

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