Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitCouchDbFacadeProjectManager

Packages:

Interfaces:

Classes:

Core::Facade::arbitCouchDbFacadeProjectManager

[ Index ] [ Core classes ] [ Core elements ] [ All elements ] [ Errors ]

Class arbitCouchDbFacadeProjectManager

Facade manager, responsible for selecting and modifying projects.

Facade manager, responsible for selecting and modifying projects.

Implements interfaces:

arbitCouchDbFacadeBase
   |
   --arbitCouchDbFacadeProjectManager
Author(s):
Version:   $Revision: 1587 $
License:   GPL

Member Variables

protected string $prefix = ''
Prefix to use for database names.

Prefix to use for database names.
protected string $project = null
Currently selected project.

Currently selected project.

Inherited Member Variables

From arbitCouchDbFacadeBase
protected arbitCouchDbFacadeBase::$connected
protected arbitCouchDbFacadeBase::$manager

Method Summary

public void __construct( )
Constructor The constructor ensures the correct configuration for the conenction by connecting on the first request to on of the facde classes.
public void connect( )
Connect to database Connect to the database with the connection parameters read from the configuration.
public void createProject( $project )
Create project Create a new project. the backend.
protected array getConnectionInformation( )
Parse the connection string Parse the usual URL into the required components. for the databases and returns an array containing the host and port as well as the user and password if provided.
public string getDatabaseName( )
Get current database name Build and return the name of the database from the prefix and the project name.
public void removeProject( $project )
Remove project Clean all project related data in the backend.
public void selectProject( $project )
Select project Select the project currently selected in the UI, where we want to operate on.
protected void setProject( $project )
Set the used project Sets the used project and perfom necessary initializations to the backend.
public void verifyIntegrity( )
Verify backend integrity

Inherited Methods

From arbitCouchDbFacadeBase
public void arbitCouchDbFacadeBase::__construct()
Constructor The constructor ensures the correct configuration for the conenction by connecting on the first request to on of the facde classes.

Methods

__construct

void __construct( )

Constructor The constructor ensures the correct configuration for the conenction by connecting on the first request to on of the facde classes.

Constructor The constructor ensures the correct configuration for the conenction by connecting on the first request to on of the facde classes.

Redefinition of:
Method Description
arbitCouchDbFacadeBase::__construct() Constructor The constructor ensures the correct configuration for the conenction by connecting on the first request to on of the facde classes.

connect

void connect( )

Connect to database Connect to the database with the connection parameters read from the configuration.

Connect to database Connect to the database with the connection parameters read from the configuration.

createProject

void createProject( string $project )

Create project Create a new project. the backend.

Create project Create a new project. This should create required databases and alike in the backend.

Parameters:
Name Type Description
$project string
Implementation of:
Method Description
arbitFacadeProjectManager::createProject() Create project Create a new project. the backend.

getConnectionInformation

array getConnectionInformation( )

Parse the connection string Parse the usual URL into the required components. for the databases and returns an array containing the host and port as well as the user and password if provided.

Parse the connection string Parse the usual URL into the required components. Sets the prefix used for the databases and returns an array containing the host and port as well as the user and password if provided.

getDatabaseName

string getDatabaseName( )

Get current database name Build and return the name of the database from the prefix and the project name.

Get current database name Build and return the name of the database from the prefix and the project name.

removeProject

void removeProject( string $project )

Remove project Clean all project related data in the backend.

Remove project Clean all project related data in the backend.

Parameters:
Name Type Description
$project string
Implementation of:
Method Description
arbitFacadeProjectManager::removeProject() Remove project Clean all project related data in the backend.

selectProject

void selectProject( string $project )

Select project Select the project currently selected in the UI, where we want to operate on.

Select project Select the project currently selected in the UI, where we want to operate on.

Parameters:
Name Type Description
$project string
Implementation of:
Method Description
arbitFacadeProjectManager::selectProject() Select project Select the project currently selected in the UI, where we want to operate on.

setProject

void setProject( mixed $project )

Set the used project Sets the used project and perfom necessary initializations to the backend.

Set the used project Sets the used project and perfom necessary initializations to the backend.

Parameters:
Name Type Description
$project mixed

verifyIntegrity

void verifyIntegrity( )

Verify backend integrity

Verify backend integrity

Implementation of:
Method Description
arbitFacadeProjectManager::verifyIntegrity() Verify backend integrity
Documentation generated on Mon, 05 Apr 2010 14:02:04 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3