Procedural File: lib_projects.php

Source Location: /_includes/lib_projects.php

Classes:

Project

Describes a project.

Stage

Describes a project stage. Each stage represents a part of the deveolpment process of a project.

Page Details:

A library that contains everything that has to do with the site's project system.

Tags:

filesource:	Source Code for this file
license:	GNU Lesser General Public License
version:	$Revision: 1.32 $
author:	Andreas Launila

Includes:

require_once('common.php') [line 19]
For access to common constants and functions.

MENU_ITEM_WIDTH [line 32]

MENU_ITEM_WIDTH = 124

The width, in pixels, that each menu link should be represented with.

Tags:

access:

private

[ Top ]

TOTAL_WIDTH [line 26]

TOTAL_WIDTH = 650

The total width, in pixels, that the menu is allowed to occupy.

Tags:

access:

private

[ Top ]

getAllProjectNames [line 64]

array getAllProjectNames(
)

Gets the names of all available projects.

Tags:

return:	The project names as values with the unique identifier for the corresponding project as key.
access:	public

[ Top ]

getAllProjects [line 99]

array getAllProjects(
)

Gets all available projects.

Tags:

return:	Each avaialable project represented as a Project instance.
access:	public

[ Top ]

getAllStageDescriptions [line 82]

array getAllStageDescriptions(
)

Get the descriptions for all available project stages.

Tags:

return:	The stage descriptions as value with the unique identifier for the corresponding project as key.
access:	public

[ Top ]

getProjectBasedOnDir [line 43]

Project getProjectBasedOnDir(
)

Gets a project based on the current directory. If the current directory is one of the projects' home directories then one of those projects are returned.

Tags:

return:	A Project instance that is connected with the current directory. If there are no such then null will be returned.
access:	public
throws:	NoSuchElementException If no project for the directory is found.

[ Top ]

getProjectCount [line 127]

integer getProjectCount(
)

Gets the number of projects available.

Tags:

return:	A number of projects.
access:	public

[ Top ]

getProjects [line 111]

array getProjects(
string $sqlSelector)

Gets all projects that match a specified sql selector statement.

Tags:

return:	An array containing Project instances representing the retrieved projects.
access:	public

Parameters

string

$sqlSelector

The sql statement that specifies the project that should be retrieved.

[ Top ]

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