Docs For Class LayersMenuCommon

constructor LayersMenuCommon [line 233]

void LayersMenuCommon(
)

The constructor method; it initializates the menu system

[ Top ]

method parseStructureForMenu [line 614]

void parseStructureForMenu(
[string
$menu_name = ''])

The method to parse the current menu structure and correspondingly update related variables

Tags:

access:

public

Parameters:

string

$menu_name

the name to be attributed to the menu whose structure has to be parsed

[ Top ]

method replaceStringInUrls [line 841]

void replaceStringInUrls(
string
$menu_name, string
$string, string
$value)

A method to replace strings in all URLs (hrefs) of a menu

Tags:

access:

public

Parameters:

string	$menu_name	the name of the menu for which the replacement has to be performed
string	$string	the string to be replaced
string	$value	the replacement string

[ Top ]

method scanTableForMenu [line 669]

void scanTableForMenu(
[string
$menu_name = ''], [string
$language = ''])

The method to parse the current menu table and correspondingly update related variables

Tags:

access:

public

Parameters:

string	$menu_name	the name to be attributed to the menu whose structure has to be parsed
string	$language	i18n language; either omit it or pass an empty string ('') if you do not want to use any i18n table

[ Top ]

method setDBConnParms [line 514]

boolean setDBConnParms(

$dsn, [bool
$persistent = false], string
$dns)

The method to set parameters for the DB connection

Tags:

access:

public

Parameters:

string	$dns	Data Source Name: the connection string for PEAR DB
bool	$persistent	DB connections are either persistent or not persistent
	$dsn

[ Top ]

method setDirrootCommon [line 278]

boolean setDirrootCommon(

$dirroot)

The method to set the dirroot directory

Tags:

access:

public

Parameters:

$dirroot

[ Top ]

method setIcondir [line 376]

boolean setIcondir(

$icondir)

The method to set the icondir directory

Tags:

access:

public

Parameters:

$icondir

[ Top ]

method setIconsize [line 413]

void setIconsize(

$width, 
$height)

The method to set the iconsize array

Tags:

access:

public

Parameters:

	$width
	$height

[ Top ]

method setIconwww [line 400]

void setIconwww(

$iconwww)

The method to set iconwww

Tags:

access:

public

Parameters:

$iconwww

[ Top ]

method setImgdir [line 339]

boolean setImgdir(

$imgdir)

The method to set the imgdir directory

Tags:

access:

public

Parameters:

$imgdir

[ Top ]

method setImgwww [line 363]

void setImgwww(

$imgwww)

The method to set imgwww

Tags:

access:

public

Parameters:

$imgwww

[ Top ]

method setLibjsdir [line 313]

boolean setLibjsdir(

$libjsdir)

The method to set the libjsdir directory

Tags:

access:

public

Parameters:

$libjsdir

[ Top ]

method setLinksTargets [line 857]

void setLinksTargets(
string
$menu_name, string
$target)

A method to set the same target for all links of a menu

Tags:

access:

public

Parameters:

string	$menu_name	the name of the menu for which the targets have to be set
string	$target	the target to be set for all links of the $menu_name menu

[ Top ]

method setMenuStructureFile [line 462]

boolean setMenuStructureFile(
string
$tree_file)

The method to read the menu structure from a file

Tags:

access:

public

Parameters:

string

$tree_file

the menu structure file

[ Top ]

method setMenuStructureString [line 487]

boolean setMenuStructureString(
string
$tree_string)

The method to set the menu structure passing it through a string

Tags:

access:

public

Parameters:

string

$tree_string

the menu structure string

[ Top ]

method setPrependedUrl [line 266]

boolean setPrependedUrl(

$prependedUrl)

The method to set the prepended URL

Tags:

access:

public

Parameters:

$prependedUrl

[ Top ]

method setSelectedItemByCount [line 874]

void setSelectedItemByCount(
string
$menu_name, integer
$count)

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)

Tags:

access:

public

Parameters:

string	$menu_name	the name of the menu for which the current item has to be selected
integer	$count	the line number of the current item in the corresponding menu structure file (excluding from the count commented out lines, if any)

[ Top ]

