Class: ProcessLayersMenu

Source Location: /javascript/phplayersmenu/lib/layersmenu-process.inc.php

Class Overview

LayersMenuCommon
   |
   --ProcessLayersMenu

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

Author(s):

Version:

3.2.0-rc

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 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

Tags:

version:

3.2.0-rc

[ Top ]

Class Methods

constructor ProcessLayersMenu [line 24]

void ProcessLayersMenu(
)

The constructor method

[ Top ]

method getMenuStructure [line 48]

string getMenuStructure(
[string
$menu_name = ''], [string
$separator = '|'])

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

Tags:

access:

public

Parameters:

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

[ Top ]

method getSQLDump [line 85]

string getSQLDump(
[string
$menu_name = ''], [string
$db_type = ''])

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

Tags:

access:

public

Parameters:

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'

[ Top ]

method setDirroot [line 34]

boolean setDirroot(

$dirroot)

The method to set the dirroot directory

Tags:

access:

public

Parameters:

$dirroot

[ Top ]

Documentation generated on Fri, 18 Jul 2008 21:47:22 +0200 by phpDocumentor 1.4.1