Class: PlainMenu

Source Location: /javascript/phplayersmenu/lib/plainmenu.inc.php

Class Overview

LayersMenuCommon
   |
   --PlainMenu

This is the PlainMenu 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 the PlainMenu 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. It provides plain menus, that to do not require JavaScript to work.

Tags:

version:

3.2.0-rc

[ Top ]

Class Variables

$horizontalPlainMenuTpl =

[line 34]

The template to be used for the Horizontal Plain Menu

Type:

mixed

[ Top ]

$plainMenuTpl =

[line 23]

The template to be used for the Plain Menu

Type:

mixed

[ Top ]

Class Methods

constructor PlainMenu [line 46]

void PlainMenu(
)

The constructor method; it initializates some variables

[ Top ]

method getHorizontalPlainMenu [line 262]

string getHorizontalPlainMenu(
string
$menu_name)

Method that returns the code of the requested Horizontal Plain Menu

Tags:

access:

public

Parameters:

string

$menu_name

the name of the menu whose Horizontal Plain Menu code has to be returned

[ Top ]

method getPlainMenu [line 171]

string getPlainMenu(
string
$menu_name)

Method that returns the code of the requested Plain Menu

Tags:

access:

public

Parameters:

string

$menu_name

the name of the menu whose Plain Menu code has to be returned

[ Top ]

method newHorizontalPlainMenu [line 216]

string newHorizontalPlainMenu(
[string
$menu_name = ''])

Method to prepare a new Horizontal Plain Menu.

This method processes items of a menu to prepare and return the corresponding Horizontal Plain Menu code.

Tags:

access:

public

Parameters:

string

$menu_name

the name of the menu whose items have to be processed

[ Top ]

method newPlainMenu [line 131]

string newPlainMenu(
[string
$menu_name = ''])

Method to prepare a new Plain Menu.

This method processes items of a menu to prepare and return the corresponding Plain Menu code.

Tags:

access:

public

Parameters:

string

$menu_name

the name of the menu whose items have to be processed

[ Top ]

method printHorizontalPlainMenu [line 274]

void printHorizontalPlainMenu(
string
$menu_name)

Method that prints the code of the requested Horizontal Plain Menu

Tags:

access:

public

Parameters:

string

$menu_name

the name of the menu whose Horizontal Plain Menu code has to be printed

[ Top ]

method printPlainMenu [line 183]

void printPlainMenu(
string
$menu_name)

Method that prints the code of the requested Plain Menu

Tags:

access:

public

Parameters:

string

$menu_name

the name of the menu whose Plain Menu code has to be printed

[ Top ]

method setDirroot [line 62]

boolean setDirroot(

$dirroot)

The method to set the dirroot directory

Tags:

access:

public

Parameters:

$dirroot

[ Top ]

method setHorizontalPlainMenuTpl [line 193]

boolean setHorizontalPlainMenuTpl(

$horizontalPlainMenuTpl)

The method to set horizontalPlainMenuTpl

Tags:

access:

public

Parameters:

$horizontalPlainMenuTpl

[ Top ]

method setPlainMenuTpl [line 108]

boolean setPlainMenuTpl(

$plainMenuTpl)

The method to set plainMenuTpl

Tags:

access:

public

Parameters:

$plainMenuTpl

[ Top ]

method setTpldir [line 76]

boolean setTpldir(

$tpldir)

The method to set the tpldir directory

Tags:

access:

public

Parameters:

$tpldir

[ Top ]

Documentation generated on Fri, 18 Jul 2008 21:49:41 +0200 by phpDocumentor 1.4.1