Class: ProjectMenu

Source Location: /_includes/lib_menu.php

Class Overview

Describes a project menu. A menu that is connected to a project.

Author(s):

Andreas Launila

Variables

Methods

Class Details

[line 254]
Describes a project menu. A menu that is connected to a project.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$name =

[line 259]

The name that describes and is displayed for the menu item.

Tags:

access:

private

Type:

string

[ Top ]

$path =

[line 265]

An optional path that the menu item leads to. It's either an aboslute url or one relative to the root path.

Tags:

access:

private

Type:

string

[ Top ]

$subMenus =

[line 271]

All submenus that are connected to the menu. The key is the display name for the submenu, the value is the path inside the project path.

Tags:

access:

private

Type:

array

[ Top ]

Class Methods

constructor __construct [line 279]

ProjectMenu __construct(
integer
$projectId)

Constructor for ProjectMenu. Constructs the entire menu system for the specified project.

Tags:

access:

public

Parameters:

integer

$projectId

The unique identifier for the project that the menu should be constructed for.

[ Top ]

method getAsHtml [line 304]

string getAsHtml(
)

Gets the menu item as XHTML compliant code. This function also includes the children of the menu item (if there are any).

Tags:

return:	XHTML compliant code representing the menu item. The menu item is represented as a hypertext link in a list item containing a list with all children.
access:	public

[ Top ]

method getDestinations [line 344]

array getDestinations(
)

Gets all the destinations that the project menu has. I.e. all pages associated with the project.

Tags:

return:	All destination where the key is the display name and the value is the associated path to the page from the root.
access:	public

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:38 +0200 by phpDocumentor 1.3.0RC4