method setSelectedItemById [line 896]

void setSelectedItemById(
string
$menu_name, integer
$id)

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

Tags:

access:

public

Parameters:

string	$menu_name	the name of the menu for which the current item has to be selected
integer	$id	the id of the current item in the corresponding DB table

[ Top ]

method setSelectedItemByUrl [line 914]

void setSelectedItemByUrl(
string
$menu_name, string
$url)

A method to select the current item of $menu_name specifying a string that occurs in the current URL

Tags:

access:

public

Parameters:

string	$menu_name	the name of the menu for which the current item has to be selected
string	$url	a string that occurs in the current URL

[ Top ]

method setSelectedItemByUrlEregi [line 933]

void setSelectedItemByUrlEregi(
string
$menu_name, string
$url_eregi)

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

Tags:

access:

public

Parameters:

string	$menu_name	the name of the menu for which the current item has to be selected
string	$url_eregi	the regular expression that matches (a substring of) the current URL

[ Top ]

method setSeparator [line 502]

void setSeparator(

$separator)

The method to set the value of separator

Tags:

access:

public

Parameters:

$separator

[ Top ]

method setTableFields [line 567]

boolean setTableFields(
array
$tableFields)

The method to set names of fields of the table storing data describing the menu

Tags:

access:

public

Parameters:

array

$tableFields

[ Top ]

method setTableFields_i18n [line 590]

boolean setTableFields_i18n(
array
$tableFields_i18n)

The method to set names of fields of the i18n table corresponding to $tableName

Tags:

access:

public

Parameters:

array

$tableFields_i18n

[ Top ]

method setTableName [line 535]

boolean setTableName(
string
$tableName)

The method to set the name of the table storing data describing the menu

Tags:

access:

public

Parameters:

string

$tableName

[ Top ]

method setTableName_i18n [line 551]

boolean setTableName_i18n(
string
$tableName_i18n)

The method to set the name of the i18n table corresponding to $tableName

Tags:

access:

public

Parameters:

string

$tableName_i18n

[ Top ]

method setTpldirCommon [line 437]

boolean setTpldirCommon(

$tpldir)

The method to set the tpldir directory

Tags:

access:

public

Parameters:

$tpldir

[ Top ]

method unsetIconsize [line 425]

void unsetIconsize(
)

The method to unset the iconsize array

Tags:

access:

public

[ Top ]

method _getmicrotime [line 740]

void _getmicrotime(
)

[ Top ]

Class: LayersMenuCommon

Class Overview

Author(s):

Version:

Methods

Child classes:

Class Details

Tags:

Class Methods

constructor LayersMenuCommon [line 233]

method parseStructureForMenu [line 614]

Tags:

Parameters:

method replaceStringInUrls [line 841]

Tags:

Parameters:

method scanTableForMenu [line 669]

Tags:

Parameters:

method setDBConnParms [line 514]

Tags:

Parameters:

method setDirrootCommon [line 278]

Tags:

Parameters:

method setIcondir [line 376]

Tags:

Parameters:

method setIconsize [line 413]

Tags:

Parameters:

method setIconwww [line 400]

Tags:

Parameters:

method setImgdir [line 339]

Tags:

Parameters:

method setImgwww [line 363]

Tags:

Parameters:

method setLibjsdir [line 313]

Tags:

Parameters:

method setLinksTargets [line 857]

Tags:

Parameters:

method setMenuStructureFile [line 462]

Tags:

Parameters:

method setMenuStructureString [line 487]

Tags:

Parameters:

method setPrependedUrl [line 266]

Tags:

Parameters:

method setSelectedItemByCount [line 874]

Tags:

Parameters:

method setSelectedItemById [line 896]

Tags:

Parameters:

method setSelectedItemByUrl [line 914]

Tags:

Parameters:

method setSelectedItemByUrlEregi [line 933]

Tags:

Parameters:

method setSeparator [line 502]

Tags:

Parameters:

method setTableFields [line 567]

Tags:

Parameters:

method setTableFields_i18n [line 590]

Tags:

Parameters:

method setTableName [line 535]

Tags:

Parameters:

method setTableName_i18n [line 551]